openrv-web / ColorAPI

Class: ColorAPI

Defined in: api/ColorAPI.ts:64

Constructors

Constructor

new ColorAPI(colorControls, cdlControl, curvesControl): ColorAPI

Defined in: api/ColorAPI.ts:69

Parameters

colorControls

ColorAdjustmentProvider

cdlControl

CDLProvider

curvesControl

CurvesProvider

Returns

ColorAPI

Methods

getAdjustments()

getAdjustments(): PublicColorAdjustments

Defined in: api/ColorAPI.ts:138

Get current color adjustments.

Returns

PublicColorAdjustments

A snapshot of all current color adjustment values.

Example

const adj = openrv.color.getAdjustments();
console.log(adj.exposure, adj.gamma);

---

getCDL()

getCDL(): CDLValues

Defined in: api/ColorAPI.ts:244

Get current CDL values (returns a defensive copy).

Returns

CDLValues

A deep copy of the current CDL slope, offset, power, and saturation values.

Example

const cdl = openrv.color.getCDL();
console.log(cdl.slope.r, cdl.offset.g, cdl.saturation);

---

getCurves()

getCurves(): PublicColorCurvesData

Defined in: api/ColorAPI.ts:296

Get current curves.

Returns a defensive deep copy of master/red/green/blue channels.

Returns

PublicColorCurvesData

---

reset()

reset(): void

Defined in: api/ColorAPI.ts:164

Reset all color adjustments to their default values.

Returns

void

Example

openrv.color.reset();

---

resetCurves()

resetCurves(): void

Defined in: api/ColorAPI.ts:309

Reset all curves to the default identity state.

Returns

void

---

setAdjustments()

setAdjustments(adjustments): void

Defined in: api/ColorAPI.ts:91

Set color adjustments (partial update - merges with current values).

Only the provided keys are updated; the rest retain their current values. Non-numeric or NaN values for a key are silently ignored.

Parameters

adjustments

Partial<PublicColorAdjustments>

An object with one or more color adjustment fields to update. Valid keys: exposure, gamma, saturation, contrast, hueRotation, temperature, tint, brightness, highlights, shadows, whites, blacks.

Returns

void

Throws

If adjustments is not a plain object.

Example

openrv.color.setAdjustments({ exposure: 1.5, saturation: 0.8 });

---

setCDL()

setCDL(cdl): void

Defined in: api/ColorAPI.ts:203

Set CDL (Color Decision List) values (partial update - merges with current values).

Each of slope, offset, and power must be an object with numeric r, g, b fields. saturation must be a number. Only provided keys are updated.

Parameters

cdl

Partial<CDLValues>

An object with one or more CDL fields: slope, offset, power, saturation.

Returns

void

Throws

If cdl is not a plain object, or if slope/offset/power do not have numeric r, g, b fields, or if saturation is not a number.

Example

openrv.color.setCDL({ slope: { r: 1.1, g: 1.0, b: 0.9 }, saturation: 1.2 });

---

setCurves()

setCurves(curves): void

Defined in: api/ColorAPI.ts:268

Set color curves with support for per-channel partial updates.

Any subset of channels can be provided. Within each channel update, enabled and/or points may be provided.

Parameters

curves

PublicColorCurvesUpdate

Returns

void

Example

openrv.color.setCurves({
  red: { points: [{ x: 0, y: 0.05 }, { x: 1, y: 0.95 }] },
  blue: { enabled: false }
});