Small World Engine API Reference - v0.46.1
    Preparing search index...

    Class Color

    Index

    Constructors

    Properties

    a b g r

    Accessors

    Methods

    Constructors

    • Creates a new Color.

      Parameters

      • r: number = 0

        Red component (0-1).

      • g: number = 0

        Green component (0-1).

      • b: number = 0

        Blue component (0-1).

      • a: number = 1.0

        Alpha component (0-1).

      Returns Color

    Properties

    a: number = 1.0

    Alpha component (0-1).

    b: number = 0

    Blue component (0-1).

    g: number = 0

    Green component (0-1).

    r: number = 0

    Red component (0-1).

    Accessors

    Methods

    • Parameters

      • r: number = 0
      • g: number = 0
      • b: number = 0
      • a: number = 1.0

      Returns this

    • Returns the color components as an array.

      Returns number[]

      [r, g, b, a]

    • Returns the color components as a Float32Array.

      Returns Float32Array

      Float32Array(4)

    • Returns the color components as a hex string (e.g. "#FF0000").

      Parameters

      • includeAlpha: boolean = false

        Whether to include the alpha channel (e.g. "#FF0000FF").

      Returns string

    • Returns the color components as HSL.

      Returns { h: number; l: number; s: number }

      An object with { h: (0-360), s: (0-1), l: (0-1) }

    • Returns the color components as HSV/HSB.

      Returns { h: number; s: number; v: number }

      An object with { h: (0-360), s: (0-1), v: (0-1) }

    • Creates a Color from HSL (Hue, Saturation, Lightness).

      Parameters

      • h: number

        Hue (0 - 360).

      • s: number

        Saturation (0.0 - 1.0).

      • l: number

        Lightness (0.0 - 1.0).

      • a: number = 1.0

        Alpha (0.0 - 1.0). Default is 1.0.

      Returns Color

    • Creates a Color from HSV/HSB (Hue, Saturation, Value/Brightness).

      Parameters

      • h: number

        Hue (0 - 360).

      • s: number

        Saturation (0.0 - 1.0).

      • v: number

        Value/Brightness (0.0 - 1.0).

      • a: number = 1.0

        Alpha (0.0 - 1.0). Default is 1.0.

      Returns Color