Corky

• Index

Contents

• Functions
• Local Functions
• Local Tables

Modules

• corky
• corky.cache
• corky.cairo
• corky.circles
• corky.colors
• corky.config
• corky.conky
• corky.dcolors
• corky.hooks
• corky.include
• corky.lists
• corky.options
• corky.rects
• corky.text
• corky.utils
• corky.validator

Source

• corky.lua
• cache.lua
• cairo.lua
• circles.lua
• colors.lua
• config.lua
• conky.lua
• dcolors.lua
• hooks.lua
• include.lua
• lists.lua
• options.lua
• rects.lua
• text.lua
• utils.lua
• validator.lua

Module corky.colors

Color handling for Corky.

This module may be used to store and retrieve colors using custom names.

Loading the module:

#: include, corky.colors

Adding a named color:

These configuration directives will add the specified color to the color table. It may then be accessed by its name. In all the directives the <name> may be any arbitrary, non-empty string.

#: color, <name>, <red>, <green>, <blue>[, <alpha>]

The <red>, <green>, <blue> and <alpha> values specify the color. These must be floating point numbers between 0 and 1 (inclusive). The <alpha> parameter is optional, it defaults to 1 if omitted.

#: color, <name>, <rgb>[, <alpha>]

The <rgb> parameter specifies the color. It must be a valid number, usually the hexadecimal representation of the color (i.e. 0xRRGGBB). It may include the alpha value (ARGB format: 0xAARRGGBB). The alpha value may also be specified by an additional parameter, in that case it has to be a floating point number between 0 and 1 (inclusive). If no alpha value is specified at all, it defaults to 1. If an alpha value is specified via both parameters, the optional alpha parameter will override the alpha value of <rgb>. Note that to specify an alpha value of 0, it has to be supplied as the extra alpha parameter!

Info:

• Copyright: © 2015-2017 Stefan Göbel
• Release: 2017033001
• License: GPLv3
• Author: Stefan Göbel [⌂] [✉]

Functions

to_rgba (...)	Get the individual R, G, B and A channels for a specified color.
set (...)	Add a color to the color cache, or change an existing entry.
get (color)	Get a color from the cache.

Local Functions

config_handler (setting)

Configuration handler for color settings.

Local Tables

colors

Stores the user-defined colors.

Functions

to_rgba (...) line 98

Get the individual R, G, B and A channels for a specified color.

There are two ways to call this function:

• If called with one or two parameters, the first parameter will be treated as a number, defining the color. This is usually a hexadecimal representation in the form 0xRRGGBB (RGB) or 0xAARRGGBB (ARGB), though any value that can be converted to a valid number between 0 and 0xffffffff (inclusive) will work. The (optional) second parameter may be used to specify the alpha value, it must be a float between 0 and 1 (inclusive). If the first parameter includes an alpha value (i.e. if it is greater than 0x00ffffff, ARGB format), the second parameter will override it! Note that for an alpha value of zero you have to use the two parameter form! If there is no value specified for alpha, it defaults to 1.
• If called with three or four parameters, the first three parameters will be treated as the R, G and B channel values (in that order), and the fourth (optional) parameter as the alpha value. All values must be floats between 0 and 1 (inclusive). If alpha is omitted, it defaults to 1.

Note: All parameters will be validated, on error this function returns nil.

Parameters:

• ... See above for a description of the parameters.

Returns:

1. table An array containing the values for the red, green, blue and alpha channels, in that order. All values are floating point numbers between 0 and 1 (inclusive). Returns nil on error.

set (...) line 165

Add a color to the color cache, or change an existing entry.

This function may be used to add a named or unnamed color to the color cache, or change an existing color.

• If called with only one parameter, this parameter is assumed to be a single color specification (usually a hexadecimal string, but any value that can be converted to a valid integer between 0 and 0xffffffff will work). It will be processed by to_rgba() and added to the color cache, the key will be the color as it is specified (i.e. no conversion will be performed for the key, it may be a string or a number).
• If called with more than one parameter, the first parameter will be used as the name of the color, and all remaining parameters will be passed to to_rgba() to be processed, please see there for a description of possible values. The color will be added to the cache with the color name (first parameter) as the key.

Note: If the key already exists in the cache the existing entry will be overridden with the new color!

Parameters:

• ... See above for a description of the parameters.

Returns:

1. table Returns an array containing the values for the red, green, blue and alpha channels of the color, in that order. All values are floating point numbers between 0 and 1 (inclusive). Returns nil on error.

get (color) line 199

Get a color from the cache.

This function will return the cached color, i.e. an array containg the R, G, B and alpha values, if it exists in the color cache. If it does not exist, the specified name is assumed to be a color specification, usually a hexadecimal representation in RGB or ARGB format (any other value that can be converted to a valid number may be used though), and it is automatically converted to { <r>, <g>, <b>, <a> }, added to the cache and then returned. Note that the key to access it is the unaltered parameter value, that means that - for example - the two parameters 0xabcdef (a number) and "0xabcdef" (a string) will result in two cache entries, even though the color will be the same.

Parameters:

• color The name of the color or a color specification.

Returns:

1. table Returns an array containing the values for the red, green, blue and alpha channels of the requested color, in that order. All values are floats between 0 and 1 (inclusive). Returns nil on error.

Local Functions

config_handler (setting) line 222

Configuration handler for color settings.

This handler will be called automatically for every color directive in the configuration file.

Parameters:

• setting table Array containing the configuration directive split into its individual parts.

Returns:

1. bool If successful true, false in case of any error.

See also:

• corky

Local Tables

colors line 62

Stores the user-defined colors.

The keys are the names of the colors, or the numbers/strings supplied to get() for automatically added color entries. The values are tables with the color information {<R>, <G>, <B>, <A>}. Note that every color accessed with get() will be cached in the table!