IOverlay::SetPalette method (strmif.h)

The SetPalette method sets the palette.

Syntax

HRESULT SetPalette(
  DWORD        dwColors,
  PALETTEENTRY *pPalette
);

Parameters

dwColors

Number of colors present.

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

   
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

IOverlay Interface