mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-18 04:05:34 +00:00
Code Issues 1 Projects Releases Wiki Activity

video: improve GstVideoFormatUnpack docs

Browse source 
https://bugzilla.gnome.org/show_bug.cgi?id=754650
This commit is contained in:
Tim-Philipp Müller 2015-09-07 00:19:09 +01:00
parent 3e41e784be
commit 86a1092e59
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
gst-libs/gst/video/video-format.h
View file

@ -253,9 +253,14 @@ typedef enum
* @width: the amount of pixels to unpack.
*
* Unpacks @width pixels from the given planes and strides containing data of
* format @info. The pixels will be unpacked into @dest which each component
* interleaved. @dest should at least be big enough to hold @width *
* n_components * size(unpack_format) bytes.
* format @info. The pixels will be unpacked into @dest with each component
* interleaved as per @info's unpack_format, which will usually be one of
* #GST_VIDEO_FORMAT_ARGB, #GST_VIDEO_FORMAT_AYUV, #GST_VIDEO_FORMAT_ARGB64 or
* #GST_VIDEO_FORMAT_AYUV64 depending on the format to unpack.
* @dest should at least be big enough to hold @width * bytes_per_pixel bytes
* where bytes_per_pixel relates to the unpack format and will usually be
* either 4 or 8 depending on the unpack format. bytes_per_pixel will be
* the same as the pixel stride for plane 0 for the above formats.
*
* For subsampled formats, the components will be duplicated in the destination
* array. Reconstruction of the missing components can be performed in a