pixdesc: Document the component order
authorLuca Barbato <lu_zero@gentoo.org>
Thu, 10 Sep 2015 03:02:47 +0000 (05:02 +0200)
committerLuca Barbato <lu_zero@gentoo.org>
Thu, 10 Sep 2015 10:08:57 +0000 (12:08 +0200)
libavutil/pixdesc.h

index ea84fd3..fe06d94 100644 (file)
@@ -108,6 +108,13 @@ typedef struct AVPixFmtDescriptor {
      * Parameters that describe how pixels are packed. If the format
      * has chroma components, they must be stored in comp[1] and
      * comp[2].
+     * If the format is RGB-like, the first component is R, followed
+     * by G and B.
+     *
+     * If the format is YUV-like, the first component is Y, followed
+     * by U and V.
+     *
+     * If present, the Alpha channel is always the last component.
      */
     AVComponentDescriptor comp[4];