Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiSwapChannels

Syntax

class IwiSwapChannelsParams: public ::IwiSwapChannelsParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiSwapChannelsParams, iwiSwapChannels_SetDefaultParams)
    IwiSwapChannelsParams(IwiChDescriptor _chDesc = iwiChDesc_None);
};

IW_DECL_CPP(IppStatus) iwiSwapChannels(
    const IwiImage              &srcImage,
    IwiImage                    &dstImage,
    const IwValueInt            &dstOrder,
    double                       value      = IwValueMax,
    const IwiSwapChannelsParams &auxParams  = IwiSwapChannelsParams(),
    const IwiTile               &tile       = IwiTile()
)

Parameters

srcImage

Reference to the source image.

dstImage

Reference to the start of the destination image data.

dstOrder

Reference to the destination image channel order: dst[channel] = src[dstOrder[channel]].

value

Value to set destination channels to if the number of destination channels is greater than the number of source channels.

auxParams

Reference to the auxiliary parameters structure.

tile

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

Auxiliary Arguments

Argument Default Value Description

chDesc

iwiChDesc_None

Special channels processing mode.

Description

This function swaps image channels, putting them in the order specified in pDstOrder. For more information, refer to the iwiSwapChannels function description in C Reference.

Return Values

ippStsNoErr

No errors.

Exception Values

ippStsChannelOrderErr

The destination order is out of the range.

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 tile) is NULL.