Engine API Reference - v2.17.0
    Preparing search index...

    Interface ColorEnhance

    Properties related to the color enhancement effect, a postprocessing technique that provides HDR-aware adjustments for shadows, highlights, vibrance, and dehaze. Shadows and highlights allow selective adjustment of dark and bright areas of the image, vibrance is a smart saturation that boosts less-saturated colors more than already-saturated ones, and dehaze removes atmospheric haze to increase clarity and contrast.

    interface ColorEnhance {
        dehaze: number;
        enabled: boolean;
        highlights: number;
        midtones: number;
        shadows: number;
        vibrance: number;
    }
    Index

    Properties

    dehaze: number

    The dehaze adjustment, -1 to 1 range. Positive values remove atmospheric haze, increasing clarity and contrast. Negative values add a haze effect. Defaults to 0.

    enabled: boolean

    Whether color enhancement is enabled. Defaults to false.

    highlights: number

    The highlight adjustment, -3 to 3 range. Uses an exponential curve where -3 gives 0.125x, 0 gives 1x, and +3 gives 8x brightness on bright areas. Defaults to 0.

    midtones: number

    The midtone adjustment, -1 to 1 range. Positive values brighten midtones, negative values darken midtones, with shadows and highlights more strongly preserved than by a linear exposure change. Defaults to 0.

    shadows: number

    The shadow adjustment, -3 to 3 range. Uses an exponential curve where -3 gives 0.125x, 0 gives 1x, and +3 gives 8x brightness on dark areas. Defaults to 0.

    vibrance: number

    The vibrance (smart saturation), -1 to 1 range. Positive values boost saturation of less-saturated colors more than already-saturated ones. Negative values desaturate. Defaults to 0.