From 02126b72d94968fb39787bcf7dfcf85ad41d2c4d Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 10 Jan 2016 14:40:47 +0100 Subject: info: what the macros have in common MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/info/chap/clut-manipulation.texinfo | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 doc/info/chap/clut-manipulation.texinfo (limited to 'doc/info/chap') diff --git a/doc/info/chap/clut-manipulation.texinfo b/doc/info/chap/clut-manipulation.texinfo new file mode 100644 index 0000000..3a10939 --- /dev/null +++ b/doc/info/chap/clut-manipulation.texinfo @@ -0,0 +1,31 @@ +@node CLUT Manipulation +@chapter CLUT Manipulation + +@command{libclut} has a number of function-like macros +for manipulating colour lookup tables. These have +3 common initial parameters, that describe the +colour lookup table that shall be manipulated. +@table @code +@item clut +Pointer to the gamma ramps. This must be a pointer +to an instance of a @code{struct} that must at least +have the array members @code{red}, @code{green}, and +@code{blue}, whose elements shall be of the time +specified by the parameter @code{type}. The struct +must also have the scalar members @code{red_size}, +@code{green_size}, and @code{blue_size}, and shall be +of the type @code{size_t}; they shall specify the +number of stops (elements) in the arrays @code{.red}, +@code{.green}, and @code{.blue}, respectively, which +shall be the gamma ramp for the ``red'', green, and +blue channels respectively. +@item max +The maximum value on each stop in the ramps. +@item type +The data type used for each stop in the ramps. +@end table +@noindent +Additionally, these macros do not allow that arguments +have side-effects. None, if the macros have a return +value. + -- cgit v1.2.3-70-g09d2