Intel IPP Integration Wrappers Developer Guide and Reference

ID 751823
Date 9/30/2019
Public
Document Table of Contents

iwiMul

Syntax
class IwiMulParams: public ::IwiMulParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiMulParams, iwiMul_SetDefaultParams)
    IwiMulParams(int _scaleFactor = 0, IppHintAlgorithm _algoMode = ippAlgHintNone, IwiChDescriptor _chDesc = iwiChDesc_None);
};
IW_DECL_CPP(IppStatus) iwiMul(
    const IwiImage     &src1Image,                     
    const IwiImage     &src2Image,                     
    IwiImage           &dstImage,                    
    const IwiMulParams &auxParams   = IwiMulParams(),   
    const IwiTile      &tile        = IwiTile()         
)
Parameters

src1Image

Reference to the first multiplied image.

src2Image

Reference to the second multiplied image.

dstImage

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

auxParams

Reference to the auxiliary parameters structure.

tile

Reference to the IwiTile structure for tiling. Be default, no tiling is used.

Auxiliary Arguments
Argument Default Value Description

algoMode

IppAlgHintNone

Accuracy mode.

scaleFactor

0

Scale factor.

chDesc

iwiChDesc_None

Special channels processing mode.

Description

This function multiplies one image by another and puts the resulting image to dstImage.

This function supports the following features:

Feature Support
In-place mode Yes
64-bit sizes Yes
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.

Did you find the information on this page useful?

Characters remaining:

Feedback Message