TDx_DrawSurface::SetPalette() Reference

BCB-Tools.com

Home of
RAD DirectX

C++ Builder wrapping DirectX

...

Please Register

So we can
create more

the TDx_Library
the TDx9_Library

TDx_Draw_Library v1.90 Component Reference

Component: TDX_DRAWSURFACE::SETPALETTE()

[ TDx_DrawSurface ] [ next: SetPriority() ] [ prev: SetOverlayPosition() ]

public:
virtual bool __fastcall SetPalette( TDx_DrawPalette* pPalette );

Description
Parameters
See Also

If you would like to submit additions or improvements to this page, click: admin@bcb-tools.com.

DESCRIPTION

Top Parameters See Also

The TDx_DrawSurface::SetPalette method attaches a palette to a surface.

The change will be immediate, without regard to refresh timing.

The initial call to this method will increment the palette's reference count but further calls associating it with the same surface will not further affect the reference count.

Passing NULL to the Palette parameter removes the palette and decrements the palettes reference count. If the surface is released before the palette is removed, the palettes reference count will automatically be decremented. It is the applications responsibility to release further references to the palette if it is no longer needed.

If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_GENERIC
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDPIXELFORMAT
DDERR_INVALIDSURFACETYPE
DDERR_NOEXCLUSIVEMODE
DDERR_NOPALETTEATTACHED
DDERR_NOPALETTEHW
DDERR_NOT8BITCOLOR
DDERR_SURFACELOST
DDERR_UNSUPPORTED

PARAMETERS

Top See Also

Palette
The Palette parameter references the palette that is to be attached.
Set this parameter to NULL to detach the current palette.