IDirect3DDevice9::SetPaletteEntries

Sets palette entries.

HRESULT SetPaletteEntries(
  UINT PaletteNumber,
  CONST PALETTEENTRY * pEntries
);

Parameters

PaletteNumber

[in] An ordinal value identifying the particular palette upon which the operation is to be performed.

pEntries

[in] Pointer to a PALETTEENTRY structure, representing the palette entries to set. The number of PALETTEENTRY structures pointed to by pEntries is assumed to be 256. See Remarks.

Return Values

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

Remarks

For Direct3D 9 applications, any palette sent to this method must conform to the D3DPTEXTURECAPS_ALPHAPALETTE capability bit of the D3DCAPS9 structure. If D3DPTEXTURECAPS_ALPHAPALETTE is not set, every entry in the palette must have alpha set to 1.0 or this method will fail with D3DERR_INVALIDCALL. If D3DPTEXTURECAPS_ALPHAPALETTE is set, then any set of alpha values are allowed. Note that the debug runtime will print a warning message if all palette entries have alpha set to 0.

A single logical palette is associated with the device, and is shared by all texture stages.

Requirements

Header: Declared in D3d9.h.

See Also

IDirect3DDevice9::GetCurrentTexturePalette, IDirect3DDevice9::GetPaletteEntries, IDirect3DDevice9::SetCurrentTexturePalette, Texture Palettes