PokéRogue
    Preparing search index...

    Class ColorBand

    The ColorBand class represents a transition from one color to another. It is used in a {@see Phaser.Display.ColorRamp}, and forms the basis of a {@see Phaser.GameObjects.Gradient}.

    ColorBand can control the transition by setting a middle point, a color space for blending, and an interpolation style.

    This class also records start and end points for use in a ramp. These indicate its position within the ramp.

    Colors are handled unpremultiplied, so RGB values may be larger than alpha.

    Index
    constructor
    colorEnd colorSpace colorStart end interpolation isColorBand middle start
    getColor setColors
    colorEnd: Color

    The color at the end of the color band.

    colorSpace: number

    The color space where interpolation should be done. This can be one of the following codes:

    • 0: RGBA - channels are blended directly. This can produce perceptually inaccurate results, as blending in RGB space does not account for how humans perceive color.
    • 1: HSVA_NEAREST - colors are blended in HSVA space, better preserving saturation and lightness. The hue is blended with the shortest angle, e.g. red and blue blend via purple, not green.
    • 2: HSVA_PLUS - as HSVA_NEAREST, but hue angle always increases.
    • 3: HSVA_MINUS - as HSVA_NEAREST, but hue angle always decreases.
    colorStart: Color

    The color at the start of the color band.

    end: number

    The end point of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end).

    interpolation: number

    The color interpolation. This can be one of the following codes:

    • 0: LINEAR - a straight blend.
    • 1: CURVED - color changes quickly at start and end, flattening in the middle. Good for convex surfaces.
    • 2: SINUSOIDAL - color changes quickly in the middle, flattening at start and end. Good for smooth transitions.
    • 3: CURVE_START - color changes quickly at the start, flattening at the end.
    • 4: CURVE_END - color changes quickly at the end, flattening at the start.

    Modes 2, 3, and 4 use the circular easing function directly. Mode 1 uses a related custom formula based on the unit circle.

    isColorBand: boolean

    Identifies this object as a ColorBand. This property is read-only and must not be modified.

    middle: number

    The middle point of this band within a ColorRamp. This value should be normalized within the band, between 0 (band start) and 1 (band end). Middle point alters the shape of the color interpolation.

    Mathematically, the gradient should be 0.5 at the middle. We use a gamma curve to adjust the gradient. Thus, 0.5 = middle^gamma. By the properties of logarithms, therefore, gamma = log base middle of 0.5.

    start: number

    The start point of this band within a ColorRamp. This value should be normalized within the ramp, between 0 (ramp start) and 1 (ramp end).

    • Returns the blended color at a normalized position within this band. The middle point gamma curve, interpolation mode, and color space are all applied before blending between colorStart and colorEnd.

      Parameters

      • index: number

        The normalized position within the band, where 0 is the band start and 1 is the band end.

      Returns ColorObject

      The blended color at that position.

    • Set the colors of the band, from a variety of color formats.

      • A number is expected to be a 24 or 32 bit RGB or ARGB value.
      • A string is expected to be a hex code.
      • An array of numbers is expected to be RGB or RGBA in the range 0-1.
      • A Color object can be used.

      Parameters

      • Optionalstart: string | number | number[] | Color

        The color at the start of the band. Default 0x000000.

      • Optionalend: string | number | number[] | Color

        The color at the end of the band. If not specified, equals start.

      Returns this

      This ColorBand.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods