gst/gstpad.h: Clarify the docs a bit more.

Original commit message from CVS:
* gst/gstpad.h:
Clarify the docs a bit more.
This commit is contained in:
Wim Taymans 2008-08-05 16:50:27 +00:00
parent 71ba3c6fce
commit c82ad04dd4
2 changed files with 11 additions and 4 deletions

View file

@ -1,3 +1,8 @@
2008-08-05 Wim Taymans <wim.taymans@collabora.co.uk>
* gst/gstpad.h:
Clarify the docs a bit more.
2008-08-05 Stefan Kost <ensonic@users.sf.net>
* tests/examples/metadata/read-metadata.c:

View file

@ -420,10 +420,12 @@ typedef void (*GstPadFixateCapsFunction) (GstPad *pad, GstCaps *caps);
* be processed by @pad. The function is mostly overridden by elements that can
* provide a hardware buffer in order to avoid additional memcpy operations.
*
* The function can return a buffer that does not have @caps, in which case the
* upstream element requests a format change. If a format change was requested,
* the returned buffer will be one to hold the data of said new caps, so its
* size might be different from @size.
* The function can return a buffer that has caps different from the requested
* @caps, in which case the upstream element requests a format change to this
* new caps.
* If a format change was requested, the returned buffer will be one to hold
* the data of said new caps, so its size might be different from the requested
* @size.
*
* When this function returns anything else than #GST_FLOW_OK, the buffer allocation
* failed and @buf does not contain valid data.