Clarify output of av_get_bits_per_pixel
authorKieran Kunhya <kierank@ob-encoder.com>
Tue, 14 May 2013 19:23:40 +0000 (14:23 -0500)
committerAnton Khirnov <anton@khirnov.net>
Wed, 15 May 2013 05:45:09 +0000 (07:45 +0200)
Signed-off-by: Anton Khirnov <anton@khirnov.net>
libavutil/pixdesc.h

index 312e89a..1d73e5d 100644 (file)
@@ -177,7 +177,8 @@ char *av_get_pix_fmt_string (char *buf, int buf_size, enum AVPixelFormat pix_fmt
 
 /**
  * Return the number of bits per pixel used by the pixel format
- * described by pixdesc.
+ * described by pixdesc. Note that this is not the same as the number
+ * of bits per sample.
  *
  * The returned number of bits refers to the number of bits actually
  * used for storing the pixel information, that is padding bits are