From 4204d2194869d454284b4e19b6eb6f6feeeafcc6 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 20 Jul 2016 14:37:59 +0200 Subject: Add libcoopgamma_ramps_initialise.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_ramps_initialise.3 | 57 +++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 doc/man/libcoopgamma_ramps_initialise.3 diff --git a/doc/man/libcoopgamma_ramps_initialise.3 b/doc/man/libcoopgamma_ramps_initialise.3 new file mode 100644 index 0000000..cfe820b --- /dev/null +++ b/doc/man/libcoopgamma_ramps_initialise.3 @@ -0,0 +1,57 @@ +.TH LIBCOOPGAMMA_RAMPS_INITIALISE 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_ramps_initialise - Initialise a member type of libcoopgamma_ramps_t +.SH "SYNOPSIS" +.nf +#include + +int libcoopgamma_ramps_initialise(void* restrict \fIthis\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_ramps_initialise () +function initialises +.IR this . +.I this +must be of any of the following types, and not casted +to any other type such as +.I void* +or +.IR libcoopgamma_ramps_t: +.IR libcoopgamma_ramps8_t , +.IR libcoopgamma_ramps16_t , +.IR libcoopgamma_ramps32_t , +.IR libcoopgamma_ramps64_t , +.IR libcoopgamma_rampsf_t , +or +.IR libcoopgamma_rampsd_t . +.P +The +.BR libcoopgamma_ramps_initialise () +function is defined as a macro. +.SH "RETURN VALUES" +The +.BR libcoopgamma_ramps_initialise () +returns 0 on success. On error, -1 is returned and +.I errno +is set appropriately. +.SH "ERRORS" +The +.BR libcoopgamma_ramps_initialise () +function may fail for any reason specified for +.BR malloc (3). +.SH "SEE ALSO" +.BR libcoopgamma.h (0), +.BR libcoopgamma_ramps_destroy (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_initialise (3), +.BR libcoopgamma_crtc_info_initialise (3), +.BR libcoopgamma_filter_query_initialise (3), +.BR libcoopgamma_queried_filter_initialise (3), +.BR libcoopgamma_filter_table_initialise (3), +.BR libcoopgamma_error_initialise (3), +.BR libcoopgamma_context_initialise (3), +.BR libcoopgamma_async_context_initialise (3) -- cgit v1.2.3-70-g09d2