Color - Verge3D User Manual - Soft8Soft
Description: Learn how to use Color in your interactive 3D apps made with Verge3D

# Color

Class representing a color value (RGB).

Iterating through a Color instance will yield its components `(r, g, b)` in the corresponding order.

## Code Examples

A Color can be initialised in any of the following ways:

`// empty constructor - will default white const color1 = new v3d.Color(); // hexadecimal color (recommended) const color2 = new v3d.Color(0xff0000); // RGB string const color3 = new v3d.Color("rgb(255, 0, 0)"); const color4 = new v3d.Color("rgb(100%, 0%, 0%)"); // CSS color name - all 140 color names are supported const color5 = new v3d.Color('skyblue'); // HSL string const color6 = new v3d.Color("hsl(0, 100%, 50%)"); // separate RGB values between 0 and 1 const color7 = new v3d.Color(1, 0, 0);`

## Constructor

### Color(r : Float | Color | Integer | String, g : Float, b : Float)

- r — (optional) If arguments g and b are defined, the red component of the color. If they are not defined, it can be a hexadecimal triplet (recommended), a CSS-style string, or another Color instance.
- g — (optional) If it is defined, the green component of the color.
- b — (optional) If it is defined, the blue component of the color.

Note that standard method of specifying color in Verge3D is with a hexadecimal triplet, and that method is used throughout the rest of the documentation.

When all arguments are defined then r is the red component, g is the green component and b is the blue component of the color.

When only r is defined:

- It can be a hexadecimal triplet representing the color (recommended).
- It can be an another Color instance.
- It can be a CSS-style string. For example:
  - `'rgb(250, 0,0)'`
  - `'rgb(100%,0%,0%)'`
  - `'hsl(0, 100%, 50%)'`
  - `'#ff0000'`
  - `'#f00'`
  - `'red'`

## Properties

### # .isColor : Boolean

Read-only flag to check if a given object is of type Color.

### # .r : Float

Red channel value between `0` and `1`. Default is `1`.

### # .g : Float

Green channel value between `0` and `1`. Default is `1`.

### # .b : Float

Blue channel value between `0` and `1`. Default is `1`.

## Methods

### # .add(color : Color) → this

Adds the RGB values of color to the RGB values of this color.

### # .addColors(color1 : Color, color2 : Color) → this

Sets this color's RGB values to the sum of the RGB values of color1 and color2.

### # .addScalar(s : Float) → this

Adds s to the RGB values of this color.

### # .clone() → Color

Returns a new Color with the same r, g and b values as this one.

### # .copy(color : Color) → this

Copies the r, g and b parameters from color in to this color.

### # .convertLinearToSRGB() → this

Converts this color from linear space to sRGB space.

### # .convertSRGBToLinear() → this

Converts this color from sRGB space to linear space.

### # .copyLinearToSRGB(color : Color) → this

color — Color to copy.

Copies the given color into this color, and then converts this color from linear space to sRGB space.

### # .copySRGBToLinear(color : Color) → this

color — Color to copy.

Copies the given color into this color, and then converts this color from sRGB space to linear space.

### # .equals(color : Color) → Boolean

Compares the RGB values of color with those of this object. Returns true if they are the same, false otherwise.

### # .fromArray(array : Array, offset : Integer) → this

- array — Array of floats in the form [r, g, b].
- offset — An optional offset into the array.

Sets this color's components based on an array formatted like [r, g, b].

### # .fromBufferAttribute(attribute : BufferAttribute, index : Integer) → this

- attribute — the source attribute.
- index — index in the attribute.

Sets this color's components from the attribute.

### # .getHex(colorSpace : String = SRGBColorSpace) → Integer

Returns the hexadecimal value of this color.

### # .getHexString(colorSpace : String = SRGBColorSpace) → String

Returns the hexadecimal value of this color as a string (for example, `'FFFFFF'`).

### # .getHSL(target : Object, colorSpace : String = LinearSRGBColorSpace) → Object

target — the result will be copied into this Object. Adds h, s and l keys to the object (if not already present).

Convert this Color's r, g and b values to HSL format and returns an object of the form:

`{ h: 0, s: 0, l: 0 }`

### # .getStyle(colorSpace : String = SRGBColorSpace) → String

Returns the value of this color as a CSS style string. Example: `rgb(255,0,0)`.

### # .lerp(color : Color, alpha : Float) → this

- color — color to converge on.
- alpha — interpolation factor in the closed interval `[0, 1]`.

Linearly interpolates this color's RGB values toward the RGB values of the passed argument. The alpha argument can be thought of as the ratio between the two colors, where `0.0` is this color and `1.0` is the first argument.

### # .lerpColors(color1 : Color, color2 : Color, alpha : Float) → this

- color1 — the starting Color.
- color2 — Color to interpolate towards.
- alpha — interpolation factor, typically in the closed interval `[0, 1]`.

Sets this color to be the color linearly interpolated between color1 and color2 where `alpha` is the percent distance along the line connecting the two colors - alpha = 0 will be color1, and alpha = 1 will be color2.

### # .lerpHSL(color : Color, alpha : Float) → this

- color — color to converge on.
- alpha — interpolation factor in the closed interval `[0, 1]`.

Linearly interpolates this color's HSL values toward the HSL values of the passed argument. It differs from the classic .lerp by not interpolating straight from one color to the other, but instead going through all the hues in between those two colors. The alpha argument can be thought of as the ratio between the two colors, where 0.0 is this color and 1.0 is the first argument.

### # .multiply(color : Color) → this

Multiplies this color's RGB values by the given color's RGB values.

### # .multiplyScalar(s : Float) → this

Multiplies this color's RGB values by s.

### # .offsetHSL(h : Float, s : Float, l : Float) → this

Adds the given h, s, and l to this color's values. Internally, this converts the color's r, g and b values to HSL, adds h, s, and l, and then converts the color back to RGB.

### # .set(value : Color | Integer | String) → this

value — Value to set this color to.

See the Constructor above for full details of what value can be. Delegates to .copy, .setStyle, or .setHex depending on input type.

### # .setHex(hex : Integer, colorSpace : String = SRGBColorSpace) → this

hex — hexadecimal triplet format.

Sets this color from a hexadecimal value.

### # .setHSL(h : Float, s : Float, l : Float, colorSpace : String = LinearSRGBColorSpace) → this

- h — hue value between 0.0 and 1.0.
- s — saturation value between 0.0 and 1.0.
- l — lightness value between 0.0 and 1.0.

Sets color from HSL values.

### # .setRGB(r : Float, g : Float, b : Float, colorSpace : String = LinearSRGBColorSpace) → this

- r — red channel value between 0.0 and 1.0.
- g — green channel value between 0.0 and 1.0.
- b — blue channel value between 0.0 and 1.0.

Sets this color from RGB values.

### # .setScalar(scalar : Float) → this

scalar — a value between 0.0 and 1.0.

Sets all three color components to the value scalar.

### # .setStyle(style : String, colorSpace : String = SRGBColorSpace) → this

style — color as a CSS-style string.

Sets this color from a CSS-style string. For example:

- `"rgb(250, 0,0)"`
- `"rgb(100%, 0%, 0%)"`
- `"hsl(0, 100%, 50%)"`
- `"#ff0000"`
- `"#f00"`
- `"red"`

or any X11 color name — all 140 color names are supported.

Translucent colors such as `"rgba(255, 0, 0, 0.5)"` and `"hsla(0, 100%, 50%, 0.5)"` are also accepted, but the alpha-channel coordinate will be discarded.

Note that for X11 color names, multiple words such as Dark Orange become the string `'darkorange'`.

### # .setColorName(style : String, colorSpace : String = SRGBColorSpace) → this

style — color name (from X11 color names).

Sets this color from a color name. Faster than .setStyle method if you don't need the other CSS-style formats.

For convenience, the list of names is exposed in Color.NAMES as a hash:

`Color.NAMES.aliceblue // returns 0xF0F8FF`

### # .sub(color : Color) → this

Subtracts the RGB components of the given color from the RGB components of this color. If this results in a negative component, that component is set to zero.

### # .toArray(array : Array, offset : Integer) → Array

- array — an optional array to store the color to.
- offset — an optional offset into the array.

Returns an array of the form [r, g, b].

## Source

For more info on how to obtain the source code of this module see this page.