CaptureImage.downscale Method

Module: CaptureImage

Definition

Downscales the image in-place so that its maximum dimension is equal to 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 scaling ration returned is 1.

Python

downscale(self, max_size: int) -> float

Parameters

max_size int

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

Returns

float

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

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

double downscale(int maxSize)

Parameters

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

DevicesException

An error has occurred during Devices Library execution.

C#

public float Downscale(int maxSize)

Parameters

maxSize int

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

Returns

float

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

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public float downscale(int maxSize) throws DevicesException

Parameters

maxSize int

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

Returns

float

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

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesCaptureImage_Downscale (
    ID3_DEVICES_CAPTURE_IMAGE hCaptureImage,
    int maxSize,
    float * scaleRatio)

Parameters

hCaptureImage ID3_DEVICES_CAPTURE_IMAGE

in Handle to the CaptureImage object.

maxSize int

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

scaleRatio float *

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

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.