Document the side effects and return value of vpx_img_set_rect() more precisely.
Unified · Split
| @@ -171,7 +171,8 @@ vpx_image_t *vpx_img_wrap(vpx_image_t *img, vpx_img_fmt_t fmt, unsigned int d_w, · 170 unmodified lines | ||
| 171 | 171 | /*!\brief Set the rectangle identifying the displayed portion of the image |
| 172 | 172 | * |
| 173 | 173 | * Updates the displayed rectangle (aka viewport) on the image surface to |
| 174 | − * match the specified coordinates and size. | |
| 174 | + * match the specified coordinates and size. Specifically, sets img->d_w, | |
| 175 | + * img->d_h, and elements of the img->planes[] array. | |
| 175 | 176 | * |
| 176 | 177 | * \param[in] img Image descriptor |
| 177 | 178 | * \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, · 1 unmodified line | ||
| 179 | 180 | * \param[in] w width |
| 180 | 181 | * \param[in] h height |
| 181 | 182 | * |
| 182 | − * \return 0 if the requested rectangle is valid, nonzero otherwise. | |
| 183 | + * \return 0 if the requested rectangle is valid, nonzero (-1) otherwise. | |
| 183 | 184 | */ |
| 184 | 185 | int vpx_img_set_rect(vpx_image_t *img, unsigned int x, unsigned int y, |
| 185 | 186 | unsigned int w, unsigned int h); |