video: link to design docs in GstVideoFormat docs
authorTim-Philipp Müller <tim@centricular.com>
Fri, 11 Jan 2019 11:24:50 +0000 (11:24 +0000)
committerTim-Philipp Müller <tim@centricular.com>
Fri, 11 Jan 2019 11:24:50 +0000 (11:24 +0000)
Which is where the memory layout of the various pixel formats
is explained in detail.

Fixes https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/issues/538

gst-libs/gst/video/video-format.h

index 183b86e..ebd37f0 100644 (file)
@@ -118,6 +118,9 @@ G_BEGIN_DECLS
  * @GST_VIDEO_FORMAT_Y410: packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16)
  *
  * Enum value describing the most common video formats.
+ *
+ * See the [GStreamer raw video format design document](https://gstreamer.freedesktop.org/documentation/design/mediatype-video-raw.html#formats)
+ * for details about the layout and packing of these formats in memory.
  */
 typedef enum {
   GST_VIDEO_FORMAT_UNKNOWN,