aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVittorio Giovara <vittorio.giovara@gmail.com>2017-02-07 10:01:41 -0500
committerVittorio Giovara <vittorio.giovara@gmail.com>2017-02-10 16:25:58 -0500
commitce6d72d10776b03c6780d4aa676414ce002285d4 (patch)
treed19303193676c1f5f39e9cb06a5b35a82885e63b
parentb6093e8c72a80710f086c678ab0730cf30953b5c (diff)
downloadffmpeg-ce6d72d10776b03c6780d4aa676414ce002285d4.tar.gz
imgutils: Document av_image_get_buffer_size()
-rw-r--r--libavutil/imgutils.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/libavutil/imgutils.h b/libavutil/imgutils.h
index 67063a2947..fafabc48ca 100644
--- a/libavutil/imgutils.h
+++ b/libavutil/imgutils.h
@@ -169,7 +169,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);