IOverlayNotify::OnPaletteChange method (strmif.h)

[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 OnPaletteChange method provides notification that the palette of the window has changed.

Syntax

HRESULT OnPaletteChange(
  [in] DWORD              dwColors,
  [in] const PALETTEENTRY *pPalette
);

Parameters

[in] dwColors

Number of colors present.

[in] pPalette

Pointer to the array of palette colors.

Return value

Returns S_OK if successful. If the method fails, it returns an HRESULT error code.

Remarks

Before returning, the filter should copy the array of RGBQUAD values, if necessary.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib

See also

Error and Success Codes

IOverlayNotify Interface