Module Geyser.Color

Geyser color functions.

Info:

  • Author: guy

Functions

Geyser.Color.applyColors (cons) Applies colors to a window drawing from defaults and overridden values.
Geyser.Color.find_color_name (color) Searches for a close match to 'color' in the color_table Returns the color found, or false if it can't find one
Geyser.Color.hdec (r, g, b) Converts color to 3 decimal values as a string, no alpha, decho style
Geyser.Color.hdeca (r, g, b, a) Converts color to 4 decimal values as a string, with alpha, decho style
Geyser.Color.hex (r, g, b) Converts color to 3 hex values as a string, no alpha, css style
Geyser.Color.hexa (r, g, b, a) Converts color to 4 hex values as a string, with alpha, css style
Geyser.Color.hhex (r, g, b) Converts color to 3 hex values as a string, no alpha, hecho style
Geyser.Color.hhexa (r, g, b, a) Converts color to 4 hex values as a string, with alpha, hecho style
Geyser.Color.parse (red, green, blue, alpha) Returns 4 color components from (nearly any) acceptable format.


Functions

Geyser.Color.applyColors (cons)
Applies colors to a window drawing from defaults and overridden values.

Parameters:

  • cons The window to apply colors to
Geyser.Color.find_color_name (color)
Searches for a close match to 'color' in the color_table Returns the color found, or false if it can't find one

Parameters:

  • color the color name you're trying to find
Geyser.Color.hdec (r, g, b)
Converts color to 3 decimal values as a string, no alpha, decho style

Parameters:

  • r
  • g
  • b

Returns:

    The color formatted as a decho() style string
Geyser.Color.hdeca (r, g, b, a)
Converts color to 4 decimal values as a string, with alpha, decho style

Parameters:

  • r
  • g
  • b
  • a

Returns:

    The color formatted as a decho() style string
Geyser.Color.hex (r, g, b)
Converts color to 3 hex values as a string, no alpha, css style

Parameters:

  • r
  • g
  • b

Returns:

    The color formatted as a hex string, as accepted by html/css
Geyser.Color.hexa (r, g, b, a)
Converts color to 4 hex values as a string, with alpha, css style

Parameters:

  • r
  • g
  • b
  • a

Returns:

    The color formatted as a hex string, as accepted by html/css
Geyser.Color.hhex (r, g, b)
Converts color to 3 hex values as a string, no alpha, hecho style

Parameters:

  • r
  • g
  • b

Returns:

    The color formatted as a hex string, as accepted by hecho
Geyser.Color.hhexa (r, g, b, a)
Converts color to 4 hex values as a string, with alpha, hecho style

Parameters:

  • r
  • g
  • b
  • a

Returns:

    The color formatted as a hex string, as accepted by hecho
Geyser.Color.parse (red, green, blue, alpha)
Returns 4 color components from (nearly any) acceptable format. Colors can be specified in two ways. First: as a single word in english ("purple") or hex ("#AA00FF", "|cAA00FF", or "0xAA00FF") or decimal ("<190,0,255>"). If the hex or decimal representations contain a fourth element then alpha is set too - otherwise alpha can't be set this way. Second: by passing in distinct components as unsigned integers (e.g. 23 or 0xA7). When using the second way, at least three values must be passed. If only three are passed, then alpha is 255. Third: by passing in a table that has explicit values for some, all or none of the keys r,g,b, and a.

Parameters:

  • red Either a valid string representation or the red component.
  • green The green component.
  • blue The blue component.
  • alpha The alpha component.
generated by LDoc 1.5.0 Last updated 2024-04-26 00:56:21