API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Color4

Class used to hold a RBGA color

Hierarchy

  • Color4

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Color4(r?: number, g?: number, b?: number, a?: number): Color4

  • Creates a new Color4 object from red, green, blue values, all between 0 and 1

    Parameters

    • Optional r: number

      defines the red component (between 0 and 1, default is 0)

    • Optional g: number

      defines the green component (between 0 and 1, default is 0)

    • Optional b: number

      defines the blue component (between 0 and 1, default is 0)

    • Optional a: number

      defines the alpha component (between 0 and 1, default is 1)

    Returns Color4

Properties

aSearch playground for a

a: number

Defines the alpha component (between 0 and 1, default is 1)

bSearch playground for b

b: number

Defines the blue component (between 0 and 1, default is 0)

gSearch playground for g

g: number

Defines the green component (between 0 and 1, default is 0)

rSearch playground for r

r: number

Defines the red component (between 0 and 1, default is 0)

Methods

addSearch playground for add

  • Creates a new Color4 set with the added values of the current Color4 and of the given one

    Parameters

    Returns Color4

    a new Color4 object

addInPlaceSearch playground for addInPlace

  • Adds in place the given Color4 values to the current Color4 object

    Parameters

    Returns Color4

    the current updated Color4 object

asArraySearch playground for asArray

  • asArray(): number[]

  • Creates a new array populated with 4 numeric elements : red, green, blue, alpha values

    Returns number[]

    the new array

clampToRefSearch playground for clampToRef

  • clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4

  • Clamps the rgb values by the min and max values and stores the result into "result"

    Parameters

    • min: number | undefined

      defines minimum clamping value (default is 0)

    • max: number | undefined

      defines maximum clamping value (default is 1)

    • result: Color4

      defines color to store the result into.

    Returns Color4

    the current Color4

cloneSearch playground for clone

  • Creates a new Color4 copied from the current one

    Returns Color4

    a new Color4 object

copyFromSearch playground for copyFrom

  • Copies the given Color4 values into the current one

    Parameters

    • source: Color4

      defines the source Color4 object

    Returns Color4

    the current updated Color4 object

copyFromFloatsSearch playground for copyFromFloats

  • copyFromFloats(r: number, g: number, b: number, a: number): Color4

  • Copies the given float values into the current one

    Parameters

    • r: number

      defines the red component to read from

    • g: number

      defines the green component to read from

    • b: number

      defines the blue component to read from

    • a: number

      defines the alpha component to read from

    Returns Color4

    the current updated Color4 object

equalsSearch playground for equals

  • Determines equality between Color4 objects

    Parameters

    Returns boolean

    true if the rgba values are equal to the given ones

fromArraySearch playground for fromArray

  • Update the current color with values stored in an array from the starting index of the given array

    Parameters

    • array: DeepImmutable<ArrayLike<number>>

      defines the source array

    • Optional offset: number

      defines an offset in the source array

    Returns Color4

    the current Color4 object

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Returns the string "Color4"

    Returns string

    "Color4"

getHashCodeSearch playground for getHashCode

  • getHashCode(): number

  • Compute the Color4 hash code

    Returns number

    an unique number that can be used to hash Color4 objects

multiplySearch playground for multiply

  • Multiply an Color4 value by another and return a new Color4 object

    Parameters

    • color: Color4

      defines the Color4 value to multiply by

    Returns Color4

    a new Color4 object

multiplyToRefSearch playground for multiplyToRef

  • Multiply a Color4 value by another and push the result in a reference value

    Parameters

    • color: Color4

      defines the Color4 value to multiply by

    • result: Color4

      defines the Color4 to fill the result in

    Returns Color4

    the result Color4

scaleSearch playground for scale

  • scale(scale: number): Color4

  • Creates a new Color4 with the current Color4 values multiplied by scale

    Parameters

    • scale: number

      defines the scaling factor to apply

    Returns Color4

    a new Color4 object

scaleAndAddToRefSearch playground for scaleAndAddToRef

  • Scale the current Color4 values by a factor and add the result to a given Color4

    Parameters

    • scale: number

      defines the scale factor

    • result: Color4

      defines the Color4 object where to store the result

    Returns Color4

    the unmodified current Color4

scaleToRefSearch playground for scaleToRef

  • Multiplies the current Color4 values by scale and stores the result in "result"

    Parameters

    • scale: number

      defines the scaling factor to apply

    • result: Color4

      defines the Color4 object where to store the result

    Returns Color4

    the current unmodified Color4

setSearch playground for set

  • set(r: number, g: number, b: number, a: number): Color4

  • Copies the given float values into the current one

    Parameters

    • r: number

      defines the red component to read from

    • g: number

      defines the green component to read from

    • b: number

      defines the blue component to read from

    • a: number

      defines the alpha component to read from

    Returns Color4

    the current updated Color4 object

subtractSearch playground for subtract

  • Creates a new Color4 set with the subtracted values of the given one from the current Color4

    Parameters

    Returns Color4

    a new Color4 object

