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

Package-level declarations

Types

Behavior requested when committing while the pen is down.

data class BrushConfiguration(val style: StrokeStyle = StrokeStyle.FOUNTAIN, val color: Int = 0xff000000.toInt(), val widthPx: Float = 3.0f, val tiltEnabled: Boolean = true, val fastMode: Boolean = false, val minWidthPx: Float = 0.0f, val rotateAngleDegrees: Int = 0, val tiltScale: Float = 0.0f, val directionEnabled: Boolean = false, val maxTouchPressure: Float = 1.0f, val dpi: Float = 320.0f, val displayScaleX: Float = 1.0f, val displayScaleY: Float = 1.0f, val scalePrecision: Float = 1.0f, val brushSpacing: Float = 0.25f, val brushShape: BrushShape = BrushShape.CIRCLE, val brushRatio: Float = 5.0f, val brushAngleDegrees: Float = 0.0f, val pressureSensitivity: Float = 0.0f, val velocitySensitivity: Float = 0.0f, val velocityAmplifier: Float = 0.0f, val velocityIgnoreThreshold: Float = 0.0f, val velocityLowerBound: Float = 0.0f, val velocityUpperBound: Float = 0.0f, val smoothLevel: Float = 0.2f, val startPointLimit: Float = 0.0f, val startLengthLimit: Float = 0.0f, val endVelocitySensitivity: Float = 0.0f, val endThinningRate: Float = 0.0f, val ignorePressure: Float = 0.0f, val dashPattern: DashPattern? = null)

Complete brush configuration shared by raw overlay and native renderer APIs.

BrushShape

enum BrushShape : Enum<BrushShape>

Shape used by the native renderer to stamp brush samples.

CommitOptions

data class CommitOptions(val activeStrokePolicy: ActiveStrokePolicy = ActiveStrokePolicy.WaitForPenUp(), val updateMode: EpdUpdateMode = EpdUpdateMode.HANDWRITING_REPAINT, val refreshTimeout: Duration = 2.seconds)

Controls bitmap commit coordination and refresh behavior.

CoordinateSpace

enum CoordinateSpace : Enum<CoordinateSpace>

Coordinate system used by raw input values.

DashPattern

data class DashPattern(val onLengthPx: Float, val offLengthPx: Float, val phasePx: Float = 0.0f)

Typed dash geometry retained without exposing the firmware float array.

EpdUpdateMode

enum EpdUpdateMode : Enum<EpdUpdateMode>

Typed E Ink waveform/update mode accepted by KTX refresh APIs.

EraserConfiguration

data class EraserConfiguration(val widthPx: Float = 20.0f, val sideButtonEnabled: Boolean = true, val style: EraserStyle = EraserStyle.DEFAULT)

Eraser behavior for a raw-ink session.

EraserStyle

@JvmInline

value class EraserStyle

Firmware eraser-style identifier.

ExperimentalOnyxRendererApi

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION])

annotation class ExperimentalOnyxRendererApi

Marks renderer features that require explicit opt-in and validation on target firmware.

InkPoint

data class InkPoint(val xPx: Float, val yPx: Float, val rawPressure: Int, val normalizedPressure: Float, val maxPressure: Int, val tiltX: Int, val tiltY: Int, val eventTimeNanos: Long, val sequence: Long, val tool: InkTool)

Lossless raw input sample normalized for application use.

InkPreview

data class InkPreview(val point: InkPoint, val phase: InkPreview.Phase)

Latest preview sample for an in-progress or just-completed stroke.

InkStroke

data class InkStroke(val tool: InkTool, val points: List<InkPoint>, val endedOutsideLimitRegion: Boolean, val bounds: RectF)

Completed raw stroke.

InkTool

enum InkTool : Enum<InkTool>

Physical pen tool associated with an input point or stroke.

LeasePolicy

enum LeasePolicy : Enum<LeasePolicy>

Policy used when another session owns the process-wide raw-ink lease.

OnyxFailure

sealed class OnyxFailure : RuntimeException

Typed failure returned through Kotlin's Result.

PenEvent

data class PenEvent(val phase: PenPhase, val point: InkPoint, val outsideLimitRegion: Boolean = false, val forced: Boolean = false)

Immutable, lossless raw event; instances may be retained after collection.

PenKind

enum PenKind : Enum<PenKind>

Native pen renderer selected for a stroke.

PenPhase

enum PenPhase : Enum<PenPhase>

Lifecycle phase of a raw pen event.

PenState

enum PenState : Enum<PenState>

Firmware handwriting state associated with a view.

RawInkConfiguration

data class RawInkConfiguration(val brush: BrushConfiguration = BrushConfiguration(), val eraser: EraserConfiguration = EraserConfiguration(), val limitRegions: List<Rect> = emptyList(), val excludeRegions: List<Rect> = emptyList(), val regionMode: RegionMode = RegionMode.MULTI_REGION, val maxPointsPerStroke: Int)

Immutable configuration applied whenever a raw-ink session starts or resumes.

RefreshScope

sealed interface RefreshScope

Portion of a view to refresh.

RegionMode

enum RegionMode : Enum<RegionMode>

Firmware interpretation of raw-ink limit and exclusion regions.

StrokeStyle

enum StrokeStyle : Enum<StrokeStyle>

Firmware stroke style used for overlay rendering.

TiltUnit

enum TiltUnit : Enum<TiltUnit>

Unit represented by raw tilt values.

TimestampClock

enum TimestampClock : Enum<TimestampClock>

Clock used by raw input timestamps.

TurboMode

enum TurboMode : Enum<TurboMode>

Whether firmware turbo rendering is enabled.