diff options
| author | Wan-Teh Chang <wtc@google.com> | 2021-07-08 15:08:05 -0700 |
|---|---|---|
| committer | James Zern <jzern@google.com> | 2021-07-09 12:45:55 -0700 |
| commit | df7dc31cdfaa81e20fd0f4aed4c5eff037f484c4 (patch) | |
| tree | 8063b4272ba4c90efb5708d82f65124f11f4a268 /vpx | |
| parent | 826d7ca4d970caaa90d68f5096f06ee72bbdd688 (diff) | |
| download | libvpx-df7dc31cdfaa81e20fd0f4aed4c5eff037f484c4.tar libvpx-df7dc31cdfaa81e20fd0f4aed4c5eff037f484c4.tar.gz libvpx-df7dc31cdfaa81e20fd0f4aed4c5eff037f484c4.tar.bz2 libvpx-df7dc31cdfaa81e20fd0f4aed4c5eff037f484c4.zip | |
Document vpx_img_set_rect() more precisely
Document the side effects and return value of vpx_img_set_rect() more
precisely.
Change-Id: Id1120bc478ff090a70b4ddd23c4798026bbefe10
Diffstat (limited to 'vpx')
| -rw-r--r-- | vpx/vpx_image.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/vpx/vpx_image.h b/vpx/vpx_image.h index bc23be50c..1adc9b9d9 100644 --- a/vpx/vpx_image.h +++ b/vpx/vpx_image.h @@ -171,7 +171,8 @@ vpx_image_t *vpx_img_wrap(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, /*!\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 @@ vpx_image_t *vpx_img_wrap(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, * \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); |