Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiMulC

Syntax

class IwiMulCParams: public ::IwiMulCParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiMulCParams, iwiMulC_SetDefaultParams)
    IwiMulCParams(int _scaleFactor = 0, IppHintAlgorithm _algoMode = ippAlgHintNone, IppRoundMode _round = ippRndNear, IwiChDescriptor _chDesc = iwiChDesc_None);
};
IW_DECL_CPP(IppStatus) iwiMulC(
    IwValueFloat         values,                        
    const IwiImage      &srcImage,                      
    IwiImage            &dstImage,                      
    const IwiMulCParams &auxParams  = IwiMulCParams(),  
    const IwiTile       &tile       = IwiTile()         
)

Parameters

values

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

srcImage

Reference to the second image.

dstImage

Reference to the resulting image (can be the same as srcImage).

auxParams

Reference to the auxiliary parameters structure.

tile

Reference to the IwiTile structure for tiling. By default, no tiling is applied.

Auxiliary Arguments

Argument Default Value Description

roundMode

IppRndNear

Rounding mode.

algoMode

IppAlgHintNone

Accuracy mode.

scaleFactor

0

Scale factor.

chDesc

iwiChDesc_None

Special channels processing mode.

Description

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

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

ippStsNoErr

No errors.

Exception 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 references (except tile) is NULL.