The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
IWICPixelFormatInfo::GetChannelMask method
Gets the pixel format's channel mask.
Syntax
HRESULT GetChannelMask( [in] UINT uiChannelIndex, [in] UINT cbMaskBuffer, [in, out] BYTE *pbMaskBuffer, [out] UINT *pcbActual );
Parameters
- uiChannelIndex [in]
-
Type: UINT
The index to the channel mask to retrieve.
- cbMaskBuffer [in]
-
Type: UINT
The size of the pbMaskBuffer buffer.
- pbMaskBuffer [in, out]
-
Type: BYTE*
Pointer to the mask buffer.
- pcbActual [out]
-
Type: UINT*
The actual buffer size needed to obtain the channel mask.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
If 0 and NULL are passed in for cbMaskBuffer and pbMaskBuffer, respectively, the required buffer size will be returned through pcbActual.
Requirements
|
Minimum supported client |
Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps | Windows Store apps] |
|
Header |
|
|
IDL |
|
|
Library |
|
Show: