aboutsummaryrefslogblamecommitdiffstats
path: root/doc/man/libcoopgamma_get_crtcs_sync.3
blob: 3a3eebfe3bda5a5620569340b8a4f4b76e274198 (plain) (tree)















































                                                                                   




                                         
.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 <libcoopgamma.h>

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_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)