Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiColorConvert

Syntax

class IwiColorConvertParams: public ::IwiColorConvertParams
{
public:
    IW_BASE_PARAMS_CONSTRUCTORS(IwiColorConvertParams, iwiColorConvert_SetDefaultParams)
    IwiColorConvertParams() {}
};
IW_DECL_CPP(IppStatus) iwiColorConvert(
    const IwiImageArray         &srcImages,
    IwiColorFmt                  srcFormat,
    IwiImageArray               &dstImages,
    IwiColorFmt                  dstFormat,
    Ipp64f                       alphaVal   = IwValueMax,
    const IwiColorConvertParams &auxParams  = IwiColorConvertParams(),
    const IwiTile               &tile       = IwiTile()
);

Parameters

srcImages

The array object of source images.

srcFormat

Color format of the source images.

dstImages

The array object of destination images.

dstFormat

Color format of the destination images.

alphaVal

Value to set to the alpha channel in case of X->XA conversion.

auxParams

Reference to the auxiliary parameters structure.

tile

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

Description

This function performs conversion between basic color formats: Gray, RGB, BGR, RGBA, BGRA. For more information about the supported color models and conversion process, refer to Color Conversion.

Exception Values

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.

Return Values

ippStsNoErr

No errors.