Microsoft DirectX 9.0

CBaseControlWindow::get_BackgroundPalette

The get_BackgroundPalette method retrieves the realized palette in the background flag.

Syntax

HRESULT get_BackgroundPalette(
    long *pBackgroundPalette
);

Parameters

pBackgroundPalette

Pointer to an Automation Boolean flag (0 is off, –1 is on).

Return Value

Returns an HRESULT value.

Remarks

This member function implements the IVideoWindow::get_BackgroundPalette method. If a video will be played within another application or document, the application might want to use its own palette. It can ask that the video use the current foreground palette rather than its own by setting this flag to –1. If this is set to 0, the window will install and realize its own preferred palette. Note that asking the window to use a different palette will cause severe performance penalties.

See Also