Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiMulC

Syntax

typedef struct _IwiMulCParams
{
    IppRoundMode     roundMode;
    IppHintAlgorithm algoMode;
    int              scaleFactor;
    IwiChDescriptor  chDesc;     
} IwiMulCParams;
static IW_INLINE void iwiMulC_SetDefaultParams(
    IwiMulCParams *pParams     
)
IW_DECL(IppStatus) iwiMulC(
    const double        *pValues,    
    const IwiImage      *pSrcImage,  
    IwiImage            *pDstImage,  
    const IwiMulCParams *pAuxParams, 
    const IwiTile       *pTile       
);

Parameters

pValues

Pointer to the array containing values by which the source image is multiplied: one element for each channel.

pSrcImage

Pointer to the second image.

pDstImage

Pointer to the resulting image (can be the same as pSrcImage).

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

roundMode

IppRndNear

Rounding mode.

algoMode

IppAlgHintNone

Accuracy mode.

scaleFactor

0

Scale factor.

chDesc

iwiChDesc_None

IwiChDescriptor value.

Description

This function multiplies an image by a constant value and puts the resulting image to pDstImage.

This function supports the following features:

Feature Support
In-place mode Yes
64-bit sizes No
Internal threading No
Manual tiling Yes
IwsTile simple tiling Yes
IwsTile pipeline tiling Yes

Return Values

ippStsDataTypeErr

The dataType value is illegal.

ippStsNumChannelsErr

The value for channels is illegal.

ippStsSizeErr

Values for size fields are illegal.

ippStsNullPtrErr

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

ippStsNoErr

No errors.