registerOnGlobalLayoutListener

Function

Common

fun DelegatableNode.registerOnGlobalLayoutListener(
    throttleMillis: Long,
    debounceMillis: Long,
    callback: (RelativeLayoutBounds) -> Unit,
): RegistrationHandle

Registers a callback to be executed with the position of this modifier node relative to the coordinate system of the root of the composition, as well as in screen coordinates and window coordinates, see RelativeLayoutBounds.

It may also be used to calculate certain Layout relationships at the time of the callback execution, such as RelativeLayoutBounds.calculateOcclusions.

This will be called after layout pass. This API allows for throttling and debouncing parameters in order to moderate the frequency with which the callback gets invoked during high rates of change (e.g. scrolling).

Specifying throttleMillis will prevent callback from being executed more than once over that time period. Specifying debounceMillis will delay the execution of callback until that amount of time has elapsed without a new position.

Specifying 0 for both throttleMillis and debounceMillis will result in the callback being executed every time the position has changed. Specifying non-zero amounts for both will result in both conditions being met.

Parameters


throttleMillis	The duration, in milliseconds, to prevent `callback` from being executed more than once over that time period.
debounceMillis	The duration, in milliseconds, to delay the execution of `callback` until that amount of time has elapsed without a new position.
callback	The callback to be executed, provides a new `RelativeLayoutBounds` instance associated to this `DelegatableNode`. Keep in mind this callback is executed on the main thread even when debounced.

Returns


	an object which should be used to unregister/dispose this callback, such as when a node is detached