IOverlay::SetPalette 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 SetPalette method sets the palette.
Syntax
HRESULT SetPalette(
[in] DWORD dwColors,
[in] PALETTEENTRY *pPalette
);
Parameters
[in] dwColors
Number of colors present.
[in] pPalette
Pointer to colors to use for the palette.
Return value
Returns S_OK if successful. If the method fails, it returns an HRESULT error code.
Remarks
This method sets a logical palette for the window. The window is not guaranteed to always have the colors requested in the actual system device palette. The Microsoft® Windows® operating system only guarantees those colors when the window is the foreground active window. The current device palette can be obtained by calling IOverlay::GetPalette.
If the device does not have a palette, it returns VFW_E_NO_DISPLAY_PALETTE.
The Overlay Mixer filter returns E_NOTIMPL.
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 |