Taos API Reference
    Preparing search index...

    Interface ColorGradeSettings

    Color-grading stack. Every field is optional and defaults to a neutral (identity) value, so a bare {} grades nothing. Mutate any field on a live TonemapFeature.grade object and the next frame re-uploads it.

    interface ColorGradeSettings {
        enabled?: boolean;
        temperature?: number;
        tint?: number;
        contrast?: number;
        contrastPivot?: number;
        saturation?: number;
        hueShift?: number;
        colorFilter?: ColorGradeRgb;
        lift?: ColorGradeRgb;
        gamma?: ColorGradeRgb;
        gain?: ColorGradeRgb;
        shadows?: ColorGradeRgb;
        midtones?: ColorGradeRgb;
        highlights?: ColorGradeRgb;
        splitShadowColor?: ColorGradeRgb;
        splitHighlightColor?: ColorGradeRgb;
        splitBalance?: number;
        splitStrength?: number;
        mixRed?: ColorGradeRgb;
        mixGreen?: ColorGradeRgb;
        mixBlue?: ColorGradeRgb;
    }
    Index

    Properties

    enabled? temperature? tint? contrast? contrastPivot? saturation? hueShift? colorFilter? lift? gamma? gain? shadows? midtones? highlights? splitShadowColor? splitHighlightColor? splitBalance? splitStrength? mixRed? mixGreen? mixBlue?

    Properties

    enabled?: boolean

    Master toggle. When false the whole stack is skipped on the GPU (fast path, identical output to no grade). Default true.

    temperature?: number

    White-balance temperature, -100..100. Positive warms (toward orange), negative cools (toward blue). Default 0 (neutral).

    tint?: number

    White-balance tint, -100..100. Positive toward magenta, negative toward green. Default 0.

    contrast?: number

    Contrast multiplier around contrastPivot. 1 = neutral. Default 1.

    contrastPivot?: number

    Linear pivot the contrast scales about. Default 0.18 (scene mid-gray).

    saturation?: number

    Saturation multiplier (luma-preserving). 0 = grayscale, 1 = neutral,

    1 = boosted. Default 1.

    hueShift?: number

    Hue rotation in degrees (luminance-preserving). Default 0.

    colorFilter?: ColorGradeRgb

    Per-channel tint multiplied into the linear scene. Default [1,1,1].

    lift?: ColorGradeRgb

    Additive offset (shadows lift). Default [0,0,0].

    gamma?: ColorGradeRgb

    Power (midtone) control, per channel; 1 = neutral. Default [1,1,1].

    gain?: ColorGradeRgb

    Multiplicative gain (slope/highlights). Default [1,1,1].

    shadows?: ColorGradeRgb

    Additive offset applied to shadow-band luma. Default [0,0,0].

    midtones?: ColorGradeRgb

    Additive offset applied to midtone-band luma. Default [0,0,0].

    highlights?: ColorGradeRgb

    Additive offset applied to highlight-band luma. Default [0,0,0].

    splitShadowColor?: ColorGradeRgb

    Tint pushed into shadows. Neutral gray [0.5,0.5,0.5] = no effect.

    splitHighlightColor?: ColorGradeRgb

    Tint pushed into highlights. Neutral gray [0.5,0.5,0.5] = no effect.

    splitBalance?: number

    Luma balance between the two tints, -1..1. Default 0.

    splitStrength?: number

    Overall split-toning strength, 0..1. Default 0 (off).

    mixRed?: ColorGradeRgb

    Output-red as a mix of input rgb. Default [1,0,0].

    mixGreen?: ColorGradeRgb

    Output-green as a mix of input rgb. Default [0,1,0].

    mixBlue?: ColorGradeRgb

    Output-blue as a mix of input rgb. Default [0,0,1].

    Settings

    Member Visibility

    On This Page

    Properties