videooverlaycomposition: document required map flags

Fix documentation for gst_video_overlay_composition_blend(). The video frame
needs to be mapped with GST_MAP_READWRITE flag.

https://bugzilla.gnome.org/show_bug.cgi?id=771382
This commit is contained in:
Víctor Manuel Jáquez Leal 2016-09-14 10:14:18 +02:00
parent d5e8b7df6c
commit dcfc69ab1d

View file

@ -454,11 +454,15 @@ gst_video_overlay_rectangle_needs_scaling (GstVideoOverlayRectangle * r)
/**
* gst_video_overlay_composition_blend:
* @comp: a #GstVideoOverlayComposition
* @video_buf: a #GstVideoFrame containing raw video data in a supported format
* @video_buf: a #GstVideoFrame containing raw video data in a
* supported format. It should be mapped using GST_MAP_READWRITE
*
* Blends the overlay rectangles in @comp on top of the raw video data
* contained in @video_buf. The data in @video_buf must be writable and
* mapped appropriately.
*
* Since @video_buf data is read and will be modified, it ought be
* mapped with flag GST_MAP_READWRITE.
*/
/* FIXME: formats with more than 8 bit per component which get unpacked into
* ARGB64 or AYUV64 (such as v210, v216, UYVP, GRAY16_LE and GRAY16_BE)