openrv-web / PixelProbeProvider

Interface: PixelProbeProvider

Defined in: api/types.ts:181

Minimal pixel probe interface required by the API layer.

Provides enable/disable, lock/unlock, state query, and configuration for the pixel-probe overlay.

Methods

disable()

disable(): void

Defined in: api/types.ts:183

Returns

void

---

enable()

enable(): void

Defined in: api/types.ts:182

Returns

void

---

getSampleSize()

getSampleSize(): SampleSize

Defined in: api/types.ts:190

Returns

SampleSize

---

getSourceMode()

getSourceMode(): SourceMode

Defined in: api/types.ts:192

Returns

SourceMode

---

getState()

getState(): PixelProbeState

Defined in: api/types.ts:187

Returns

PixelProbeState

---

isEnabled()

isEnabled(): boolean

Defined in: api/types.ts:184

Returns

boolean

---

isLocked()

isLocked(): boolean

Defined in: api/types.ts:186

Returns

boolean

---

setFormat()

setFormat(format): void

Defined in: api/types.ts:188

Parameters

format

"rgb" | "rgb01" | "hsl" | "hex" | "ire"

Returns

void

---

setSampleSize()

setSampleSize(size): void

Defined in: api/types.ts:189

Parameters

size

SampleSize

Returns

void

---

setSourceMode()

setSourceMode(mode): void

Defined in: api/types.ts:191

Parameters

mode

SourceMode

Returns

void

---

toggleLock()

toggleLock(): void

Defined in: api/types.ts:185

Returns

void