Edit

CImageDisplay.CheckPaletteHeader method

  • 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 CheckPaletteHeader method validates the palette entries in a VIDEOINFO structure.

Syntax

BOOL CheckPaletteHeader(
   const VIDEOINFO *pInput
);

Parameters

pInput

Pointer to a VIDEOINFO structure.

Return value

Returns TRUE if the palette entries are valid, or FALSE otherwise.

Remarks

If the image format is not palettized, the method verifies that biClrUsed equals zero. Otherwise, the method verifies that the biCompression flag is BI_RGB; biClrImportant is not greater than biClrUsed; and the number of palette entries does not exceed the maximum, given the color depth.

Requirements

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

See also

CImageDisplay Class