Edit

Share via

LayerParameters1 function (d2d1_1helper.h)

  • Article

Returns a D2D1_LAYER_PARAMETERS1 struct that contains the content bounds, mask information, opacity settings, and other options for a layer resource.

Syntax

D2D1_LAYER_PARAMETERS1 LayerParameters1(
  [in, ref]      const D2D1_RECT_F & contentBounds,
  [in, optional] ID2D1Geometry       *geometricMask,
                 D2D1_ANTIALIAS_MODE maskAntialiasMode,
                 D2D1_MATRIX_3X2_F   maskTransform,
                 FLOAT               opacity,
  [in, optional] ID2D1Brush          *opacityBrush,
                 D2D1_LAYER_OPTIONS1 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.

[in, optional] geometricMask

Type: ID2D1Geometry*

The geometric mask specifies the area of the layer that is composited into the render target.

maskAntialiasMode

Type: D2D1_ANTIALIAS_MODE

A value that specifies the antialiasing mode for the geometricMask.

maskTransform

Type: D2D1_MATRIX_3X2_F

A value that specifies the transform that is applied to the geometric mask when composing the layer.

opacity

Type: FLOAT

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

[in, optional] opacityBrush

Type: ID2D1Brush*

A brush that is used to modify the opacity of the layer. The brush is mapped to the layer, and the alpha channel of each mapped brush pixel is multiplied against the corresponding layer pixel.

layerOptions

Type: D2D1_LAYER_OPTIONS1

Additional options for the layer creation.

Return value

Type: D2D1_LAYER_PARAMETERS1

The filled layer parameters struct.

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 d2d1_1helper.h
Library D2d1.lib
DLL D2d1.dll