swing-ui/org.jetbrains.compose.swing.core/InfiniteAnimationPolicy

InfiniteAnimationPolicy

interface InfiniteAnimationPolicy : CoroutineContext.Element

Governs animations that run until something stops them rather than towards a target.

An animation that repeats forever asks for frames forever, so a caller waiting for a composition to run out of work waits forever with it. Installing a policy on the context a composition's effects run in gives that caller a say: every wait such an animation makes for a frame is routed through onInfiniteOperation, which decides what happens to it.

By default no policy is installed, and those animations take their frames straight from the frame clock. The test harness installs one, so an animation that never ends does not hold open a test that does not drive frames by hand.

Types

Key

object Key : CoroutineContext.Key<InfiniteAnimationPolicy>

The context key an InfiniteAnimationPolicy is installed and looked up under.

Properties

key

open override val key: CoroutineContext.Key<*>

Functions

fold

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

get

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

minusKey

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

onInfiniteOperation

abstract suspend fun <R> onInfiniteOperation(block: suspend () -> R): R

Applies the policy to block, one wait for a single animation frame. Returning what block returns lets the animation carry on to its next frame; throwing kotlin.coroutines.cancellation.CancellationException ends it.

plus

open operator fun plus(context: CoroutineContext): CoroutineContext