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

caps: clarify docs for a few functions that they don't update things in-place

Browse source 
It is not necessarily clear from the existing introspection tags and
documentation alone.
This commit is contained in:
Nirbheek Chauhan 2015-10-26 17:35:34 +05:30 committed by Tim-Philipp Müller
parent a9c923d585
commit b76f046999
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
gst/gstcaps.c
View file

@ -951,6 +951,10 @@ gst_caps_copy_nth (const GstCaps * caps, guint nth)
* Discard all but the first structure from @caps. Useful when * Discard all but the first structure from @caps. Useful when
* fixating. * fixating.
* *
* This function takes ownership of @caps and will call gst_caps_make_writable()
* on it if necessary, so you must not use @caps afterwards unless you keep an
* additional reference to it with gst_caps_ref().
*
* Returns: (transfer full): truncated caps * Returns: (transfer full): truncated caps
*/ */
GstCaps * GstCaps *
@ -1886,7 +1890,9 @@ gst_caps_normalize_foreach (GQuark field_id, const GValue * value, gpointer ptr)
* @caps, but contains no lists. Each list is expanded into separate * @caps, but contains no lists. Each list is expanded into separate
* @GstStructures. * @GstStructures.
* *
* This function takes ownership of @caps. * This function takes ownership of @caps and will call gst_caps_make_writable()
* on it so you must not use @caps afterwards unless you keep an additional
* reference to it with gst_caps_ref().
* *
* Returns: (transfer full): the normalized #GstCaps * Returns: (transfer full): the normalized #GstCaps
*/ */
@ -2043,6 +2049,10 @@ gst_caps_switch_structures (GstCaps * caps, GstStructure * old,
* identical are merged. Component structures that have values that can be * identical are merged. Component structures that have values that can be
* merged are also merged. * merged are also merged.
* *
* This function takes ownership of @caps and will call gst_caps_make_writable()
* on it if necessary, so you must not use @caps afterwards unless you keep an
* additional reference to it with gst_caps_ref().
*
* This method does not preserve the original order of @caps. * This method does not preserve the original order of @caps.
* *
* Returns: The simplified caps. * Returns: The simplified caps.
@ -2113,6 +2123,10 @@ gst_caps_simplify (GstCaps * caps)
* values. First the caps will be truncated and then the first structure will be * values. First the caps will be truncated and then the first structure will be
* fixated with gst_structure_fixate(). * fixated with gst_structure_fixate().
* *
* This function takes ownership of @caps and will call gst_caps_make_writable()
* on it so you must not use @caps afterwards unless you keep an additional
* reference to it with gst_caps_ref().
*
* Returns: (transfer full): the fixated caps * Returns: (transfer full): the fixated caps
*/ */
GstCaps * GstCaps *