WcsTranslateColors function

The WcsTranslateColors function translates an array of colors from the source color space to the destination color space as defined by a color transform.

Syntax


BOOL WcsTranslateColors(
  _In_  HTRANSFORM    hColorTransform,
  _In_  DWORD         nColors,
  _In_  DWORD         nInputChannels,
  _In_  COLORDATATYPE cdtInput,
  _In_  DWORD         cbInput,
  _In_  PVOID         pInputData,
  _In_  DWORD         nOutputChannels,
  _In_  COLORDATATYPE cdtOutput,
  _In_  DWORD         cbOutput,
  _Out_ PVOID         pOutputData
);

Parameters

hColorTransform [in]

A handle to the WCS color transform to use.

nColors [in]

The number of elements in the array pointed to by pInputData and pOutputData.

nInputChannels [in]

The number of channels per element in the array pointed to by pInputData.

cdtInput [in]

The input COLORDATATYPE color data type.

cbInput [in]

The buffer size, in bytes, of pInputData.

pInputData [in]

A pointer to an array of input colors.

nOutputChannels [in]

The number of channels per element in the array pointed to by pOutputData.

cdtOutput [in]

The output COLORDATATYPE color data type.

cbOutput [in]

The buffer size, in bytes, of pOutputData.

pOutputData [out]

A pointer to an array of colors that receives the results of the color translation.

If this function succeeds, the return value is TRUE.

If this function fails, the return value is FALSE. For extended error information, call GetLastError (described in the Microsoft Windows SDK documentation).

This function will fail if an ICC transform is used.

Remarks

If the input and the output color data types are not compatible with the color transform, this function will fail.

Requirements

Target platform

Universal

Version

Included in Windows Vista and later.

Header

Icm.h

Library

Mscms.lib

DLL

Mscms.dll

See also

COLORDATATYPE

 

 

Send comments about this topic to Microsoft

Show: