diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/man/libcoopgamma_async_context_marshal.3 | 49 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_context_marshal.3 | 52 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_crtc_info_marshal.3 | 49 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_error_marshal.3 | 49 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_filter_marshal.3 | 49 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_filter_query_marshal.3 | 49 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_filter_table_marshal.3 | 49 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_queried_filter_marshal.3 | 55 | ||||
| -rw-r--r-- | doc/man/libcoopgamma_ramps_marshal.3 | 62 |
9 files changed, 463 insertions, 0 deletions
diff --git a/doc/man/libcoopgamma_async_context_marshal.3 b/doc/man/libcoopgamma_async_context_marshal.3 new file mode 100644 index 0000000..ec335e5 --- /dev/null +++ b/doc/man/libcoopgamma_async_context_marshal.3 @@ -0,0 +1,49 @@ +.TH LIBCOOPGAMMA_ASYNC_CONTEXT_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_async_context_marshal - Marshal a libcoopgamma_async_context_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_async_context_marshal(libcoopgamma_async_context_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_async_context_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.SH "RETURN VALUES" +The +.BR libcoopgamma_async_context_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_async_context_destroy (3), +.BR libcoopgamma_async_context_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_context_marshal (3) diff --git a/doc/man/libcoopgamma_context_marshal.3 b/doc/man/libcoopgamma_context_marshal.3 new file mode 100644 index 0000000..e3341bb --- /dev/null +++ b/doc/man/libcoopgamma_context_marshal.3 @@ -0,0 +1,52 @@ +.TH LIBCOOPGAMMA_CONTEXT_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_context_marshal - Marshal a libcoopgamma_context_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_context_marshal(libcoopgamma_context_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_context_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +However, it is probably nonsensical to send the +marshalled data to any other process than the +process itself since it contains a file descriptor. +.SH "RETURN VALUES" +The +.BR libcoopgamma_context_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_context_destroy (3), +.BR libcoopgamma_context_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_crtc_info_marshal.3 b/doc/man/libcoopgamma_crtc_info_marshal.3 new file mode 100644 index 0000000..50e88f1 --- /dev/null +++ b/doc/man/libcoopgamma_crtc_info_marshal.3 @@ -0,0 +1,49 @@ +.TH LIBCOOPGAMMA_CRTC_INFO_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_crtc_info_marshal - Marshal a libcoopgamma_crtc_info_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_crtc_info_marshal(libcoopgamma_crtc_info_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_crtc_info_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.SH "RETURN VALUES" +The +.BR libcoopgamma_crtc_info_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_crtc_info_destroy (3), +.BR libcoopgamma_crtc_info_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_error_marshal.3 b/doc/man/libcoopgamma_error_marshal.3 new file mode 100644 index 0000000..5349de7 --- /dev/null +++ b/doc/man/libcoopgamma_error_marshal.3 @@ -0,0 +1,49 @@ +.TH LIBCOOPGAMMA_ERROR_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_error_marshal - Marshal a libcoopgamma_error_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_error_marshal(libcoopgamma_error_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_error_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.SH "RETURN VALUES" +The +.BR libcoopgamma_error_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_error_destroy (3), +.BR libcoopgamma_error_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_filter_marshal.3 b/doc/man/libcoopgamma_filter_marshal.3 new file mode 100644 index 0000000..03192d5 --- /dev/null +++ b/doc/man/libcoopgamma_filter_marshal.3 @@ -0,0 +1,49 @@ +.TH LIBCOOPGAMMA_FILTER_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_filter_marshal - Marshal a libcoopgamma_filter_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_filter_marshal(libcoopgamma_filter_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_filter_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.SH "RETURN VALUES" +The +.BR libcoopgamma_filter_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_filter_destroy (3), +.BR libcoopgamma_filter_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_filter_query_marshal.3 b/doc/man/libcoopgamma_filter_query_marshal.3 new file mode 100644 index 0000000..1a4edd0 --- /dev/null +++ b/doc/man/libcoopgamma_filter_query_marshal.3 @@ -0,0 +1,49 @@ +.TH LIBCOOPGAMMA_FILTER_QUERY_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_filter_query_marshal - Marshal a libcoopgamma_filter_query_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_filter_query_marshal(libcoopgamma_filter_query_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_filter_query_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.SH "RETURN VALUES" +The +.BR libcoopgamma_filter_query_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_filter_query_destroy (3), +.BR libcoopgamma_filter_query_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_filter_table_marshal.3 b/doc/man/libcoopgamma_filter_table_marshal.3 new file mode 100644 index 0000000..691543e --- /dev/null +++ b/doc/man/libcoopgamma_filter_table_marshal.3 @@ -0,0 +1,49 @@ +.TH LIBCOOPGAMMA_FILTER_TABLE_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_filter_table_marshal - Marshal a libcoopgamma_filter_table_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_filter_table_marshal(libcoopgamma_filter_table_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_filter_table_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.SH "RETURN VALUES" +The +.BR libcoopgamma_filter_table_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_filter_table_destroy (3), +.BR libcoopgamma_filter_table_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_queried_filter_marshal.3 b/doc/man/libcoopgamma_queried_filter_marshal.3 new file mode 100644 index 0000000..bb62399 --- /dev/null +++ b/doc/man/libcoopgamma_queried_filter_marshal.3 @@ -0,0 +1,55 @@ +.TH LIBCOOPGAMMA_QUERIED_FILTER_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_queried_filter_marshal - Marshal a libcoopgamma_queried_filter_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_queried_filter_marshal(libcoopgamma_queried_filter_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP, libcoopgamma_depth_t \fIdepth\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_queried_filter_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.I depth +must describe the ramps in +.IR this , +or be 0. If +.I depth +is 0, the ramps are not marshalled. +.SH "RETURN VALUES" +The +.BR libcoopgamma_queried_filter_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_queried_filter_destroy (3), +.BR libcoopgamma_queried_filter_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_ramps_marshal.3 b/doc/man/libcoopgamma_ramps_marshal.3 new file mode 100644 index 0000000..4f2ea58 --- /dev/null +++ b/doc/man/libcoopgamma_ramps_marshal.3 @@ -0,0 +1,62 @@ +.TH LIBCOOPGAMMA_RAMPS_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_ramps_marshal - Marshal a member type of libcoopgamma_ramps_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_ramps_marshal(void* restrict \fIthis\fP, void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_ramps_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +.P +.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 . +.SH "RETURN VALUES" +The +.BR libcoopgamma_ramps_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_ramps_destroy (3), +.BR libcoopgamma_ramps_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) |