ID2D1CommandSink::FillOpacityMask method (d2d1_1.h)
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
[in] opacityMask
Type: ID2D1Bitmap*
The bitmap whose alpha channel will be sampled to define the opacity mask.
[in] brush
Type: ID2D1Brush*
The brush with which to fill the mask.
[in, optional] destinationRectangle
Type: const D2D1_RECT_F*
The destination rectangle in which to fill the mask. If not specified, this is the origin.
[in, optional] sourceRectangle
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 and Platform Update for Windows 7 [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | d2d1_1.h |
| DLL | D2d1.dll |