summaryrefslogtreecommitdiffstats
path: root/info/blueshift.texinfo
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2014-04-05 20:55:34 +0200
committerMattias Andrée <maandree@operamail.com>2014-04-05 20:55:34 +0200
commit7f7a2ece327a07c4b08e61e89a693e96968de2d6 (patch)
tree3f3dd149f9f2be2d3f60e8d4e81fe216e3091275 /info/blueshift.texinfo
parentlist temperature constants in info manual (diff)
downloadblueshift-7f7a2ece327a07c4b08e61e89a693e96968de2d6.tar.gz
blueshift-7f7a2ece327a07c4b08e61e89a693e96968de2d6.tar.bz2
blueshift-7f7a2ece327a07c4b08e61e89a693e96968de2d6.tar.xz
document kelvins and the automatic use of it
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'info/blueshift.texinfo')
-rw-r--r--info/blueshift.texinfo16
1 files changed, 16 insertions, 0 deletions
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