Class RGBColorSpace

Convenience class for RGB color spaces

Hierarchy (view full)

Constructors

constructor

Properties

aliases? base bases coords displaySpaces? formats fromBase? gamutSpace id linearGamut? name referred? rgbGamut? toBase? white DEFAULT_FORMAT registry

Accessors

cssId isPolar isUnbounded all

Methods

equals from getFormat getMinCoords inGamut to toString findFormat get register resolveCoord

Constructors

constructor

  • new RGBColorSpace(options): RGBColorSpace

  • Creates a new RGB ColorSpace. If coords are not specified, they will use the default RGB coords. Instead of fromBase() and toBase() functions, you can specify to/from XYZ matrices and have toBase() and fromBase() automatically generated.

    Parameters

    Returns RGBColorSpace

Properties

Optionalaliases

aliases?: string[]

base

base: Space

bases

bases: Space[]

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

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>

OptionalfromBase

fromBase?: ((coords: Coords) => Coords)

gamutSpace

gamutSpace: Space

id

id: string

OptionallinearGamut

linearGamut?: RGBColorSpace

name

name: string

Optionalreferred

referred?: string

OptionalrgbGamut

rgbGamut?: RGBColorSpace

OptionaltoBase

toBase?: ((coords: Coords) => Coords)

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

getFormat

getMinCoords

inGamut

  • inGamut(coords, options?): boolean

  • Parameters

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

    Returns boolean

to

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