Class Color

Represents a color. See also ColorUtils.

see https://github.com/mrdoob/three.js/blob/master/src/math/Color.js|src/math/Color.js

Example

const color = new THREE.Color( 0xff0000 );

Hierarchy

Color

Index

Constructors

constructor

new Color(color?: ColorRepresentation): Color
Parameters
- Optional color: ColorRepresentation
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:29
new Color(r: number, g: number, b: number): Color
Parameters
- r: number
- g: number
- b: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:30

Properties

b

b: number

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

Default

g

g: number

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

Default

`Readonly` isColor

isColor: true

r

r: number

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

Default

`Static` NAMES

NAMES: Record<string, number>

List of X11 color names.

Methods

[iterator]

[iterator](): Generator<number, void, unknown>
Returns Generator<number, void, unknown>
- Defined in node_modules/@types/three/src/math/Color.d.ts:178

add

add(color: Color): Color
Parameters
- color: Color
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:142

addColors

addColors(color1: Color, color2: Color): Color
Parameters
- color1: Color
- color2: Color
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:143

addScalar

addScalar(s: number): Color
Parameters
- s: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:144

clone

clone(): Color
Clones this color.

Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:90

convertLinearToSRGB

convertLinearToSRGB(): Color
Converts this color from linear to sRGB space.

Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:118

convertSRGBToLinear

convertSRGBToLinear(): Color
Converts this color from sRGB to linear space.

Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:113

copy

copy(color: Color): Color
Copies given color.
Parameters
- color: Color
  
  Color to copy.
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:96

copyLinearToSRGB

copyLinearToSRGB(color: Color): Color
Copies given color making conversion from linear to sRGB space.
Parameters
- color: Color
  
  Color to copy.
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:108

copySRGBToLinear

copySRGBToLinear(color: Color): Color
Copies given color making conversion from sRGB to linear space.
Parameters
- color: Color
  
  Color to copy.
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:102

equals

equals(color: Color): boolean
Parameters
- color: Color
Returns boolean
- Defined in node_modules/@types/three/src/math/Color.d.ts:151

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): Color
Sets this color's red, green and blue value from the provided array or array-like.
Parameters
- array: number[] | ArrayLike<number>
  
  the source array or array-like.
- Optional offset: number
  
  (optional) offset into the array-like. Default is 0.
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:158

fromBufferAttribute

fromBufferAttribute(attribute: BufferAttribute, index: number): Color
Parameters
- attribute: BufferAttribute
- index: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:176

getHSL

getHSL(target: HSL, colorSpace?: ColorSpace): HSL
Parameters
- target: HSL
- Optional colorSpace: ColorSpace
Returns HSL
- Defined in node_modules/@types/three/src/math/Color.d.ts:130

getHex

getHex(colorSpace?: ColorSpace): number
Returns the hexadecimal value of this color.
Parameters
- Optional colorSpace: ColorSpace
Returns number
- Defined in node_modules/@types/three/src/math/Color.d.ts:123

getHexString

getHexString(colorSpace?: ColorSpace): string
Returns the string formated hexadecimal value of this color.
Parameters
- Optional colorSpace: ColorSpace
Returns string
- Defined in node_modules/@types/three/src/math/Color.d.ts:128

getRGB

getRGB(target: RGB, colorSpace?: ColorSpace): RGB
Parameters
- target: RGB
- Optional colorSpace: ColorSpace
Returns RGB
- Defined in node_modules/@types/three/src/math/Color.d.ts:132

getStyle

getStyle(colorSpace?: ColorSpace): string
Returns the value of this color in CSS context style. Example: rgb(r, g, b)
Parameters
- Optional colorSpace: ColorSpace
Returns string
- Defined in node_modules/@types/three/src/math/Color.d.ts:138

lerp

lerp(color: Color, alpha: number): Color
Parameters
- color: Color
- alpha: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:148

lerpColors

lerpColors(color1: Color, color2: Color, alpha: number): Color
Parameters
- color1: Color
- color2: Color
- alpha: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:149

lerpHSL

lerpHSL(color: Color, alpha: number): Color
Parameters
- color: Color
- alpha: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:150

multiply

multiply(color: Color): Color
Parameters
- color: Color
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:146

multiplyScalar

multiplyScalar(s: number): Color
Parameters
- s: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:147

offsetHSL

offsetHSL(h: number, s: number, l: number): Color
Parameters
- h: number
- s: number
- l: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:140

set

set(color: ColorRepresentation): Color
Parameters
- color: ColorRepresentation
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:52

setColorName

setColorName(style: string, colorSpace?: ColorSpace): Color
Sets this color from a color name. Faster than .setStyle() method if you don't need the other CSS-style formats.
Parameters
- style: string
  
  Color name in X11 format.
- Optional colorSpace: ColorSpace
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:85

setHSL

setHSL(h: number, s: number, l: number, colorSpace?: ColorSpace): Color
Sets this color from HSL values. Based on MochiKit implementation by Bob Ippolito.
Parameters
- h: number
  
  Hue channel value between 0 and 1.
- s: number
  
  Saturation value channel between 0 and 1.
- l: number
  
  Value channel value between 0 and 1.
- Optional colorSpace: ColorSpace
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:72

setHex

setHex(hex: number, colorSpace?: ColorSpace): Color
Parameters
- hex: number
- Optional colorSpace: ColorSpace
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:54

setRGB

setRGB(r: number, g: number, b: number, colorSpace?: ColorSpace): Color
Sets this color from RGB values.
Parameters
- r: number
  
  Red channel value between 0 and 1.
- g: number
  
  Green channel value between 0 and 1.
- b: number
  
  Blue channel value between 0 and 1.
- Optional colorSpace: ColorSpace
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:62

setScalar

setScalar(scalar: number): Color
Parameters
- scalar: number
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:53

setStyle

setStyle(style: string, colorSpace?: ColorSpace): Color
Sets this color from a CSS context style string.
Parameters
- style: string
- Optional colorSpace: ColorSpace
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:78

sub

sub(color: Color): Color
Parameters
- color: Color
Returns Color
- Defined in node_modules/@types/three/src/math/Color.d.ts:145

toArray

toArray(array?: number[], offset?: number): number[]
Returns an array [red, green, blue], or copies red, green and blue into the provided array.

Returns
The created or provided array.
Parameters
- Optional array: number[]
  
  (optional) array to store the color to. If this is not provided, a new array will be created.
- Optional offset: number
  
  (optional) optional offset into the array.
Returns number[]
- Defined in node_modules/@types/three/src/math/Color.d.ts:166
toArray(xyz: ArrayLike<number>, offset?: number): ArrayLike<number>
Copies red, green and blue into the provided array-like.

Returns
The provided array-like.
Parameters
- xyz: ArrayLike<number>
- Optional offset: number
  
  (optional) optional offset into the array-like.
Returns ArrayLike<number>
- Defined in node_modules/@types/three/src/math/Color.d.ts:174

Class Color

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional color: ColorRepresentation

Returns Color

Parameters

r: number

g: number

b: number

Returns Color

Properties

b

Default

g

Default

Readonly isColor

r

Default

Static NAMES

Methods

[iterator]

Returns Generator<number, void, unknown>

add

Parameters

color: Color

Returns Color

addColors

Parameters

color1: Color

color2: Color

Returns Color

addScalar

Parameters

s: number

Returns Color

clone

Returns Color

convertLinearToSRGB

Returns Color

convertSRGBToLinear

Returns Color

copy

Parameters

color: Color

Returns Color

copyLinearToSRGB

Parameters

color: Color

Returns Color

copySRGBToLinear

Parameters

color: Color

Returns Color

equals

Parameters

color: Color

Returns boolean

fromArray

Parameters

array: number[] | ArrayLike<number>

Optional offset: number

Returns Color

fromBufferAttribute

Parameters

attribute: BufferAttribute

index: number

Returns Color

getHSL

Parameters

target: HSL

Optional colorSpace: ColorSpace

Returns HSL

getHex

`Optional` color: ColorRepresentation

`Readonly` isColor

`Static` NAMES

`Optional` offset: number

`Optional` colorSpace: ColorSpace

`Optional` colorSpace: ColorSpace

`Optional` colorSpace: ColorSpace

`Optional` colorSpace: ColorSpace

`Optional` colorSpace: ColorSpace

`Optional` colorSpace: ColorSpace

`Optional` colorSpace: ColorSpace

`Optional` colorSpace: ColorSpace