subtractToRefSearch playground for subtractToRef

  • Subtracts the given ones from the current Color4 values and stores the results in "result"

    Parameters

    Returns Color4

    the current Color4 object

toArraySearch playground for toArray

  • Stores from the starting index in the given array the Color4 successive values

    Parameters

    • array: FloatArray

      defines the array where to store the r,g,b components

    • Optional index: number

      defines an optional index in the target array to define where to start storing values

    Returns Color4

    the current Color4 object

toGammaSpaceSearch playground for toGammaSpace

  • Computes a new Color4 converted from the current one to gamma space

    Returns Color4

    a new Color4 object

toGammaSpaceToRefSearch playground for toGammaSpaceToRef

  • Converts the Color4 values to gamma space and stores the result in "convertedColor"

    Parameters

    • convertedColor: Color4

      defines the Color4 object where to store the gamma space version

    Returns Color4

    the unmodified Color4

toHexStringSearch playground for toHexString

  • toHexString(returnAsColor3?: boolean): string

  • Compute the Color4 hexadecimal code as a string

    Parameters

    • Optional returnAsColor3: boolean

      defines if the string should only contains RGB values (off by default)

    Returns string

    a string containing the hexadecimal representation of the Color4 object

toLinearSpaceSearch playground for toLinearSpace

  • Computes a new Color4 converted from the current one to linear space

    Returns Color4

    a new Color4 object

toLinearSpaceToRefSearch playground for toLinearSpaceToRef

  • Converts the Color4 values to linear space and stores the result in "convertedColor"

    Parameters

    • convertedColor: Color4

      defines the Color4 object where to store the linear space version

    Returns Color4

    the unmodified Color4

toStringSearch playground for toString

  • toString(): string

  • Creates a string with the Color4 current values

    Returns string

    the string representation of the Color4 object

Static CheckColors4Search playground for CheckColors4

  • CheckColors4(colors: number[], count: number): number[]

  • Check the content of a given array and convert it to an array containing RGBA data If the original array was already containing count * 4 values then it is returned directly

    Parameters

    • colors: number[]

      defines the array to check

    • count: number

      defines the number of RGBA data to expect

    Returns number[]

    an array containing count * 4 values (RGBA)

Static FromArraySearch playground for FromArray

  • Creates a new Color4 from the starting index element of the given array

    Parameters

    • array: DeepImmutable<ArrayLike<number>>

      defines the source array to read from

    • Optional offset: number

      defines the offset in the source array

    Returns Color4

    a new Color4 object

Static FromArrayToRefSearch playground for FromArrayToRef

  • FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void

  • Creates a new Color4 from the starting index element of the given array

    Parameters

    • array: DeepImmutable<ArrayLike<number>>

      defines the source array to read from

    • offset: number | undefined

      defines the offset in the source array

    • result: Color4

      defines the target Color4 object

    Returns void

Static FromColor3Search playground for FromColor3

  • Creates a new Color4 from a Color3 and an alpha value

    Parameters

    • color3: DeepImmutable<Color3>

      defines the source Color3 to read from

    • Optional alpha: number

      defines the alpha component (1.0 by default)

    Returns Color4

    a new Color4 object

Static FromHexStringSearch playground for FromHexString

  • FromHexString(hex: string): Color4

  • Creates a new Color4 from the string containing valid hexadecimal values.

    A valid hex string is either in the format #RRGGBB or #RRGGBBAA.

    When a hex string without alpha is passed, the resulting Color4 has its alpha value set to 1.0.

    An invalid string results in a Color with all its channels set to 0.0, i.e. "transparent black".

    Parameters

    • hex: string

      defines a string containing valid hexadecimal values

    Returns Color4

    a new Color4 object

Static FromIntsSearch playground for FromInts

  • FromInts(r: number, g: number, b: number, a: number): Color4

  • Creates a new Color3 from integer values (< 256)

    Parameters

    • r: number

      defines the red component to read from (value between 0 and 255)

    • g: number

      defines the green component to read from (value between 0 and 255)

    • b: number

      defines the blue component to read from (value between 0 and 255)

    • a: number

      defines the alpha component to read from (value between 0 and 255)

    Returns Color4

    a new Color3 object

Static HermiteSearch playground for Hermite

  • Interpolate between two Color4 using Hermite interpolation

    Parameters

    Returns Color4

    the new interpolated Color4

Static Hermite1stDerivativeSearch playground for Hermite1stDerivative

  • Returns a new Color4 which is the 1st derivative of the Hermite spline defined by the colors "value1", "value2", "tangent1", "tangent2".

    Parameters

    Returns Color4

    1st derivative

Static Hermite1stDerivativeToRefSearch playground for Hermite1stDerivativeToRef

  • Update a Color4 with the 1st derivative of the Hermite spline defined by the colors "value1", "value2", "tangent1", "tangent2".

    Parameters

    Returns void

Static LerpSearch playground for Lerp

  • Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object

    Parameters

    Returns Color4

    a new Color4 object

Static LerpToRefSearch playground for LerpToRef

  • Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object

    Parameters

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method