Intel IPP Integration Wrappers Developer Guide and Reference

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

iwiColorConvert

Syntax

typedef struct _IwiColorConvertParams
{
    int reserved;
} IwiColorConvertParams;
static IW_INLINE void iwiColorConvert_SetDefaultParams(
    IwiColorConvertParams *pParams
);
IW_DECL(IppStatus) iwiColorConvert(
    const IwiImage* const        pSrcImage[],
    IwiColorFmt                  srcFormat,
    IwiImage* const              pDstImage[],
    IwiColorFmt                  dstFormat,
    Ipp64f                       alphaVal,
    const IwiColorConvertParams *pAuxParams, 
    const IwiTile               *pTile
);

Parameters

pSrcImage[]

Pointer to an array of pointers to the source images.

srcFormat

Color format of the source images.

pDstImage[]

Pointer to an array of pointers to the destination images.

dstFormat

Color format of the destination images.

alphaVal

Value to set new alpha channels to if new alpha channels are to be created.

pAuxParams

Pointer to the auxiliary parameters structure. If NULL, default parameters are used.

pTile

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

Auxiliary Arguments

Argument Default Value Description

reserved

0

Reserved value.

Description

This function performs conversion between all supported color formats. For more information about the supported color models and conversion process, refer to Color Conversion.

This function supports the following features:

Feature Support
Internal threading No
Manual tiling Yes
IwiTile simple tiling Yes
IwiTile pipeline tiling Yes

Return Values

ippStsNoErr

No errors.

ippStsSizeErr

Values of the size fields are illegal.

ippStsInplaceModeNotSupportedErr

In-place operation is not supported: pSrcImage[] is equal to pDstImage[].

ippStsNullPtrErr

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