Intel IPP Integration Wrappers Developer Guide and Reference

ID 751823
Date 1/18/2023
Public
Document Table of Contents

iwiScale

Syntax

IW_DECL(IppStatus) iwiScale(
    const IwiImage         *pSrcImage,  
    IwiImage               *pDstImage, 
    Ipp64f                  mulVal,     
    Ipp64f                  addVal,     
    const IwiScaleParams   *pAuxParams,     
    const IwiTile          *pTile       
);

Parameters

pSrcImage

Pointer to the source image.

pDstImage

Pointer to the destination image.

mulVal

Value of the multiplier used for scaling.

addVal

Offset value for scaling.

pAuxParams

Pointer to the auxiliary parameters structure. If NULL, default parameters are used.

pTile

Pointer to the IwiTile structure for tiling. If NULL, the whole image is processed.

Auxiliary Arguments

Argument Default Value Description

algoMode

ippAlgHintNone

Option to select the algorithmic implementation of the function.

Description

This function converts the source image from one data type to another with the specified scaling and shifting parameters. The operation is performed by the following formula: dst=saturate(src*mulVal+addVal).

This function supports the following features:

Feature Support
Internal threading No
Manual tiling Yes
IwiTile simple tiling Yes
IwiTile pipeline tiling Yes

Return Values

ippStsDataTypeErr

The dataType value is illegal.

ippStsSizeErr

Values of the size fields are illegal.

ippStsInplaceModeNotSupportedErr

In-place operation is not supported: pSrc is equal to pDst.

ippStsNullPtrErr

At least one of the pointers (except pTile) is NULL.

ippStsNoErr

No errors.