From afaaa4524af50fa3c6726671c04f71f85ab7fe95 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@operamail.com>
Date: Mon, 2 Jun 2014 22:45:19 +0200
Subject: info: select and init site, partition and crtc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@operamail.com>
---
 info/libgamma.texinfo | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)

(limited to 'info')

diff --git a/info/libgamma.texinfo b/info/libgamma.texinfo
index 1a480fe..79cc979 100644
--- a/info/libgamma.texinfo
+++ b/info/libgamma.texinfo
@@ -599,6 +599,33 @@ This structure contains the following variables:
 £>done
 @end table
 
+To select a site and initialise its state
+call the function @code{libgamma_site_initialise}.
+It returns zero on success, and and negative
+@code{int} on failure. If the return is negative,
+it is a @code{libgamma} error code; these are
+listed in @ref{Errors}. For input
+@code{libgamma_site_initialise} takes three
+arguments:
+
+@table @asis
+@item @code{this} [@code{libgamma_site_state_t*}]
+The site state to initialise.
+
+@item @code{method} [@code{int}]
+The adjustment method (display server and protocol),
+these are listed in @ref{Adjustment methods}.
+
+@item @code{site} [@code{char*}]
+The site identifier, unless it is @code{NULL}
+it must a @code{free}:able. One the state is
+destroyed the library will attempt to free it.
+There you should not free it yourself, and it
+must not be a string constant or allocated on
+the stack. Note however that it will not be
+@code{free}:d if this function fails.
+@end table
+
 To release all resources held by a site state,
 call the function @code{libgamma_site_destroy},
 whose only parameter is the site state to
@@ -627,6 +654,27 @@ This structure contains the following variables:
 £>done
 @end table
 
+To select a partition and initialise its state
+call the function @code{libgamma_partition_initialise}.
+It returns zero on success, and and negative
+@code{int} on failure. If the return is negative,
+it is a @code{libgamma} error code; these are
+listed in @ref{Errors}. For input
+@code{libgamma_partition_initialise} takes three
+arguments:
+
+@table @asis
+@item @code{this} [@code{libgamma_partition_state_t*}]
+The partition state to initialise.
+
+@item @code{site} [@code{libgamma_site_state_t*}]
+The site state for the site that the
+partition belongs to.
+
+@item @code{partition} [@code{size_t}]
+The the index of the partition within the site.
+@end table
+
 To release all resources held by a partition state,
 call the function @code{libgamma_partition_destroy},
 whose only parameter is the partition state to
@@ -655,6 +703,28 @@ This structure contains the following variables;
 £>done
 @end table
 
+To select a CRTC and initialise its state
+call the function @code{libgamma_crtc_initialise}.
+It returns zero on success, and and negative
+@code{int} on failure. If the return is negative,
+it is a @code{libgamma} error code; these are
+listed in @ref{Errors}. For input
+@code{libgamma_crtc_initialise} takes three
+arguments:
+
+@table @asis
+@item @code{this} [@code{libgamma_crtc_state_t*}]
+The CRTC state to initialise.
+
+@item @code{partition} [@code{libgamma_partition_state_t*}]
+The partition state for the
+partition that the CRTC belongs to.
+
+@item @code{crtc} [@code{size_t}]
+The the index of the CRTC within
+the partition.
+@end table
+
 To release all resources held by a CRTC state,
 call the function @code{libgamma_crtc_destroy},
 whose only parameter is the CRTC state to
-- 
cgit v1.2.3-70-g09d2