taprisiot / jlk.colour

A simple colour library for Common LIsp.

jlk.colour

A simple colour library for Common Lisp.

Usage

First call function set-internal-colour-format to match the usage within your applicaiton or use internal-colour-format as a dynamic variable.

Then call function set-default-palette or use *default-palette* as a dynamic binding, providing a palette as an argument. A palette can be created using the make-palette function - see make-simple-palette, make-html4-palette and make-web-palette for examples.

Define an index by calling set-default-index and make-index.

reset-defaults can be used to set somewhat sane default values.

Colour names are defined using case-sensitive keywords. Lower case names are used, with an alias automatically created to the camel-case synonym.

To get a colour from the library, use get-colour. Note this will return the value specified in the palette as :default-colour when not found, or nil if undefined.

To search for a colour in the library, use find-colour.

To create a new colour use defcolour or use the make-colour-* functions. It is assumed you know the type of the input data when you make a colour, so * refers to the input format. You will also need to re-create the index using make-index after defining new colours.

To define a new type of internal colour format, define the methods for conversion -make-colour-*-* from the data type of interest to the custom format. See examples.lisp.

Licence

BSD 3-Clause, see LICENCE file in the repository