commit 9b460f0cd213117eb845b314440a5d1900e4acb1
author Wan-Teh Chang <wtc@google.com> Thu Jul 08 15:08:05 2021 -0700
committer Wan-Teh Chang <wtc@google.com> Fri Jul 09 18:07:33 2021 +0000
tree 9a7094ebefaa382a011fb50ff8633d232b0db747
parent e9cac0a3cce816f0c901dbb77c87454993afbff4

Document aom_img_set_rect() more precisely

Document the side effects and return value of aom_img_set_rect() more
precisely.

Change-Id: Id1120bc478ff090a70b4ddd23c4798026bbefe10

aom/aom_image.h

diff --git a/aom/aom_image.h b/aom/aom_image.h
index 03bc73e..9ec3225 100644
--- a/aom/aom_image.h
+++ b/aom/aom_image.h
@@ -300,7 +300,8 @@
 /*!\brief Set the rectangle identifying the displayed portion of the image
  *
  * Updates the displayed rectangle (aka viewport) on the image surface to
- * match the specified coordinates and size.
+ * match the specified coordinates and size. Specifically, sets img->d_w,
+ * img->d_h, and elements of the img->planes[] array.
  *
  * \param[in]    img       Image descriptor
  * \param[in]    x         leftmost column
@@ -309,7 +310,7 @@
  * \param[in]    h         height
  * \param[in]    border    A border that is padded on four sides of the image.
  *
- * \return 0 if the requested rectangle is valid, nonzero otherwise.
+ * \return 0 if the requested rectangle is valid, nonzero (-1) otherwise.
  */
 int aom_img_set_rect(aom_image_t *img, unsigned int x, unsigned int y,
                      unsigned int w, unsigned int h, unsigned int border);