aboutsummaryrefslogtreecommitdiffstats
path: root/libcoopgamma_queried_filter_marshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-10-22 18:59:27 +0200
committerMattias Andrée <maandree@kth.se>2019-10-22 18:59:27 +0200
commitbf4020471356938b9181a33984f511ffdd7ff25b (patch)
tree7f9a9abd1ae51318cd435f0ed7471be5f33b478c /libcoopgamma_queried_filter_marshal.3
parentList radharc's priority (diff)
downloadlibcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.gz
libcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.bz2
libcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.xz
Change license, change style, clean up, flat file hier, clean valgrind output in test
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libcoopgamma_queried_filter_marshal.3')
-rw-r--r--libcoopgamma_queried_filter_marshal.355
1 files changed, 55 insertions, 0 deletions
diff --git a/libcoopgamma_queried_filter_marshal.3 b/libcoopgamma_queried_filter_marshal.3
new file mode 100644
index 0000000..10b7ff7
--- /dev/null
+++ b/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 ()
+function 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)