avcodec: Document AV_PKT_DATA_PALETTE side data type
authorVittorio Giovara <vittorio.giovara@gmail.com>
Tue, 20 Sep 2016 21:11:14 +0000 (17:11 -0400)
committerVittorio Giovara <vittorio.giovara@gmail.com>
Sun, 2 Oct 2016 19:42:03 +0000 (15:42 -0400)
libavcodec/avcodec.h

index 607688c..167525d 100644 (file)
@@ -1189,6 +1189,11 @@ typedef struct AVCPBProperties {
  * @{
  */
 enum AVPacketSideDataType {
+    /**
+     * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
+     * bytes worth of palette. This side data signals that a new palette is
+     * present.
+     */
     AV_PKT_DATA_PALETTE,
 
     /**