Color3

Class used to hold a RBG color

Hierarchy

  • Color3

Index

Constructors

constructor

Find examples in Playground
  • new Color3(r?: number, g?: number, b?: number): Color3
  • Creates a new Color3 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)

    Returns Color3

Properties

b

Find examples in Playground
b: number

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

g

Find examples in Playground
g: number

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

r

Find examples in Playground
r: number

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

Methods

add

Find examples in Playground
  • Creates a new Color3 set with the added values of the current Color3 and of the given one

    Parameters

    Returns Color3

    the new Color3

addToRef

Find examples in Playground
  • Stores the result of the addition of the current Color3 and given one rgb values into "result"

    Parameters

    Returns Color3

    the unmodified current Color3

asArray

Find examples in Playground
  • asArray(): number[]
  • Returns a new array populated with 3 numeric elements : red, green and blue values

    Returns number[]

    the new array

clampToRef

Find examples in Playground
  • clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3
  • 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: Color3

      defines color to store the result into

    Returns Color3

    the original Color3

clone

Find examples in Playground
  • Copy the current object

    Returns Color3

    a new Color3 copied the current one

copyFrom

Find examples in Playground
  • Copies the rgb values from the source in the current Color3

    Parameters

    Returns Color3

    the updated Color3 object

copyFromFloats

Find examples in Playground
  • copyFromFloats(r: number, g: number, b: number): Color3
  • Updates the Color3 rgb values from the given floats

    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

    Returns Color3

    the current Color3 object

equals

Find examples in Playground
  • Determines equality between Color3 objects

    Parameters

    Returns boolean

    true if the rgb values are equal to the given ones

equalsFloats

Find examples in Playground
  • equalsFloats(r: number, g: number, b: number): boolean
  • Determines equality between the current Color3 object and a set of r,b,g values

    Parameters

    • r: number

      defines the red component to check

    • g: number

      defines the green component to check

    • b: number

      defines the blue component to check

    Returns boolean

    true if the rgb values are equal to the given ones

getClassName

Find examples in Playground
  • getClassName(): string
  • Returns the string "Color3"

    Returns string

    "Color3"

getHashCode

Find examples in Playground
  • getHashCode(): number
  • Compute the Color3 hash code

    Returns number

    an unique number that can be used to hash Color3 objects

multiply

Find examples in Playground
  • Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object

    Parameters

    Returns Color3

    the new Color3 object

multiplyToRef

Find examples in Playground
  • Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"

    Parameters

    • otherColor: DeepImmutable<Color3>

      defines the second operand

    • result: Color3

      defines the Color3 object where to store the result

    Returns Color3

    the current Color3

scale

Find examples in Playground
  • scale(scale: number): Color3
  • Multiplies in place each rgb value by scale

    Parameters

    • scale: number

      defines the scaling factor

    Returns Color3

    the updated Color3

scaleAndAddToRef

Find examples in Playground
  • Scale the current Color3 values by a factor and add the result to a given Color3

    Parameters

    • scale: number

      defines the scale factor

    • result: Color3

      defines color to store the result into

    Returns Color3

    the unmodified current Color3

scaleToRef

Find examples in Playground
  • Multiplies the rgb values by scale and stores the result into "result"

    Parameters

    • scale: number

      defines the scaling factor

    • result: Color3

      defines the Color3 object where to store the result

    Returns Color3

    the unmodified current Color3

set

Find examples in Playground
  • set(r: number, g: number, b: number): Color3
  • Updates the Color3 rgb values from the given floats

    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

    Returns Color3

    the current Color3 object

subtract

Find examples in Playground
  • Returns a new Color3 set with the subtracted values of the given one from the current Color3

    Parameters

    Returns Color3

    the new Color3

subtractToRef

Find examples in Playground
  • Stores the result of the subtraction of given one from the current Color3 rgb values into "result"

    Parameters

    Returns Color3

    the unmodified current Color3

toArray

Find examples in Playground
  • Stores in the given array from the given starting index the red, green, blue values as successive elements

    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 Color3

    the current Color3 object

toColor4

Find examples in Playground
  • toColor4(alpha?: number): Color4
  • Returns a new Color4 object from the current Color3 and the given alpha

    Parameters

    • Optional alpha: number

      defines the alpha component on the new Color4 object (default is 1)

    Returns Color4

    a new Color4 object

toGammaSpace

Find examples in Playground
  • Computes a new Color3 converted from the current one to gamma space

    Returns Color3

    a new Color3 object

toGammaSpaceToRef

Find examples in Playground
  • Converts the Color3 values to gamma space and stores the result in "convertedColor"

    Parameters

    • convertedColor: Color3

      defines the Color3 object where to store the gamma space version

    Returns Color3

    the unmodified Color3

toHexString

Find examples in Playground
  • toHexString(): string
  • Compute the Color3 hexadecimal code as a string

    Returns string

    a string containing the hexadecimal representation of the Color3 object

toLinearSpace

Find examples in Playground
  • Computes a new Color3 converted from the current one to linear space

    Returns Color3

    a new Color3 object

toLinearSpaceToRef

Find examples in Playground
  • Converts the Color3 values to linear space and stores the result in "convertedColor"

    Parameters

    • convertedColor: Color3

      defines the Color3 object where to store the linear space version

    Returns Color3

    the unmodified Color3

toLuminance

Find examples in Playground
  • toLuminance(): number
  • Returns the luminance value

    Returns number

    a float value

toString

Find examples in Playground
  • toString(): string
  • Creates a string with the Color3 current values

    Returns string

    the string representation of the Color3 object

Static Black

Find examples in Playground
  • Returns a Color3 value containing a black color

    Returns Color3

    a new Color3 object

Static Blue

Find examples in Playground
  • Returns a Color3 value containing a blue color

    Returns Color3

    a new Color3 object

Static FromArray

Find examples in Playground
  • Creates a new Vector3 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 Color3

    a new Color3 object

Static FromHexString

Find examples in Playground
  • FromHexString(hex: string): Color3
  • Creates a new Color3 from the string containing valid hexadecimal values

    Parameters

    • hex: string

      defines a string containing valid hexadecimal values

    Returns Color3

    a new Color3 object

Static FromInts

Find examples in Playground
  • FromInts(r: number, g: number, b: number): Color3
  • 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)

    Returns Color3

    a new Color3 object

Static Gray

Find examples in Playground
  • Returns a Color3 value containing a gray color

    Returns Color3

    a new Color3 object

Static Green

Find examples in Playground
  • Returns a Color3 value containing a green color

    Returns Color3

    a new Color3 object

Static Lerp

Find examples in Playground
  • Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3

    Parameters

    Returns Color3

    a new Color3 object

Static LerpToRef

Find examples in Playground
  • Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3

    Parameters

    Returns void

Static Magenta

Find examples in Playground
  • Returns a Color3 value containing a magenta color

    Returns Color3

    a new Color3 object

Static Purple

Find examples in Playground
  • Returns a Color3 value containing a purple color

    Returns Color3

    a new Color3 object

Static Random

Find examples in Playground
  • Returns a Color3 value containing a random color

    Returns Color3

    a new Color3 object

Static Red

Find examples in Playground
  • Returns a Color3 value containing a red color

    Returns Color3

    a new Color3 object

Static Teal

Find examples in Playground
  • Returns a Color3 value containing a teal color

    Returns Color3

    a new Color3 object

Static White

Find examples in Playground
  • Returns a Color3 value containing a white color

    Returns Color3

    a new Color3 object

Static Yellow

Find examples in Playground
  • Returns a Color3 value containing a yellow color

    Returns Color3

    a new Color3 object

Generated using TypeDoc