LayerParameters function (d2d1helper.h)

Creates a D2D1_LAYER_PARAMETERS structure.

Syntax

D2D1_LAYER_PARAMETERS LayerParameters(
  [in, ref]      const D2D1_RECT_F & contentBounds,
  [in, optional] ID2D1Geometry       *geometricMask,
                 D2D1_ANTIALIAS_MODE maskAntialiasMode,
                 D2D1_MATRIX_3X2_F   maskTransform,
                 FLOAT               opacity,
                 ID2D1Brush          *opacityBrush,
                 D2D1_LAYER_OPTIONS  layerOptions
);

Parameters

[in, ref] contentBounds

Type: const D2D1_RECT_F

The content bounds of the layer. Content outside these bounds is not guaranteed to render. The default value is D2D1::InfiniteRect.

[in, optional] geometricMask

Type: ID2D1Geometry*

A mask that specifies the area of the layer that is composited into the render target, or NULL. The default value is NULL.

maskAntialiasMode

Type: D2D1_ANTIALIAS_MODE

A value that specifies the antialiasing mode for the geometric mask. The default value is D2D1_ANTIALIAS_MODE_PER_PRIMITIVE.

maskTransform

Type: D2D1_MATRIX_3X2_F

A value that specifies the transform that is applied to the geometric mask when composing the layer. The default value is D2D1::IdentityMatrix.

opacity

Type: FLOAT

An opacity that is applied uniformly to all resources in the layer when compositing to the target. The default value is 1.0.

opacityBrush

Type: ID2D1Brush*

A brush that is used to alter the opacity of the layer. The brush is mapped to the layer, and the alpha channel of each mapped brush pixel is multiplied by the corresponding layer pixel. The default value is NULL.

layerOptions

Type: D2D1_LAYER_OPTIONS

A value that specifies whether the layer intends to render text with ClearType antialiasing. The default value is D2D1_LAYER_OPTIONS_NONE.

Return value

Type: D2D1_LAYER_PARAMETERS

A structure that contains the content bounds, mask information, opacity settings, and other options for a layer resource.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform	Windows
Header	d2d1helper.h
Library	D2d1.lib
DLL	D2d1.dll

See also

D2D1_ANTIALIAS_MODE

D2D1_LAYER_OPTIONS

D2D1_LAYER_PARAMETERS

ID2D1Brush

Layers Overview