[FFmpeg-cvslog] r18286 - trunk/libavcodec/pixdesc.h

[stefano]

Author: stefano
Date: Tue Mar 31 22:13:29 2009
New Revision: 18286

Log:
Document read_line().

Modified:
   trunk/libavcodec/pixdesc.h

Modified: trunk/libavcodec/pixdesc.h
==============================================================================
--- trunk/libavcodec/pixdesc.h	Tue Mar 31 21:57:53 2009	(r18285)
+++ trunk/libavcodec/pixdesc.h	Tue Mar 31 22:13:29 2009	(r18286)
@@ -72,6 +72,18 @@ typedef struct AVPixFmtDescriptor{
  */
 extern const AVPixFmtDescriptor av_pix_fmt_descriptors[];
 
+/**
+ * Reads a line from an image, and writes to \p dst the values of the
+ * pixel format component \p c.
+ *
+ * @param data the array containing the pointers to the planes of the image
+ * @param linesizes the array containing the linesizes of the image
+ * @param desc the pixel format descriptor for the image
+ * @param x the horizontal coordinate of the first pixel to read
+ * @param y the vertical coordinate of the first pixel to read
+ * @param w the width of the line to read, that is the number of
+ * values to write to \p dst
+ */
 static inline void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4], const AVPixFmtDescriptor *desc, int x, int y, int c, int w)
 {
     AVComponentDescriptor comp= desc->comp[c];