Class GamutRelativeColorSpace

A color space whose chroma-like coordinate is expressed relative to an RGB gamut: chroma = 1 is the most colorful in-gamut color for the rest of the coordinates, so any chroma in [0, 1] stays in gamut. The reduced coordinate (chroma, default "c") is rescaled against gamutSpace; every other coordinate is inherited unchanged from base. Works for any base whose chroma coordinate brings the color into gamut as it is reduced (e.g. OKLCh, LCH).

Hierarchy (view full)

  • Space
    • GamutRelativeColorSpace

Constructors

constructor

Properties

aliases? base bases chromaIndex coords displaySpaces? formats gamutSpace id linearGamut? M method name oogChroma referred? rgbGamut? white DEFAULT_FORMAT registry

Accessors

cssId isPolar isUnbounded all

Methods

equals from fromBase getFormat getMinCoords inGamut maxChroma to toBase toString findFormat get register resolveCoord

Constructors

constructor

Properties

Optionalaliases

aliases?: string[]

base

base: Space

bases

bases: Space[]

This space's ancestors, ordered closest first (immediate base → root), excluding this space

chromaIndex

chromaIndex: number

coords

coords: Record<string, CoordMeta>

OptionaldisplaySpaces

displaySpaces?: Space[]

Spaces to try when serializing for display and this space is not natively supported

formats

formats: Record<string, SpaceFormat>

gamutSpace

gamutSpace: Space

id

id: string

OptionallinearGamut

linearGamut?: RGBColorSpace

M

M: Record<string, Matrix3x3>

Matrices relevant to this color space, keyed by a descriptive name

method

method: string

name

name: string

oogChroma

oogChroma: number

Optionalreferred

referred?: string

OptionalrgbGamut

rgbGamut?: RGBColorSpace

white

white: White

StaticDEFAULT_FORMAT

DEFAULT_FORMAT: {
    name: "color";
    type: "functions";
}

Staticregistry

registry: Record<string, Space>

Accessors

cssId

  • get cssId(): string

  • The ID used by CSS, such as display-p3 or --cam16-jmh

    Returns string

isPolar

  • get isPolar(): boolean

  • Returns boolean

isUnbounded

  • get isUnbounded(): boolean

  • Returns boolean

Staticall

Methods

equals

from

fromBase

getFormat

getMinCoords

inGamut

  • inGamut(coords, options?): boolean

  • Parameters

    • coords: Coords
    • Optionaloptions: {
          epsilon?: number;
      }
      • Optionalepsilon?: number

    Returns boolean

maxChroma

  • maxChroma(coords): number

  • The highest in-gamut value of the reduced coordinate for the given coordinates. The reduced coordinate's own value is ignored; the others determine the result.

    Parameters

    • coords: number[]

    Returns number

to

toBase

toString

StaticfindFormat

Staticget

Staticregister

StaticresolveCoord

  • resolveCoord(ref, workingSpace?): CoordMeta & {
        id: string;
        index: number;
        space: Space;
    }

  • Parameters

    • ref: Ref
    • OptionalworkingSpace: string | Space

    Returns CoordMeta & {
        id: string;
        index: number;
        space: Space;
    }

    Throws

    If no space or an unknown space is provided

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods