Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiCopyChannel

Syntax

class IwiCopyChannelParams: public ::IwiCopyChannelParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiCopyChannelParams, iwiCopyChannel_SetDefaultParams)
    IwiCopyChannelParams() {}
};

IW_DECL_CPP(IppStatus) iwiCopyChannel(
    const IwiImage             &pSrcImage,     
    int                         srcChannel,
    IwiImage                   &dstImage, 
    int                         dstChannel,
    const IwiCopyChannelParams &auxParams   = IwiCopyChannelParams(),
    const IwiTile              &tile        = IwiTile()
);

Parameters

pSrcImage

Pointer to the source image.

srcChannel

Number of source image channels.

pDstImage

Pointer to the destination image.

dstChannel

Number of destination image channels.

tile

Pointer to the IwiTile class for tiling. If NULL, the whole image is processed.

Description

This function copies the selected channel from one multi-channel image to another.

Return Values

ippStsNoErr

No errors.

Exception Values

ippStsNotSupportedModeErr

Specified combination of parameters' values is not supported.

ippStsNumChannelsErr

The channels value is illegal.

ippStsSizeErr

Values of the size fields are illegal.

ippStsInplaceModeNotSupportedErr

In-place operation is not supported: pSrc is equal to pDst.

ippStsNullPtrErr

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