recorder-annotations/io.github.hdcodedev.composegif.annotations

Package-level declarations

Types

annotation class GifFractionPoint(val x: Float, val y: Float)

A normalized point in the interaction node coordinate space.

annotation class GifGestureStep(val type: GifGestureType = GifGestureType.PAUSE, val frames: Int = 0, val xFraction: Float = 0.5f, val yFraction: Float = 0.5f, val framesAfter: Int = 0, val points: Array<GifFractionPoint> = [], val holdStartFrames: Int = 0, val framesPerWaypoint: Int = 0, val releaseFrames: Int = 0)

A low-level gesture replay step.

GifGestureType

enum GifGestureType : Enum<GifGestureType>

Gesture primitives used by low-level replay steps.

GifInteraction

annotation class GifInteraction(val type: GifInteractionType = GifInteractionType.PAUSE, val frames: Int = 0, val framesAfter: Int = 0, val target: GifInteractionTarget = GifInteractionTarget.CENTER, val direction: GifSwipeDirection = GifSwipeDirection.LEFT_TO_RIGHT, val distance: GifSwipeDistance = GifSwipeDistance.MEDIUM, val speed: GifSwipeSpeed = GifSwipeSpeed.CUSTOM, val travelFrames: Int = 8, val holdStartFrames: Int = 0, val releaseFrames: Int = 0)

A high-level interaction step expanded by the KSP processor into one or more low-level gestures.

GifInteractionTarget

enum GifInteractionTarget : Enum<GifInteractionTarget>

Target lane or point used to position interactions.

GifInteractionType

enum GifInteractionType : Enum<GifInteractionType>

High-level interaction primitives that are expanded into gesture steps.

GifSwipeDirection

enum GifSwipeDirection : Enum<GifSwipeDirection>

Supported swipe directions for high-level swipe interactions.

GifSwipeDistance

enum GifSwipeDistance : Enum<GifSwipeDistance>

Supported swipe distances for high-level swipe interactions.

GifSwipeSpeed

enum GifSwipeSpeed : Enum<GifSwipeSpeed>

Preset timing speeds used by swipe interactions.

GifTheme

enum GifTheme : Enum<GifTheme>

Available visual themes for generated GIF scenarios.

RecordGif

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class RecordGif(val name: String = "", val durationMs: Int = 3000, val fps: Int = 50, val widthPx: Int = 540, val heightPx: Int = 0, val theme: GifTheme = GifTheme.DARK, val interactionStartDelayMs: Int = 1000, val interactionNodeTag: String = "", val interactions: Array<GifInteraction> = [], val gestures: Array<GifGestureStep> = [])

Marks a parameterless @Composable function as a GIF capture scenario.