Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiCopy

Syntax

class IwiCopyParams: public ::IwiCopyParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiCopyParams, iwiCopy_SetDefaultParams)
    IwiCopyParams() {}
};

IW_DECL_CPP(IppStatus) iwiCopy(
    const IwiImage      &srcImage,      
    IwiImage            &dstImage,     
    const IwiImage      &maskImage  = IwiImage(),  
    const IwiCopyParams &auxParams  = IwiCopyParams(),
    const IwiTile       &tile       = IwiTile()   
);

Parameters

srcImage

Reference to the source image.

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 copies image data from the source to destination image with masking.

If the mask image is empty, the function performs regular copying. Otherwise, the function copies source image pixel values if the corresponding values of the mask image pixels are non-zero.

Return Values

ippStsNoErr

No errors.

Exception Values

ippStsNotSupportedModeErr

Specified combination of parameters' values is not supported.

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.