shithub: libvpx

Info  •  Files  •  Log  •  Branches

Document vpx_img_set_rect() more precisely

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

Change-Id: Id1120bc478ff090a70b4ddd23c4798026bbefe10

--- a/vpx/vpx_image.h

+++ b/vpx/vpx_image.h

@@ -171,7 +171,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

@@ -179,7 +180,7 @@

  * \param[in]    w         width

  * \param[in]    h         height

  *

- * \return 0 if the requested rectangle is valid, nonzero otherwise.

+ * \return 0 if the requested rectangle is valid, nonzero (-1) otherwise.

  */

 int vpx_img_set_rect(vpx_image_t *img, unsigned int x, unsigned int y,

                      unsigned int w, unsigned int h);