XLATEOBJ_cGetPalette

ULONG XLATEOBJ_cGetPalette(

    IN XLATEOBJ  *pxlo,
   IN ULONG  iPal,
   IN ULONG  cPal,
   IN ULONG  *pPal
  );

XLATEOBJ_cGetPalette retrieves RGB colors from the specified PAL_INDEXED palette.

Parameters

pxlo

Points to a XLATEOBJ structure.

iPal

Identifies the palette to be written. This parameter can be one of the following values:

Value Meaning
XO_SRCPALETTE Source palette
XO_DESTPALETTE Destination palette

cPal

Specifies the number of entries in the buffer pointed to by pPal. This can be smaller than the total size of the palette.

pPal

Points to a buffer where the palette entries are to be written. Each entry is a 24-bit RGB value. Each RGB value is relative to the calibration data for the palette that specifies how a palette RGB value is related to a device-independent color space. 

Return Value

XLATEOBJ_cGetPalette returns the number of palette entries written if pPal is not null. If pPal is null, the return value is the total number of entries in the palette. A value of zero is returned if XLATEOBJ is null or its palette is invalid.

Comments

The driver needs to know the palette to perform some methods of color blending.

See Also

XLATEOBJ