From 7f7a2ece327a07c4b08e61e89a693e96968de2d6 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 5 Apr 2014 20:55:34 +0200 Subject: document kelvins and the automatic use of it MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- info/blueshift.texinfo | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'info/blueshift.texinfo') diff --git a/info/blueshift.texinfo b/info/blueshift.texinfo index 4cf1ac6..24f0f33 100644 --- a/info/blueshift.texinfo +++ b/info/blueshift.texinfo @@ -1849,6 +1849,22 @@ Approximate average colour temperature of a clear blue poleward sky. @c https://en.wikipedia.org/wiki/Colour_temperature @end table +The functions @code{temperature} (@code{rgb_temperature}) +and @code{cie_temperature} allow you to, instead of specifing +a colour temperature using literals or these constants, +use the proper name of this constants. For example, +if you use the string `@code{xenon short-arc lamp}' +as the first argument (the temperature value) for the +function @code{temperature}, @code{K_XENON_SHORT_ARC_LAMP} +(6200 kelvins) will be used. These functions utilise +the function @code{kelvins} that does this resolution. +@code{kelvins} kelvins takes either a numerical value +an returns it or takes a string and resolves it. +Predefined recognised punctuation (dot and hyphen) +and regular blank space is converted into underscores, +than the string it converted to upper case and prefixed +with `@code{K_}'. The string is then evaluated without +any sanity-checks, it should match one of the constants. @node Configuration examples -- cgit v1.2.3-70-g09d2