Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiSet

Syntax

class IwiSetParams: public ::IwiSetParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiSetParams, iwiSet_SetDefaultParams)
    IwiSetParams() {}
};

IW_DECL_CPP(IppStatus) iwiSet(
    IwValue             values,              
    IwiImage           &dstImage,          
    const IwiImage     &maskImage   = IwiImage(),  
    const IwiSetParams &auxParams   = IwiSetParams(),
    const IwiTile      &tile        = IwiTile()  
);

Parameters

value

Values to set to image channels.

dstImage

Reference to the destination image.

maskImage

Reference to the mask image.

auxParams

Reference to the auxiliary parameters structure.

tile

Reference to the IwiTile object for tiling. By default, no tiling is used.

Description

This function sets image channels to the specified values with masking.

If the mask image is empty, the function performs regular set operation. Otherwise, the function sets image pixel values only if the corresponding values of the mask image pixels are non-zero.

Return Values

ippStsNoErr

No errors.

Exception Values

ippStsDataTypeErr

The dataType value is illegal.

ippStsNumChannelsErr

The channels value is illegal.

ippStsSizeErr

Values of the size fields are illegal.

ippStsNullPtrErr

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