add docs note

note that when resizing, xres/yres need to be updated by the application
This commit is contained in:
John Cupitt 2015-02-25 08:47:45 +00:00
parent 38819a9050
commit a345a517c1
3 changed files with 13 additions and 4 deletions

View File

@ -665,7 +665,10 @@ vips_affine_init( VipsAffine *affine )
*
* @idx, @idy, @odx, @ody default to zero.
*
* See also: vips_shrink(), #VipsInterpolate.
* This operation does not change xres or yres. The image resolution needs to
* be updated by the application.
*
* See also: vips_shrink(), vips_resize(), #VipsInterpolate.
*
* Returns: 0 on success, -1 on error
*/

View File

@ -281,10 +281,13 @@ vips_resize_init( VipsResize *resize )
* then resampled with vips_affine() and the supplied interpolator, then
* sharpened.
*
* @interpolate defaults to bicubic, or bilinear if that is not available.
* @interpolate defaults to bicubic.
*
* @idx, @idy default to zero. Offset them by 0.5 to get pixel-centre sampling.
*
* This operation does not change xres or yres. The image resolution needs to
* be updated by the application.
*
* See also: vips_shrink(), vips_affine(), #VipsInterpolate.
*
* Returns: 0 on success, -1 on error

View File

@ -442,9 +442,12 @@ vips_shrink_init( VipsShrink *shrink )
* You will get aliasing for non-integer shrinks. In this case, shrink with
* this function to the nearest integer size above the target shrink, then
* downsample to the exact size with vips_affine() and your choice of
* interpolator.
* interpolator. See vips_resize() for a convenient way to do this.
*
* See also: vips_affine().
* This operation does not change xres or yres. The image resolution needs to
* be updated by the application.
*
* See also: vips_resize(), vips_affine().
*
* Returns: 0 on success, -1 on error
*/