Microsoft DirectX 9.0

IDirect3DDevice9::GetPaletteEntries Method


Retrieves palette entries.

Syntax

HRESULT GetPaletteEntries(      

    UINT PaletteNumber,     PALETTEENTRY *pEntries );

Parameters

PaletteNumber
[in] An ordinal value identifying the particular palette to retrieve.
pEntries
[in, out] Pointer to a PALETTEENTRY structure, representing the returned palette entries.

Return Value

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 Microsoft® Platform Software Development Kit (SDK).

Note  As of Microsoft DirectX® 9.0, 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 palletized formats.

See Also

IDirect3DDevice9::GetCurrentTexturePalette, IDirect3DDevice9::SetCurrentTexturePalette, IDirect3DDevice9::SetPaletteEntries, Texture Palettes


© 2002 Microsoft Corporation. All rights reserved.