changeset 9019:895f99d00718 libavcodec

AVPixFmtDescriptor doxy
author michael
date Tue, 24 Feb 2009 01:12:25 +0000
parents 98995efdf3aa
children 97b991a32b85
files pixdesc.h
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pixdesc.h	Tue Feb 24 01:08:29 2009 +0000
+++ b/pixdesc.h	Tue Feb 24 01:12:25 2009 +0000
@@ -31,6 +31,14 @@
     uint16_t depth_minus1 :4;            ///< number of bits in the component minus 1
 }AVComponentDescriptor;
 
+/**
+ * Descriptor that unambigously describes how the bits of a pixel are
+ * stored in the up to 4 data planes of an image. It also stores the
+ * subsampling factors and number of components.
+ *
+ * @note This is seperate of the colorspace (RGB, YCbCr, YPbPr, jpeg style YUV and all the YUV variants)
+ *       AVPixFmtDescripto just stores how values are stored not what these values represent.
+ */
 typedef struct AVPixFmtDescriptor{
     uint8_t nb_channels;        ///< The number of components each pixel has, (1-4)