Edit

Share via

ContainsPalette function

  • Article

[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 ContainsPalette function determines whether a specified VIDEOINFOHEADER structure contains a palette.

Syntax

BOOL ContainsPalette(
   const VIDEOINFOHEADER *pVideoInfo

);

Parameters

pVideoInfo

Pointer to a VIDEOINFOHEADER structure.

Return value

Returns TRUE if the bitdepth is 8 or less (bmiHeader.biBitCount), or the number of color indexes is more than zero (bmiHeader.biClrUsed). Returns FALSE otherwise.

Requirements

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

See also

Video and Image Functions