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

Package-level declarations

Types

data class Capability<T>(val support: CapabilitySupport, val value: T? = null, val evidence: List<CapabilityEvidence> = emptyList())

Support conclusion, optional discovered value, and the evidence behind it.

CapabilityEvidence

data class CapabilityEvidence(val kind: CapabilityEvidenceKind, val detail: String)

Human-readable evidence supporting a capability conclusion.

CapabilityEvidenceKind

enum CapabilityEvidenceKind : Enum<CapabilityEvidenceKind>

Kind of observation that supports a capability conclusion.

CapabilityProbeMode

enum CapabilityProbeMode : Enum<CapabilityProbeMode>

Controls whether discovery is query-only or may run reversible firmware round trips.

CapabilitySupport

enum CapabilitySupport : Enum<CapabilitySupport>

Confidence state assigned to an individual capability.

ControlCapabilities

data class ControlCapabilities(val sideButton: Capability<Unit>, val transientUpdates: Capability<Unit>, val turbo: Capability<Unit>, val strokeStyles: Map<StrokeStyle, Capability<Unit>>)

Support conclusions for firmware pen and display controls.

DisplayCapabilities

data class DisplayCapabilities(val widthPx: Capability<Int>, val heightPx: Capability<Int>, val colorType: Capability<Int>, val updateModes: Map<EpdUpdateMode, Capability<Unit>>, val awaitUpdate: Capability<Unit>, val handwritingRepaint: Capability<Unit>, val savePenAttachedFramebuffer: Capability<Unit>)

Display geometry, refresh, and framebuffer capabilities.

DisplayColorMode

enum DisplayColorMode : Enum<DisplayColorMode>

Coarse rendering color model derived from the device color type.

FirmwareIdentity

data class FirmwareIdentity(val manufacturer: String, val model: String, val device: String, val board: String, val sdkInt: Int, val fingerprint: String, val displayBuild: String)

Stable Android build identity captured during capability discovery.

FirmwareTransport

data class FirmwareTransport(val backend: String, val serviceName: String, val interfaceToken: String, val transactionCodes: Map<String, Int>)

Resolved firmware command transport.

HiddenApiStatus

enum HiddenApiStatus : Enum<HiddenApiStatus>

Result of resolving the hidden APIs required by the recovered firmware backend.

InputAxisRange

data class InputAxisRange(val minimum: Int, val maximum: Int, val fuzz: Int? = null, val flat: Int? = null, val resolution: Int? = null, val source: String)

Native input-axis metadata reported by the raw pen reader.

NativeAlphaSupport

enum NativeAlphaSupport : Enum<NativeAlphaSupport>

Native renderer support for non-opaque alpha values.

OnyxDeviceCapabilities

data class OnyxDeviceCapabilities(val firmware: FirmwareIdentity, val transport: Capability<FirmwareTransport>, val hiddenApi: Capability<HiddenApiStatus>, val display: DisplayCapabilities, val rawInk: RawInkCapabilities, val renderers: Map<PenKind, RendererCapability>, val controls: ControlCapabilities, val rendering: RenderingCapabilities)

Immutable snapshot of all capabilities discovered for the current device.

RawInkCapabilities

data class RawInkCapabilities(val x: Capability<InputAxisRange>, val y: Capability<InputAxisRange>, val pressure: Capability<InputAxisRange>, val tiltX: Capability<InputAxisRange>, val tiltY: Capability<InputAxisRange>, val viewLocalCoordinates: Capability<Unit>, val monotonicTimestamps: Capability<Unit>, val tilt: Capability<Unit>, val sideEraser: Capability<Unit>, val tailEraser: Capability<Unit>, val regionLimits: Capability<Unit>)

Raw pen coordinate, timing, tool, and region capabilities.

RendererCapability

data class RendererCapability(val support: CapabilitySupport, val experimental: Boolean, val evidence: List<CapabilityEvidence>)

Support conclusion for one renderer kind.

RenderingCapabilities

data class RenderingCapabilities(val colorMode: Capability<DisplayColorMode>, val colorDepthBits: Capability<Int>, val nativeAlpha: Capability<NativeAlphaSupport>, val maximumHardwareStrokeWidthPx: Capability<Float>, val softwareFallback: Capability<Unit>)

Hardware rendering limits and fallback availability.