From d4a7c919e3fc79b1ec40027069a25ffc308da129 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 21 Jul 2016 23:50:31 +0200 Subject: Add libcoopgamma_get_crtcs_sync.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libcoopgamma_get_crtcs_sync.3 | 57 +++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 doc/man/libcoopgamma_get_crtcs_sync.3 (limited to 'doc') diff --git a/doc/man/libcoopgamma_get_crtcs_sync.3 b/doc/man/libcoopgamma_get_crtcs_sync.3 new file mode 100644 index 0000000..eb5a3cd --- /dev/null +++ b/doc/man/libcoopgamma_get_crtcs_sync.3 @@ -0,0 +1,57 @@ +.TH LIBCOOPGAMMA_GET_CRTCS_SYNC 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_get_crtcs_sync - Synchronously retrieve a list of all available CRTC:s +.SH "SYNOPSIS" +.nf +#include + +char **libcoopgamma_get_crtcs_sync(libcoopgamma_context_t *restrict \fIctx\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_get_crtcs_sync () +function synchronously retrieves a +list of all available CRTC:s over the +connection of +.I ctx +to the server. +.SH "RETURN VALUES" +Upon successful completion, the +.BR libcoopgamma_get_crtcs_sync () +function returns a +.I NULL +terminated +list of all available CRTC:s. If possible, +the CRTC:s are named by the connected +monitors' EDID:s. None of the elements can +contain a NUL or LF byte. The elements in +the list are subpointers of the returned +pointer. The user shall free the returned +pointer, which effectively frees all its +elements. On error, +.I NULL +is returned and +.I errno +is set appropriately. +.SH "ERRORS" +The +.BR libcoopgamma_get_crtcs_send () +function may fail for any reason specified for +.BR libcoopgamma_get_crtcs_send (3), +.BR libcoopgamma_get_crtcs_recv (3), +.BR libcoopgamma_flush (3), +or +.BR libcoopgamma_synchronise (3). +.SH "SEE ALSO" +.BR libcoopgamma_async_context_initialise (3), +.BR libcoopgamma_flush (3), +.BR libcoopgamma_synchronise (3), +.BR libcoopgamma_set_nonblocking (3), +.BR libcoopgamma_get_crtcs_send (3), +.BR libcoopgamma_get_crtcs_recv (3), +.BR libcoopgamma_get_gamma_info_sync (3), +.BR libcoopgamma_get_gamma_sync (3), +.BR libcoopgamma_set_gamma_sync (3) -- cgit v1.2.3-70-g09d2