diff options
| author | Jan Schmidt <jan@centricular.com> | 2015-05-25 16:23:33 +1000 |
|---|---|---|
| committer | Jan Schmidt <jan@centricular.com> | 2015-05-25 16:23:33 +1000 |
| commit | f9e5178dd16c46029e645561dc7d519c3496bfd3 (patch) | |
| tree | 63a22a248da54bb2a12536b20c4348421bd3d2a4 /docs | |
| parent | 99d3179634433a2b680c6e9cc8de3231146a648a (diff) | |
gstvalue: Add GstFlagSet type
GstFlagSet is a new type designed for negotiating sets
of boolean capabilities flags, consisting of a 32-bit
flags bitfield and 32-bit mask field. The mask field
indicates which of the flags bits an element needs to have
as specific values, and which it doesn't care about.
This allows efficient negotiation of arrays of boolean
capabilities.
The standard serialisation format is FLAGS:MASK, with
flags and mask fields expressed in hexadecimal, however
GstFlagSet has a gst_register_flagset() function, which
associates a new GstFlagSet derived type with an existing
GFlags gtype. When serializing a GstFlagSet with an
associated set of GFlags, it also serializes a human-readable
form of the flags for easier debugging.
It is possible to parse a GFlags style serialisation of a
flagset, without the hex portion on the front. ie,
+flag1/flag2/flag3+flag4, to indicate that
flag1 & flag4 must be set, and flag2/flag3 must be unset,
and any other flags are don't-care.
https://bugzilla.gnome.org/show_bug.cgi?id=746373
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gst/gstreamer-sections.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index dba70f552..204296e08 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -3285,6 +3285,15 @@ GST_TYPE_BITMASK gst_value_set_bitmask gst_value_get_bitmask +<SUBSECTION flagset> +GST_VALUE_HOLDS_FLAG_SET +GST_TYPE_FLAG_SET +gst_structure_get_flagset +gst_value_get_flagset_flags +gst_value_get_flagset_mask +gst_value_set_flagset +GST_FLAG_SET_MASK_EXACT + <SUBSECTION int64range> GST_VALUE_HOLDS_INT64_RANGE GST_TYPE_INT64_RANGE @@ -3408,6 +3417,7 @@ gst_int64_range_get_type gst_value_array_get_type gst_value_list_get_type gst_bitmask_get_type +gst_flagset_get_type </SECTION> <SECTION> |