Interface ColorCorrectionConfig

Configuration for the Color Correction effect.

All fields are optional when passed through setConfig; only provided fields are updated.

interface ColorCorrectionConfig {
    autoMode: boolean;
    contrast: number;
    exposure: number;
    filterPart: number;
    power: number;
    temperature: number;
    tint: number;
    updatePeriod: number;
    vibrance: number;
    whiteBalance: number;
}

Properties

autoMode: boolean

Enables fully automatic color correction.

When true, the effect analyzes each frame and automatically drives white balance, contrast and exposure. When false, only the manual parameters are applied.

Default

true
contrast: number

Manual local-contrast adjustment.

Applied only when auto correction is not driving contrast.

Range: [-1, 1].

Default

0
exposure: number

Manual exposure adjustment.

Negative values darken the image, positive values brighten it. Applied only when auto correction is not driving exposure.

Range: [-1, 1].

Default

0
filterPart: number

Developer feature: enables or disables the color-correction shader pass.

Intended for debugging and A/B comparisons rather than end-user configuration.

Range: [0, 1].

Default

1
power: number

Overall strength of the automatic correction.

Controls power of auto-driven correction (exposure, contrast and white balance strength).

Range: [0, 1].

Default

1
temperature: number

Manual color temperature adjustment (cool to warm).

Negative values shift the image toward cool, positive values toward warm.

Range: [-1, 1].

Default

0
tint: number

Manual tint adjustment.

Range: [-1, 1].

Default

0
updatePeriod: number

Minimum interval (in milliseconds) between two automatic analyses of the frame. Larger values reduce CPU/GPU load but slow down the reaction to scene changes. Only relevant when autoMode or whiteBalance is enabled.

Range: [0, 5000].

Default

200
vibrance: number

Manual vibrance adjustment.

Range: [-1, 1].

Default

0
whiteBalance: number

Strength of the automatic white balance correction.

0 disables auto white balance; any value greater than 0 enables it and controls how strongly the correction is applied.

Ignored when autoMode is true (in that case white balance is already controlled by auto mode together with contrast and exposure). When autoMode is false, this value turns on auto white balance without affecting contrast or exposure.

Range: [0, 1].

Default

0