cimagedisplay-getcolourmask.md

description	ms.assetid	title	ms.topic	ms.date	topic_type	api_name	api_type	api_location	ms.custom
The GetColourMask method retrieves the color masks for the current display format.	386d0439-8502-411d-935c-3c2153a8b5b4	CImageDisplay.GetColourMask method (Winutil.h)	reference	4/26/2023	APIRef kbSyntax	CImageDisplay.GetColourMask	COM	Strmbase.lib Strmbase.dll Strmbasd.lib Strmbasd.dll	UpdateFrequency5

CImageDisplay.GetColourMask method

[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 GetColourMask method retrieves the color masks for the current display format.

Syntax

BOOL GetColourMask(
   DWORD *pMaskRed,
   DWORD *pMaskGreen,
   DWORD *pMaskBlue
);

Parameters

pMaskRed

Pointer to a variable that receives the red-component mask.

pMaskGreen

Pointer to a variable that receives the green-component mask.

pMaskBlue

Pointer to a variable that receives the blue-component mask.

Return value

Returns TRUE if successful, or FALSE otherwise.

Requirements

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

See also

CImageDisplay Class