TDx_DrawSurface::GetPalette() 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::GETPALETTE()

[ TDx_DrawSurface ] [ next: GetPixelFormat() ] [ prev: GetOverlayPosition() ]

public:
virtual bool __fastcall GetPalette( 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::GetPalette method will retrieve the surface's palette and increment the palette's reference count.

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

PARAMETERS

Top See Also

Palette
The Palette parameter will reference the retrieved palette if this method returns successfully.
NULL will be returned if there is no palette associated with the surface.