Struct D2D1LayerParameters

Contains the content bounds, mask information, opacity settings, and other options for a layer resource.

Implements

IEquatable<D2D1LayerParameters>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.D2D1

Assembly: JeremyAnsel.DirectX.D2D1.dll

Syntax

public struct D2D1LayerParameters : IEquatable<D2D1LayerParameters>

Constructors

D2D1LayerParameters(D2D1RectF, D2D1Geometry, D2D1AntialiasMode, D2D1Matrix3X2F, float, D2D1Brush, D2D1LayerOptions)

Initializes a new instance of the D2D1LayerParameters struct.

Declaration

public D2D1LayerParameters(D2D1RectF contentBounds, D2D1Geometry geometricMask, D2D1AntialiasMode maskAntialiasMode, D2D1Matrix3X2F maskTransform, float opacity, D2D1Brush opacityBrush, D2D1LayerOptions layerOptions)

Parameters

Type	Name	Description
D2D1RectF	contentBounds	The content bounds of the layer. Content outside these bounds is not guaranteed to render.
D2D1Geometry	geometricMask	The geometric mask specifies the area of the layer that is composited into the render target.
D2D1AntialiasMode	maskAntialiasMode	A value that specifies the antialiasing mode for the geometricMask.
D2D1Matrix3X2F	maskTransform	A value that specifies the transform that is applied to the geometric mask when composing the layer.
float	opacity	An opacity value that is applied uniformly to all resources in the layer when compositing to the target.
D2D1Brush	opacityBrush	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.
D2D1LayerOptions	layerOptions	A value that specifies whether the layer intends to render text with ClearType antialiasing.

Properties

ContentBounds

Gets or sets the content bounds of the layer. Content outside these bounds is not guaranteed to render.

Declaration

public D2D1RectF ContentBounds { get; set; }

Property Value

Type	Description
D2D1RectF

Default

Gets default parameters.

Declaration

public static D2D1LayerParameters Default { get; }

Property Value

Type	Description
D2D1LayerParameters

GeometricMask

Gets or sets the geometric mask specifies the area of the layer that is composited into the render target.

Declaration

public D2D1Geometry GeometricMask { get; set; }

Property Value

Type	Description
D2D1Geometry

LayerOptions

Gets or sets a value that specifies whether the layer intends to render text with ClearType antialiasing.

Declaration

public D2D1LayerOptions LayerOptions { get; set; }

Property Value

Type	Description
D2D1LayerOptions

MaskAntialiasMode

Gets or sets a value that specifies the antialiasing mode for the geometricMask.

Declaration

public D2D1AntialiasMode MaskAntialiasMode { get; set; }

Property Value

Type	Description
D2D1AntialiasMode

MaskTransform

Gets or sets a value that specifies the transform that is applied to the geometric mask when composing the layer.

Declaration

public D2D1Matrix3X2F MaskTransform { get; set; }

Property Value

Type	Description
D2D1Matrix3X2F

Opacity

Gets or sets an opacity value that is applied uniformly to all resources in the layer when compositing to the target.

Declaration

public float Opacity { get; set; }

Property Value

Type	Description
float

OpacityBrush

Gets or sets 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.

Declaration

public D2D1Brush OpacityBrush { get; set; }

Property Value

Type	Description
D2D1Brush

Methods

Equals(D2D1LayerParameters)

Determines whether the specified object is equal to the current object.

Declaration

public bool Equals(D2D1LayerParameters other)

Parameters

Type	Name	Description
D2D1LayerParameters	other	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

Operators

operator ==(D2D1LayerParameters, D2D1LayerParameters)

Compares two D2D1LayerParameters objects. The result specifies whether the values of the two objects are equal.

Declaration

public static bool operator ==(D2D1LayerParameters left, D2D1LayerParameters right)

Parameters

Type	Name	Description
D2D1LayerParameters	left	The left D2D1LayerParameters to compare.
D2D1LayerParameters	right	The right D2D1LayerParameters to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

operator !=(D2D1LayerParameters, D2D1LayerParameters)

Compares two D2D1LayerParameters objects. The result specifies whether the values of the two objects are unequal.

Declaration

public static bool operator !=(D2D1LayerParameters left, D2D1LayerParameters right)

Parameters

Type	Name	Description
D2D1LayerParameters	left	The left D2D1LayerParameters to compare.
D2D1LayerParameters	right	The right D2D1LayerParameters to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>