Skip to content

openrv-web / LUTPipelineProvider

Interface: LUTPipelineProvider

Defined in: api/types.ts:120

Per-stage output color-space declaration interface.

Sibling of LUTProvider: kept as a separate interface so that implementations supporting only the simple single-LUT API are not forced to implement the multi-stage surface.

null is the sentinel for "color-space-preserving" (the stage's input primaries / transfer flow through unchanged). Concrete values declare what color-space the stage's output is encoded in so downstream stages (and the renderer) can interpret pixels correctly.

Methods

getLUTStageOutputColorPrimaries()

getLUTStageOutputColorPrimaries(stage): ColorPrimaries | null

Defined in: api/types.ts:122

Parameters

stage

LUTPipelineStage

Returns

ColorPrimaries | null


getLUTStageOutputTransferFunction()

getLUTStageOutputTransferFunction(stage): TransferFunction | null

Defined in: api/types.ts:125

Parameters

stage

LUTPipelineStage

Returns

TransferFunction | null


isOCIOActiveForDisplay()?

optional isOCIOActiveForDisplay(): boolean

Defined in: api/types.ts:133

True iff OCIO is currently active and overriding manual declarations on the display stage. Optional — not all providers will know about OCIO. Used by the API surface to log a one-time warning when a manual declaration would be effectively overridden.

Returns

boolean


setLUTStageOutputColorPrimaries()

setLUTStageOutputColorPrimaries(stage, primaries): void

Defined in: api/types.ts:121

Parameters

stage

LUTPipelineStage

primaries

ColorPrimaries | null

Returns

void


setLUTStageOutputTransferFunction()

setLUTStageOutputTransferFunction(stage, transfer): void

Defined in: api/types.ts:124

Parameters

stage

LUTPipelineStage

transfer

TransferFunction | null

Returns

void

Released under the MIT License.