Recomposer.State

Artifact: androidx.compose.runtime:runtime

Added in 1.0.0

Cmn
```
enum Recomposer.State : Enum
```

kotlin.Any
↳	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 functions
`Recomposer.State`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.	Cmn
`Array<Recomposer.State>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.	Cmn

Public properties
`EnumEntries<Recomposer.State>`	`entries` Returns a representation of an immutable list of all enum entries, in the order they're declared.	Cmn

Enum Values

Idle

val Recomposer.State.Idle: Recomposer.State

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

Inactive

val Recomposer.State.Inactive: Recomposer.State

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

val Recomposer.State.InactivePendingWork: Recomposer.State

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

val Recomposer.State.PendingWork: Recomposer.State

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

val Recomposer.State.ShutDown: Recomposer.State

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

ShuttingDown

val Recomposer.State.ShuttingDown: Recomposer.State

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 functions

valueOf

Cmn

Added in 1.0.0

fun valueOf(value: String): Recomposer.State

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

Cmn

Added in 1.0.0

fun values(): Array<Recomposer.State>

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.

Public properties

entries

Cmn

val entries: EnumEntries<Recomposer.State>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.