mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 00:36:51 +00:00
Code Issues 1 Projects Releases Wiki Activity

gst/gstcaps.c: add documentation

Browse source 
Original commit message from CVS:
* gst/gstcaps.c: (gst_caps_subtract), (gst_caps_is_equal),
(gst_caps_is_subset):
add documentation
This commit is contained in:
Benjamin Otte 2004-04-23 00:00:25 +00:00
parent bb1302b533
commit 2792a59df4
2 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
2004-04-23 Benjamin Otte <otte@gnome.org>
* gst/gstcaps.c: (gst_caps_subtract), (gst_caps_is_equal),
(gst_caps_is_subset):
add documentation
2004-04-23 Benjamin Otte <otte@gnome.org>
* gst/gstcaps.c: (gst_caps_structure_subtract_field),

33
gst/gstcaps.c
View file

@ -716,6 +716,17 @@ gst_caps_is_always_compatible (const GstCaps * caps1, const GstCaps * caps2)
return FALSE;
}
/**
* gst_caps_is_subset:
* @subset: a #GstCaps
* @superset: a potentially greater #GstCaps
*
* Checks if all caps represented by @subset are also represented by @superset
* <note>This function does not work reliably if optional properties for caps
* are included on one caps and omitted on the other.</note>
*
* Returns: TRUE if @subset is a subset of @superset
*/
gboolean
gst_caps_is_subset (const GstCaps * subset, const GstCaps * superset)
{
@ -736,6 +747,17 @@ gst_caps_is_subset (const GstCaps * subset, const GstCaps * superset)
return ret;
}
/**
* gst_caps_is_equal:
* @caps1: a #GstCaps
* @caps2: another #GstCaps
*
* Checks if the given caps represent the same set of caps.
* <note>This function does not work reliably if optional properties for caps
* are included on one caps and omitted on the other.</note>
*
* Returns: TRUE if both caps are equal
*/
gboolean
gst_caps_is_equal (const GstCaps * caps1, const GstCaps * caps2)
{
@ -957,6 +979,17 @@ gst_caps_structure_subtract (GSList ** into, const GstStructure * minuend,
return ret;
}
/**
* gst_caps_subtract:
* @minuend: #GstCaps to substract from
* @subtrahend: #GstCaps to substract
*
* Subtracts the @subtrahend from the @minuend.
* <note>This function does not work reliably if optional properties for caps
* are included on one caps and omitted on the other.</note>
*
* Returns: the resulting caps
*/
GstCaps *
gst_caps_subtract (const GstCaps * minuend, const GstCaps * subtrahend)
{