Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiSetChannel

Syntax

class IwiSetChannelParams: public ::IwiSetChannelParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiSetChannelParams, iwiSetChannel_SetDefaultParams)
    IwiSetChannelParams() {}
};

IW_DECL_CPP(IppStatus) iwiSetChannel(
    double                      value,            
    IwiImage                   &dstImage,      
    int                         channelNum,       
    const IwiSetChannelParams  &auxParams   = IwiSetChannelParams(),
    const IwiTile              &tile        = IwiTile() 
);

Parameters

value

Values to set to the selected channel.

dstImage

Reference to the destination image.

channelNum

Number of the channel to set the specified value to.

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 the selected channel to the specified value.

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.