onyxsdk-ktx/com.onyx.android.sdk.ktx.display

Package-level declarations

Types

Boundary used to decide that an E Ink refresh is complete.

Process-wide controller for nesting-safe transient refresh modes.

Describes an acquired transient refresh-mode lease.

Ownership boundary of a transient refresh mode.

Nesting-safe ownership token for the process-global firmware transient mode.

data class RefreshReceipt(val evidence: RefreshCompletionEvidence, val elapsedNanos: Long, val warnings: Set<RefreshWarning> = emptySet())

Result of waiting for an E Ink refresh.

Recoverable limitation encountered while waiting for a refresh.

Firmware transient update mode owned by a scoped token.

suspend fun awaitEpdIdle(timeout: Duration = 2.seconds, fallbackDelay: Duration = 500.milliseconds): Result<RefreshReceipt>

Waits until the firmware reports that the current E Ink update is complete.

suspend fun View.refreshAndAwait(mode: EpdUpdateMode, scope: RefreshScope = RefreshScope.FullView, timeout: Duration = 2.seconds): Result<RefreshReceipt>

Dispatches an E Ink refresh for this view and waits for its completion boundary.

suspend fun <T> withRefreshMode(mode: TransientUpdateMode = TransientUpdateMode.ANIMATION_QUALITY, block: suspend () -> T): Result<T>

Runs block while mode is leased, then waits for the lease to be released.