cbasecontrolwindow-get-backgroundpalette.md

description	ms.assetid	title	ms.topic	ms.date	topic_type	api_name	api_type	api_location	ms.custom
The get\_BackgroundPalette method retrieves the realized palette in the background flag.	cc649dbd-d049-4993-b187-4e297bef5152	CBaseControlWindow.get_BackgroundPalette method (Ctlutil.h)	reference	4/26/2023	APIRef kbSyntax	CBaseControlWindow.get_BackgroundPalette	COM	Strmbase.lib Strmbase.dll Strmbasd.lib Strmbasd.dll	UpdateFrequency5

CBaseControlWindow.get_BackgroundPalette method

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

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.

Requirements

Requirement	Value
Header	Ctlutil.h (include Streams.h)
Library	Strmbase.lib (retail builds); Strmbasd.lib (debug builds)

See also

CBaseControlWindow Class