Mercurial > libavutil.hg
comparison pixdesc.h @ 957:e34e8d654ded libavutil
Fix grammar errors in documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 15:38:06 +0000 |
parents | af688c6fa72f |
children | 8b14bef3cce2 |
comparison
equal
deleted
inserted
replaced
956:2894d4c208dc | 957:e34e8d654ded |
---|---|
91 * The array of all the pixel format descriptors. | 91 * The array of all the pixel format descriptors. |
92 */ | 92 */ |
93 extern const AVPixFmtDescriptor av_pix_fmt_descriptors[]; | 93 extern const AVPixFmtDescriptor av_pix_fmt_descriptors[]; |
94 | 94 |
95 /** | 95 /** |
96 * Reads a line from an image, and writes the values of the | 96 * Read a line from an image, and write the values of the |
97 * pixel format component c to dst. | 97 * pixel format component c to dst. |
98 * | 98 * |
99 * @param data the array containing the pointers to the planes of the image | 99 * @param data the array containing the pointers to the planes of the image |
100 * @param linesizes the array containing the linesizes of the image | 100 * @param linesizes the array containing the linesizes of the image |
101 * @param desc the pixel format descriptor for the image | 101 * @param desc the pixel format descriptor for the image |
110 */ | 110 */ |
111 void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4], | 111 void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4], |
112 const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component); | 112 const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component); |
113 | 113 |
114 /** | 114 /** |
115 * Writes the values from src to the pixel format component c of an | 115 * Write the values from src to the pixel format component c of an |
116 * image line. | 116 * image line. |
117 * | 117 * |
118 * @param src array containing the values to write | 118 * @param src array containing the values to write |
119 * @param data the array containing the pointers to the planes of the | 119 * @param data the array containing the pointers to the planes of the |
120 * image to write into. It is supposed to be zeroed. | 120 * image to write into. It is supposed to be zeroed. |
127 */ | 127 */ |
128 void write_line(const uint16_t *src, uint8_t *data[4], const int linesize[4], | 128 void write_line(const uint16_t *src, uint8_t *data[4], const int linesize[4], |
129 const AVPixFmtDescriptor *desc, int x, int y, int c, int w); | 129 const AVPixFmtDescriptor *desc, int x, int y, int c, int w); |
130 | 130 |
131 /** | 131 /** |
132 * Returns the pixel format corresponding to name. | 132 * Return the pixel format corresponding to name. |
133 * | 133 * |
134 * If there is no pixel format with name name, then looks for a | 134 * If there is no pixel format with name name, then looks for a |
135 * pixel format with the name corresponding to the native endian | 135 * pixel format with the name corresponding to the native endian |
136 * format of name. | 136 * format of name. |
137 * For example in a little-endian system, first looks for "gray16", | 137 * For example in a little-endian system, first looks for "gray16", |
140 * Finally if no pixel format has been found, returns PIX_FMT_NONE. | 140 * Finally if no pixel format has been found, returns PIX_FMT_NONE. |
141 */ | 141 */ |
142 enum PixelFormat av_get_pix_fmt(const char *name); | 142 enum PixelFormat av_get_pix_fmt(const char *name); |
143 | 143 |
144 /** | 144 /** |
145 * Returns the number of bits per pixel used by the pixel format | 145 * Return the number of bits per pixel used by the pixel format |
146 * described by pixdesc. | 146 * described by pixdesc. |
147 * | 147 * |
148 * The returned number of bits refers to the number of bits actually | 148 * The returned number of bits refers to the number of bits actually |
149 * used for storing the pixel information, that is padding bits are | 149 * used for storing the pixel information, that is padding bits are |
150 * not counted. | 150 * not counted. |