Class RGB

constructor

• new RGB(r: number, g: number, b: number, a?: number): RGB

  Creates an instance of RGB.

  Parameters

  • r: number

    Red component (0-255).
  • g: number

    Green component (0-255).
  • b: number

    Blue component (0-255).
  • a: number = 1

    Alpha component (0-1), defaults to 1.

  Returns RGB

asArray

• asArray(): [number, number, number, number]

  Returns the RGB color as an array.

  Returns [number, number, number, number]

  An array containing the red, green, blue, and alpha components.

asHex

• asHex(): string

  Returns the RGB color as a hexadecimal string.

  Returns string

  A string representation of the RGB color in hexadecimal format.

asHSL

• asHSL(): HSL

  Converts the RGB color to an HSL color.

  Returns HSL

  An HSL instance representing the same color.

asHSV

• asHSV(): HSV

  Converts the RGB color to an HSV color.

  Returns HSV

  An HSV instance representing the same color.

asRGB

• asRGB(): RGB

  Returns the RGB color.

  Returns RGB

  The current RGB instance.

asString

• asString(): string

  Returns the RGB color as a string.

  Returns string

  A string representation of the RGB color in either rgb or rgba format.

blend

• blend(value: number, blendColor: Color): RGB

  Blends the RGB color with another color.

  Parameters

  • value: number

    The blend value to apply.
  • blendColor: Color

    The color to blend with.

  Returns RGB

  A new RGB instance with the blended color.

brightness

• brightness(value: number): RGB

  Adjusts the brightness of the RGB color.

  Parameters

  • value: number

    The brightness value to apply.

  Returns RGB

  A new RGB instance with the adjusted brightness.

clone

• clone(): RGB

  Creates a clone of the current RGB color.

  Returns RGB

  A new RGB instance with the same color values.

contrast

• contrast(value: number): RGB

  Adjusts the contrast of the RGB color.

  Parameters

  • value: number

    The contrast value to apply.

  Returns RGB

  A new RGB instance with the adjusted contrast.

darken

• darken(ratio: number): RGB

  Darkens the RGB color.

  Parameters

  • ratio: number

    The ratio to darken the color by.

  Returns RGB

  A new RGB instance with the darkened color.

fade

• fade(value: number): RGB

  Fades the RGB color by reducing its alpha value.

  Parameters

  • value: number

    The fade value to apply.

  Returns RGB

  A new RGB instance with the faded color.

gamma

• gamma(value: number): RGB

  Adjusts the gamma of the RGB color.

  Parameters

  • value: number

    The gamma value to apply.

  Returns RGB

  A new RGB instance with the adjusted gamma.

invert

• invert(): RGB

  Inverts the RGB color.

  Returns RGB

  A new RGB instance with the inverted color values.

lighten

• lighten(ratio: number): RGB

  Lightens the RGB color.

  Parameters

  • ratio: number

    The ratio to lighten the color by.

  Returns RGB

  A new RGB instance with the lightened color.

round

• round(): RGB

  Rounds the RGB color components to the nearest integer.

  Returns RGB

  A new RGB instance with rounded color values.

tint

• tint(value: number, tintColor: Color): RGB

  Tints the RGB color with another color.

  Parameters

  • value: number

    The tint value to apply.
  • tintColor: Color

    The color to use for tinting.

  Returns RGB

  A new RGB instance with the applied tint.

toRGB

• toRGB(): RGB

  Returns the RGB color.

  Returns RGB

  The current RGB instance.

Staticparse

• parse(input: string | Color): RGB

  Parses a string or Color instance into an RGB color.

  Parameters

  • input: string | Color

    The input string or Color instance to parse.

  Returns RGB

  A new RGB instance representing the parsed color.

  Throws

  Will throw an error if the input string is not a valid RGB color string.

Readonlya

Readonlyb

Readonlyg

Readonlyr