summaryrefslogtreecommitdiff
path: root/libavutil/imgutils.h
diff options
context:
space:
mode:
authorJames Almer <jamrial@gmail.com>2017-09-27 20:35:04 -0300
committerJames Almer <jamrial@gmail.com>2017-09-27 20:35:04 -0300
commit1a115a31d430b71973b1e1556fcf767417449f09 (patch)
tree9698e9d15033b217dd20f38b6ce2e13d6e935519 /libavutil/imgutils.h
parent9cf1376aadcdd8952c4ba7af0bf8634ddf99da0d (diff)
parentce6d72d10776b03c6780d4aa676414ce002285d4 (diff)
Merge commit 'ce6d72d10776b03c6780d4aa676414ce002285d4'
* commit 'ce6d72d10776b03c6780d4aa676414ce002285d4': imgutils: Document av_image_get_buffer_size() Merged-by: James Almer <jamrial@gmail.com>
Diffstat (limited to 'libavutil/imgutils.h')
-rw-r--r--libavutil/imgutils.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/libavutil/imgutils.h b/libavutil/imgutils.h
index 2ab90ac033..5b790ecf0a 100644
--- a/libavutil/imgutils.h
+++ b/libavutil/imgutils.h
@@ -172,7 +172,11 @@ int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
* Return the size in bytes of the amount of data required to store an
* image with the given parameters.
*
- * @param[in] align the assumed linesize alignment
+ * @param pix_fmt the pixel format of the image
+ * @param width the width of the image in pixels
+ * @param height the height of the image in pixels
+ * @param align the assumed linesize alignment
+ * @return the buffer size in bytes, a negative error code in case of failure
*/
int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align);