compose/androidx.compose.runtime/Composer

Composer

class Composer<N>(applier: Applier<N>, parentReference: CompositionReference)

Implementation of a composer for mutable tree.

Constructors

Composer

common

fun <N> Composer(applier: Applier<N>, parentReference: CompositionReference)

Functions

applyChanges

common

fun applyChanges()

Apply the changes to the tree that were collected during the last composition.

cache

common

inline fun <T> cache(invalid: Boolean, block: () -> T): T

Cache a value in the composition.

changed

common

fun changed(value: Any?): Boolean

Determine if the current slot table value is equal to the given value, if true, the value is scheduled to be skipped during applyChanges and changes return false; otherwise applyChanges will update the slot table to value.

fun changed(value: Boolean): Boolean

fun changed(value: Byte): Boolean

fun changed(value: Char): Boolean

fun changed(value: Double): Boolean

fun changed(value: Float): Boolean

fun changed(value: Int): Boolean

fun changed(value: Long): Boolean

fun changed(value: Short): Boolean

collectKeySourceInformation

common

fun collectKeySourceInformation()

Start collecting key source information.

collectParameterInformation

common

fun collectParameterInformation()

Start collecting parameter information.

composeInitial

common

fun composeInitial(block: () -> Unit)

Synchronously compose the initial composition of block.

endDefaults

common

fun endDefaults()

Warning: This is expected to be executed by the compiler only and should not be called directly from source code.

endMovableGroup

common

fun endMovableGroup()

Indicates the end of a "Movable Group" at the current execution position.

endReplaceableGroup

common

fun endReplaceableGroup()

Indicates the end of a "Replaceable Group" at the current execution position.

endRestartGroup

common

fun endRestartGroup(): ScopeUpdateScope?

End a restart group.

equals

common

open operator fun equals(other: Any?): Boolean

hashCode

common

open fun hashCode(): Int

joinKey

common

fun joinKey(left: Any?, right: Any?): Any

Create a composed key that can be used in calls to startGroup or startNode.

recompose

common

fun recompose(): Boolean

Synchronously recompose all invalidated groups.

recordModificationsOf

common

fun recordModificationsOf(values: Set<Any>)

Record that the objects in values have been modified.

recordReadOf

common

fun recordReadOf(value: Any)

Record that value was read from.

recordWriteOf

common

fun recordWriteOf(value: Any)

Record that value was written to during composition.

skipCurrentGroup

common

fun skipCurrentGroup()

Skip a group.

skipToGroupEnd

common

fun skipToGroupEnd()

Skip to the end of the group opened by startGroup.

startDefaults

common

fun startDefaults()

Warning: This is expected to be executed by the compiler only and should not be called directly from source code.

startMovableGroup

common

fun startMovableGroup(key: Int, dataKey: Any?)

Inserts a "Movable Group" starting marker in the slot table at the current execution position.

fun startMovableGroup(key: Int, dataKey: Any?, sourceInformation: String?)

startReplaceableGroup

common

fun startReplaceableGroup(key: Int)

Inserts a "Replaceable Group" starting marker in the slot table at the current execution position.

fun startReplaceableGroup(key: Int, sourceInformation: String?)

startRestartGroup

common

fun startRestartGroup(key: Int)

Start a restart group.

fun startRestartGroup(key: Int, sourceInformation: String?)

toString

common

open fun toString(): String

verifyConsistent

common

fun verifyConsistent()

Throw a diagnostic exception if the internal tracking tables are inconsistent.

Properties

applyCoroutineContext

common

val applyCoroutineContext: CoroutineContext

compositionData

common

val compositionData: CompositionData

currentCompoundKeyHash

common

var currentCompoundKeyHash: Int = 0

Returns the hash of the compound key calculated as a combination of the keys of all the currently started groups via startGroup.

defaultsInvalid

common

val defaultsInvalid: Boolean

skipping

common

val skipping: Boolean

True if the composition should be checking if the composable functions can be skipped.