Image.downscaleTo Method

Module: Image

Definition

Downscales the image so that its maximum dimension equals the given maximum size, while preserving the aspect ratio.

Note

If the maximum dimension is already smaller than the given maximum size, the function does nothing and the returned scale ratio is 1.

double downscaleTo(Image dstImage, int maxSize)

Parameters

dstImage Image

in Destination image.

maxSize int

in Maximum image size, in pixels. The value must be greater than 0.

Returns

double

The scaling ratio applied to the image. Range is ]0:1].

Exceptions

FaceException

An error has occurred during Face Library execution.