Cogl-18 ▶ Cogl ▶ Color

constructor

• new Color(
      properties?: Partial<
          { alpha: number; blue: number; green: number; red: number },
      >,
  ): Cogl.Color

  Parameters

  • Optionalproperties: Partial<{ alpha: number; blue: number; green: number; red: number }>

  Returns Cogl.Color

alpha

blue

green

red

Static$gtype

copy

• copy(): Cogl.Color

  Creates a copy of color

  Returns Cogl.Color

  a newly-allocated Cogl.Color. Use cogl_color_free() to free the allocate resources

equal

• equal(v2: Cogl.Color): boolean

  Compares two Cogl.Colors and checks if they are the same.

  This function can be passed to g_hash_table_new() as the key_equal_func parameter, when using Cogl.Colors as keys in a GLib.HashTable.

  Parameters

  • v2: Cogl.Color

    a Cogl.Color

  Returns boolean

  true if the two colors are the same.

free

• free(): void

  Frees the resources allocated by cogl_color_new() and cogl_color_copy()

  Returns void

get_alpha

• get_alpha(): number

  Retrieves the alpha channel of color as a fixed point value between 0 and 1.0.

  Returns number

  the alpha channel of the passed color

get_blue

• get_blue(): number

  Retrieves the blue channel of color as a fixed point value between 0 and 1.0.

  Returns number

  the blue channel of the passed color

get_green

• get_green(): number

  Retrieves the green channel of color as a fixed point value between 0 and 1.0.

  Returns number

  the green channel of the passed color

get_red

• get_red(): number

  Retrieves the red channel of color as a fixed point value between 0 and 1.0.

  Returns number

  the red channel of the passed color

hash

• hash(): number

  Converts a Cogl.Color to a hash value.

  This function can be passed to g_hash_table_new() as the hash_func parameter, when using Cogl.Colors as keys in a GLib.HashTable.

  Returns number

  a hash value corresponding to the color

init_from_4f

• init_from_4f(red: number, green: number, blue: number, alpha: number): void

  Sets the values of the passed channels into a Cogl.Color

  Parameters

  • red: number

    value of the red channel, between 0 and 1.0

  • green: number

    value of the green channel, between 0 and 1.0

  • blue: number

    value of the blue channel, between 0 and 1.0

  • alpha: number

    value of the alpha channel, between 0 and 1.0

  Returns void

premultiply

• premultiply(): void

  Converts a non-premultiplied color to a pre-multiplied color. For example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied and (0.5, 0, 0, 0.5) when premultiplied.

  Returns void

to_hsl

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

  Converts color to the HLS format.

  The hue value is in the 0 .. 360 range. The luminance and saturation values are in the 0 .. 1 range.

  Returns [number, number, number]

to_string

• to_string(): string

  Returns a textual specification of color in the hexadecimal form #rrggbbaa, where r, g, b and a are hexadecimal digits representing the red, green, blue and alpha components respectively.

  Returns string

  a newly-allocated text string

Staticfrom_string

• from_string(str: string): [boolean, Cogl.Color]

  Parses a string definition of a color, filling the Cogl.Color.red, Cogl.Color.green, Cogl.Color.blue and Cogl.Color.alpha fields of color.

  The color is not allocated.

  The format of str can be either one of:

  • an hexadecimal value in the form: #rgb, #rrggbb, #rgba, or #rrggbbaa
  • a RGB color in the form: rgb(r, g, b)
  • a RGB color in the form: rgba(r, g, b, a)
  • a HSL color in the form: hsl(h, s, l) -a HSL color in the form: hsla(h, s, l, a)

  where 'r', 'g', 'b' and 'a' are (respectively) the red, green, blue color intensities and the opacity. The 'h', 's' and 'l' are (respectively) the hue, saturation and luminance values.

  In the rgb() and rgba() formats, the 'r', 'g', and 'b' values are either integers between 0 and 255, or percentage values in the range between 0% and 100%; the percentages require the '%' character. The 'a' value, if specified, can only be a floating point value between 0.0 and 1.0.

  In the hls() and hlsa() formats, the 'h' value (hue) is an angle between 0 and 360.0 degrees; the 'l' and 's' values (luminance and saturation) are percentage values in the range between 0% and 100%. The 'a' value, if specified, can only be a floating point value between 0.0 and 1.0.

  Whitespace inside the definitions is ignored; no leading whitespace is allowed.

  If the alpha component is not specified then it is assumed to be set to be fully opaque.

  Parameters

  • str: string

    a string specifying a color

  Returns [boolean, Cogl.Color]

Staticinit_from_hsl

• init_from_hsl(hue: number, saturation: number, luminance: number): Cogl.Color

  Converts a color expressed in HLS (hue, luminance and saturation) values into a Cogl.Color.

  Parameters

  • hue: number

    hue value, in the 0 .. 360 range

  • saturation: number

    saturation value, in the 0 .. 1 range

  • luminance: number

    luminance value, in the 0 .. 1 range

  Returns Cogl.Color