RSX Code Reference
    Preparing search index...
    • rsx
    • ColorGradientHDR

    Class ColorGradientHDR

    Represents a range of color values over some parameters, similar to a curve. Internally represented as a set of keys that get interpolated between. Capable of representing HDR colors, unlike the normal ColorGradient.

    Index
    constructor
    duration isOpaque keyCount
    evaluate getKey getKeys setConstant setKeys
    • get duration(): number

      Returns the duration over which the gradient values are interpolated over. Corresponds to the time value of the final keyframe.

      Returns number

    • set duration(value: number): void

      Parameters

      • value: number

      Returns void

    • get isOpaque(): boolean

      Determines if all color values have an alpha value of at least 1.0f

      Returns boolean

    • get keyCount(): number

      Returns the number of color keys in the gradient.

      Returns number

    • Evaluates a color at the specified t.

      Parameters

      • t: number

      Returns Color

    • Returns the color key at the specified index. If out of range an empty key is returned.

      Parameters

      • idx: number

      Returns ColorGradientKey

    • Specify a "gradient" that represents a single color value.

      Parameters

      Returns void

    • Sets the gradient keys.

      Parameters

      • keys: Immutable<ColorGradientKey>[]

        The gradient keys.

      • Optionalduration: number

        Optional, the duration of the gradient. If not set, the duration is inferred from the time of the keys.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods