Represents an RGB color with red, green, and blue components. Extends Vector3 to provide mathematical operations on color values. Each component is stored as a floating-point value, typically in the range [0, 1].

const red = new ColorRgb(new Float32Array([1, 0, 0]));
const green = ColorRgb.add(red, new ColorRgb(new Float32Array([0, 1, 0])));

Hierarchy (view full)

Implements

Constructors

Properties

_v: TypedArray = ...

Internal typed array storage for vector components

Accessors

  • get bytesPerComponent(): number
  • Gets the number of bytes per component.

    Returns number

    The number of bytes per component (4 for Float32Array, 8 for Float64Array)

  • get glslStrAsFloat(): string
  • Gets the GLSL representation of this vector as a float vec3.

    Returns string

    A string representation suitable for GLSL shaders

  • get glslStrAsInt(): string
  • Gets the GLSL representation of this vector as an integer ivec3.

    Returns string

    A string representation suitable for GLSL shaders with integer components

  • get w(): number
  • Gets the W component of the color (always 1 for RGB colors).

    Returns number

    Always returns 1

  • get wgslStrAsFloat(): string
  • Gets the WGSL representation of this vector as a float vec3f.

    Returns string

    A string representation suitable for WGSL shaders

  • get wgslStrAsInt(): string
  • Gets the WGSL representation of this vector as an integer vec3i.

    Returns string

    A string representation suitable for WGSL shaders with integer components

  • get x(): number
  • Gets the X component of the color (equivalent to red component).

    Returns number

    The X/red component value

  • get y(): number
  • Gets the Y component of the color (equivalent to green component).

    Returns number

    The Y/green component value

  • get z(): number
  • Gets the Z component of the color (equivalent to blue component).

    Returns number

    The Z/blue component value

  • get compositionType(): CompositionTypeClass<"VEC3">
  • Gets the composition type for this vector class.

    Returns CompositionTypeClass<"VEC3">

    The composition type (Vec3)

Methods

  • Gets the component at the specified index.

    Parameters

    • i: number

      The index (0 for x, 1 for y, 2 for z)

    Returns number

    The component value at the specified index

  • Checks if this vector is approximately equal to another vector within a tolerance.

    Parameters

    • vec: IVector3

      The vector to compare with

    • delta: number = Number.EPSILON

      The tolerance for comparison (default: Number.EPSILON)

    Returns boolean

    True if vectors are approximately equal, false otherwise

  • Checks if the internal storage shares the same ArrayBuffer as the provided one. Useful for determining if vectors share underlying memory.

    Parameters

    • arrayBuffer: ArrayBuffer

      The ArrayBuffer to compare against

    Returns boolean

    True if the same ArrayBuffer is used, false otherwise

  • Gets the component value at the specified index. Alias for the at() method for convenience.

    Parameters

    • i: number

      The index of the component to retrieve

    Returns number

    The component value at the given index

  • Calculates the angle between two vectors in radians.

    Parameters

    Returns number

    The angle between the vectors in radians

    Error if either vector has zero length

  • Computes the cross product of two color vectors. Note: Cross product for colors is rarely used but available for completeness.

    Parameters

    • l_vec: IVector3

      The left operand color vector

    • r_vec: IVector3

      The right operand color vector

    Returns ColorRgb

    A new ColorRgb instance representing the cross product

  • Calculates the squared length of a vector (static version). This is more efficient than calculating the actual length when only comparison is needed.

    Parameters

    • vec: IVector3

      The vector to calculate squared length for

    Returns number

    The squared length of the vector