IDirect3DDevice9::GetPaletteEntries method (d3d9helper.h)

Article
08/19/2022
2 minutes to read

Retrieves palette entries.

Syntax

HRESULT GetPaletteEntries(
  [in]      UINT         PaletteNumber,
  [in, out] PALETTEENTRY *pEntries
);

Parameters

[in] PaletteNumber

Type: UINT

An ordinal value identifying the particular palette to retrieve.

[in, out] pEntries

Type: PALETTEENTRY*

Pointer to a PALETTEENTRY structure, representing the returned palette entries.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

For more information about PALETTEENTRY, see the Platform SDK.

Note As of Direct3D 9, the peFlags member of the PALETTEENTRY structure does not work the way it is documented in the Platform SDK. The peFlags member is now the alpha channel for 8-bit palettized formats.

Requirements


Target Platform	Windows
Header	d3d9helper.h (include D3D9.h)
Library	D3D9.lib