Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiSet

Syntax

typedef struct _IwiSetParams
{
    int reserved;
} IwiSetParams;
static IW_INLINE void iwiSet_SetDefaultParams(
    IwiSetParams *pParams
)
IW_DECL(IppStatus) iwiSet(
    const double       *pValues,   
    int                 valuesNum,  
    IwiImage           *pDstImage,  
    const IwiImage     *pMaskImage, 
    const IwiSetParams *pAuxParams,
    const IwiTile      *pTile        
);

Parameters

pValues

Pointer to the array of values. The array must contain one element for each channel.

valuesNum

Number of value elements. If valuesNum is more than the number of channels, exceeding values are ignored. If valuesNum is less than the number of channels, the last value is replicated for the remaining channels.

pDstImage

Pointer to the destination image.

pMaskImage

Pointer to the mask image.

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

reserved

0

Reserved value.

Description

This function sets each channel of the image to an element of thepValue array with masking.

If the mask image is NULL, 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.

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.

ippStsNumChannelsErr

Thechannels value is illegal.

ippStsSizeErr

Values of the size fields are illegal.

ippStsNullPtrErr

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

ippStsNoErr

No errors.