ID2D1CommandSink::FillOpacityMask method
Fills an opacity mask on the command sink.
Syntax
HRESULT FillOpacityMask( [in] ID2D1Bitmap *opacityMask, [in] ID2D1Brush *brush, [in, optional] const D2D1_RECT_F *destinationRectangle, [in, optional] const D2D1_RECT_F *sourceRectangle );
Parameters
- opacityMask [in]
-
Type: ID2D1Bitmap*
The bitmap whose alpha channel will be sampled to define the opacity mask.
- brush [in]
-
Type: ID2D1Brush*
The brush with which to fill the mask.
- destinationRectangle [in, optional]
-
Type: const D2D1_RECT_F*
The destination rectangle in which to fill the mask. If not specified, this is the origin.
- sourceRectangle [in, optional]
-
Type: const D2D1_RECT_F*
The source rectangle within the opacity mask. If not specified, this is the entire mask.
Return value
Type: HRESULT
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
Remarks
The opacity mask bitmap must be considered to be clamped on each axis.
Requirements
|
Minimum supported client |
Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps] |
|
Minimum supported phone |
Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps] |
|
Header |
|
|
DLL |
|
See also