viewcompose-animation-core/com.viewcompose.animation.core

Package-level declarations

Types

AnimatableCore

class AnimatableCore<T>(initialValue: T, converter: AnimationConverter<T>)

Owns one mutable animated value without depending on composition.

AnimationConverter

interface AnimationConverter<T>

Converts a domain value to and from independently interpolated floating-point dimensions.

AnimationConverters

object AnimationConverters

Provides stateless converters for common scalar and Android-compatible packed values.

AnimationRunResult

enum AnimationRunResult : Enum<AnimationRunResult>

Identifies the terminal state observed by an animation loop that returns normally.

AnimationSpec

sealed interface AnimationSpec

Defines how the animation engine maps elapsed time to progress between two values.

CubicBezierEasing

class CubicBezierEasing(val x1: Float, val y1: Float, val x2: Float, val y2: Float) : Easing

Evaluates a cubic Bézier easing from (0, 0) through two control points to (1, 1).

Easing

fun interface Easing

Maps linear time progress to visual animation progress.

EasingDefaults

object EasingDefaults

Provides allocation-stable easing curves for common motion profiles.

InfiniteRepeatableSpec

data class InfiniteRepeatableSpec(val animation: AnimationSpec, val repeatMode: RepeatMode = RepeatMode.Restart) : AnimationSpec

Repeats animation until the driving coroutine is cancelled.

Keyframe

data class Keyframe(val timeMillis: Int, val valueFraction: Float)

Defines one progress checkpoint in a KeyframesSpec.

KeyframesSpec

data class KeyframesSpec(val durationMillis: Int, val keyframes: List<Keyframe>) : AnimationSpec

Interpolates progress linearly between timestamped keyframes.

RepeatableSpec

data class RepeatableSpec(val iterations: Int, val animation: AnimationSpec, val repeatMode: RepeatMode = RepeatMode.Restart) : AnimationSpec

Repeats a finite animation for a fixed number of iterations.

RepeatMode

enum RepeatMode : Enum<RepeatMode>

Defines how a repeated animation chooses the direction of each cycle.

SnapSpec

data object SnapSpec : AnimationSpec

Selects the target value immediately without interpolation.

SpringSpec

data class SpringSpec(val dampingRatio: Float = 0.8f, val stiffness: Float = 250.0f, val durationMillis: Int = 550) : AnimationSpec

Approximates spring motion with a bounded damped oscillation over a fixed duration.

TransitionCore

class TransitionCore<S>(initialState: S)

Coordinates segment state and one shared timeline for a multi-channel transition.

TweenSpec

data class TweenSpec(val durationMillis: Int = 300, val delayMillis: Int = 0, val easing: Easing = EasingDefaults.FastOutSlowIn) : AnimationSpec

Maps a fixed-duration interval through an easing curve after an optional delay.

Functions

animationDurationNanos

fun animationDurationNanos(spec: AnimationSpec): Long

Returns the normalized total duration of spec in nanoseconds.

cubicBezier

fun cubicBezier(x1: Float, y1: Float, x2: Float, y2: Float): Easing

Creates a cubic Bézier easing from two control points.

infiniteRepeatable

fun infiniteRepeatable(animation: AnimationSpec, repeatMode: RepeatMode = RepeatMode.Restart): InfiniteRepeatableSpec

Creates an animation that repeats until its driving coroutine is cancelled.

isAnimationFinished

fun isAnimationFinished(spec: AnimationSpec, playTimeNanos: Long): Boolean

Returns whether playTimeNanos has reached the normalized finite duration of spec.

keyframe

fun keyframe(timeMillis: Int, valueFraction: Float): Keyframe

Creates one timestamped progress checkpoint for keyframes.

keyframes

fun keyframes(durationMillis: Int, vararg keyframes: Keyframe): KeyframesSpec

Creates a keyframe specification with checkpoints sorted by timestamp.

repeatable

fun repeatable(iterations: Int, animation: AnimationSpec, repeatMode: RepeatMode = RepeatMode.Restart): RepeatableSpec

Creates a finite repeated animation.

runAnimation

suspend fun <T> runAnimation(frameClock: MonotonicFrameClock, startValue: T, endValue: T, animationSpec: AnimationSpec, converter: AnimationConverter<T>, onValue: (T) -> Unit): AnimationRunResult

Drives animationSpec with frameClock and publishes sampled values through onValue.

sampleAnimationValue

fun <T> sampleAnimationValue(startValue: T, endValue: T, animationSpec: AnimationSpec, converter: AnimationConverter<T>, playTimeNanos: Long): T

Returns the value of animationSpec at playTimeNanos without owning a clock or mutable state.

snap

fun snap(): SnapSpec

Returns the shared specification that selects the target value immediately.

spring

fun spring(dampingRatio: Float = 0.8f, stiffness: Float = 250.0f, durationMillis: Int = 550): SpringSpec

Creates a bounded duration-based spring approximation.

tween

fun tween(durationMillis: Int = 300, delayMillis: Int = 0, easing: Easing = EasingDefaults.FastOutSlowIn): TweenSpec

Creates a fixed-duration easing specification.