info: what the macros have in common

Signed-off-by: Mattias Andrée <maandree@member.fsf.org>

3 files changed, 42 insertions, 9 deletions

diff --git a/Makefile.in b/Makefile.in
index d3632de..7e33613 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -47,11 +47,11 @@ _C_STD = c99
 _H = libclut
 
 # Used by mk/texinfo.mk
-#_TEXINFO_DIRLEVELS = 2
-#_INFOPARTS = 0
-#_HAVE_TEXINFO_MANUAL = yes
-#_HTML_FILES = Free-Software-Needs-Free-Documentation.html  GNU-Free-Documentation-License.html  \
-#              GNU-General-Public-License.html  index.html  Overview.html
+_TEXINFO_DIRLEVELS = 2
+_INFOPARTS = 0
+_HAVE_TEXINFO_MANUAL = yes
+_HTML_FILES = Free-Software-Needs-Free-Documentation.html  GNU-Free-Documentation-License.html  \
+              GNU-General-Public-License.html  index.html  Overview.html  CLUT-Manipulation.html
 
 # Used by mk/man.mk
 #_MAN_PAGE_SECTIONS = 0 3 7
@@ -63,10 +63,10 @@ _H = libclut
 _COPYING = COPYING
 
 # Used by mk/dist.mk
-#___EVERYTHING_INFO = autohaltd titlepage-data content hardcopy-copying  \
-#                     appx/fdl appx/free-software-needs-free-documentation appx/gpl  \
-#                     reusable/macros reusable/paper reusable/titlepage  \
-#                     chap/overview
+___EVERYTHING_INFO = autohaltd titlepage-data content hardcopy-copying  \
+                     appx/fdl appx/free-software-needs-free-documentation appx/gpl  \
+                     reusable/macros reusable/paper reusable/titlepage  \
+                     chap/overview chap/clut-manipulation.texinfo
 _EVERYTHING = $(__EVERYTHING_ALL_COMMON) DEPENDENCIES INSTALL NEWS  \
               $(foreach F,$(___EVERYTHING_INFO),doc/info/$(F).texinfo)  clut.h
 
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.
+
diff --git a/doc/info/content.texinfo b/doc/info/content.texinfo
index 0eeeac9..737e457 100644
--- a/doc/info/content.texinfo
+++ b/doc/info/content.texinfo
@@ -9,6 +9,7 @@
 
 @menu
 * Overview::                                Brief overview of @command{libclut}.
+* CLUT Manipulation::                       Function-like macros for CLUT manipulation.
 
 * Free Software Needs Free Documentation::  Why free documentation is important.
 * GNU General Public License::              Copying and sharing @command{libclut}.
@@ -18,6 +19,7 @@
 
 
 @include chap/overview.texinfo
+@include chap/clut-manipulation.texinfo
 
 @include appx/free-software-needs-free-documentation.texinfo