Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Spatial Transforms » ResizeImage_FixedAspectRatio

ResizeImage_FixedAspectRatio


Header: FIL.h
Namespace: fil
Module: FoundationLite

Changes one dimension of the image to a desired length while the other dimension is set to a length such that the aspect ration of the image is maintained.

Syntax

C++
C#
 
void fil::ResizeImage_FixedAspectRatio
(
	const fil::Image& inImage,
	ftl::Optional<int> inNewLength,
	fil::Dimension::Type inDimension,
	fil::ResizeMethod::Type inResizeMethod,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inNewLength Optional<int> 1 - 65535 NIL The length in pixels that the chosen dimension will be set to
Input value inDimension Dimension::Type The dimension that will be set to the given length
Input value inResizeMethod ResizeMethod::Type
Output value outImage Image& Output image

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

This operation is optimized for SSE2 technology for pixels of types: UINT8 (when inResizeMethod = Area), UINT16 (when inResizeMethod = Area), 3xUINT8 (when inResizeMethod = Area), 3xUINT16 (when inResizeMethod = Area).

This operation is optimized for AVX2 technology for pixels of types: UINT8 (when inResizeMethod = Area), UINT16 (when inResizeMethod = Area), 3xUINT8 (when inResizeMethod = Area), 3xUINT16 (when inResizeMethod = Area).

Errors

List of possible exceptions:

Error type Description
DomainError Empty image on input in ResizeImage_FixedAspectRatio.
DomainError Unsupported dimension given in inDimension, only Width and Height are supported in ResizeImage_FixedAspectRatio.