{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

Recomposer.State

public enum Recomposer.State extends Enum

java.lang.Object
   ↳ kotlin.Enum
     ↳ androidx.compose.runtime.Recomposer.State

Valid operational states of a Recomposer.

Summary

Enum Values

Idle

The Recomposer is tracking composition and snapshot invalidations but there is currently no work to do.

Inactive

The Recomposer is not tracking invalidations for known composers and it will not recompose them in response to changes.

InactivePendingWork

The Recomposer is Inactive but at least one effect associated with a managed composition is awaiting a frame.

PendingWork

The Recomposer has been notified of pending work it must perform and is either actively performing it or awaiting the appropriate opportunity to perform it.

ShutDown

cancel was called on the Recomposer and all cleanup work has completed.

ShuttingDown

cancel was called on the Recomposer and it is no longer available for use.

Public methods

final @NonNull EnumEntries<@NonNull Recomposer.State>

Valid operational states of a Recomposer.

final @NonNull Recomposer.State

Returns the enum constant of this type with the specified name.

final @NonNull Recomposer.State[]

Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

Idle

Recomposer.State Recomposer.State.Idle

The Recomposer is tracking composition and snapshot invalidations but there is currently no work to do.

Inactive

Recomposer.State Recomposer.State.Inactive

The Recomposer is not tracking invalidations for known composers and it will not recompose them in response to changes. Call runRecomposeAndApplyChanges to await and perform work. This is the initial state of a newly constructed Recomposer.

InactivePendingWork

Recomposer.State Recomposer.State.InactivePendingWork

The Recomposer is Inactive but at least one effect associated with a managed composition is awaiting a frame. This frame will not be produced until the Recomposer is running.

PendingWork

Recomposer.State Recomposer.State.PendingWork

The Recomposer has been notified of pending work it must perform and is either actively performing it or awaiting the appropriate opportunity to perform it. This work may include invalidated composers that must be recomposed, snapshot state changes that must be presented to known composers to check for invalidated compositions, or coroutines awaiting a frame using the Recomposer's MonotonicFrameClock.

ShutDown

Recomposer.State Recomposer.State.ShutDown

cancel was called on the Recomposer and all cleanup work has completed. The Recomposer is no longer available for use.

ShuttingDown

Recomposer.State Recomposer.State.ShuttingDown

cancel was called on the Recomposer and it is no longer available for use. Cleanup work has not yet been fully completed and composition effect coroutines may still be running.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull Recomposer.StategetEntries()

Valid operational states of a Recomposer.

valueOf

public final @NonNull Recomposer.State valueOf(@NonNull String value)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

public final @NonNull Recomposer.State[] values()

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.