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

Package-level declarations

Types

data class CommitReceipt(val surfaceGeneration: Long, val surfacePost: SurfacePostEvidence, val overlaySynchronization: OverlaySynchronizationEvidence, val refresh: RefreshReceipt, val configurationRestoration: ConfigurationRestorationEvidence, val warnings: Set<CommitWarning>)

Evidence collected while committing content beneath the raw-ink overlay.

enum CommitWarning : Enum<CommitWarning>

Recoverable limitation encountered during a bitmap commit.

ConfigurationRestorationEvidence

enum ConfigurationRestorationEvidence : Enum<ConfigurationRestorationEvidence>

Evidence that raw-ink configuration was restored after a commit.

OverlaySynchronizationEvidence

enum OverlaySynchronizationEvidence : Enum<OverlaySynchronizationEvidence>

Mechanism used to synchronize firmware handwriting overlay contents.

interface PenSession : Closeable

Injectable application-facing pen-session contract.

class RawInkSession : PenSession

Exclusive, generation-aware owner of the firmware raw-ink overlay.

RawInkSessionState

sealed interface RawInkSessionState

Lifecycle state of a raw-ink session.

SurfacePostEvidence

enum SurfacePostEvidence : Enum<SurfacePostEvidence>

Evidence that a committed bitmap reached the expected surface generation.

SuspensionReason

enum SuspensionReason : Enum<SuspensionReason>

Reason a raw-ink session is not currently accepting input.

Functions

withRawInkSession

suspend fun <T> withRawInkSession(surfaceView: SurfaceView, configuration: RawInkConfiguration = RawInkConfiguration(), leasePolicy: LeasePolicy = LeasePolicy.FAIL_FAST, block: suspend RawInkSession.() -> T): Result<T>

Opens a session, runs block, and waits for cleanup before returning.