Struct D2D1StrokeStyleProperties

Describes the stroke that outlines a shape.

Implements

IEquatable<D2D1StrokeStyleProperties>

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 D2D1StrokeStyleProperties : IEquatable<D2D1StrokeStyleProperties>

Constructors

D2D1StrokeStyleProperties(D2D1CapStyle, D2D1CapStyle, D2D1CapStyle, D2D1LineJoin, float, D2D1DashStyle, float)

Initializes a new instance of the D2D1StrokeStyleProperties struct.

Declaration

public D2D1StrokeStyleProperties(D2D1CapStyle startCap, D2D1CapStyle endCap, D2D1CapStyle dashCap, D2D1LineJoin lineJoin, float miterLimit, D2D1DashStyle dashStyle, float dashOffset)

Parameters

Type	Name	Description
D2D1CapStyle	startCap	The cap applied to the start of all the open figures in a stroked geometry.
D2D1CapStyle	endCap	The cap applied to the end of all the open figures in a stroked geometry.
D2D1CapStyle	dashCap	The shape at either end of each dash segment.
D2D1LineJoin	lineJoin	A value that describes how segments are joined.
float	miterLimit	The limit of the thickness of the join on a mitered corner. This value is always treated as though it is greater than or equal to 1.0f.
D2D1DashStyle	dashStyle	A value that specifies whether the stroke has a dash pattern and, if so, the dash style.
float	dashOffset	A value that specifies an offset in the dash sequence. A positive dash offset value shifts the dash pattern, in units of stroke width, toward the start of the stroked geometry. A negative dash offset value shifts the dash pattern, in units of stroke width, toward the end of the stroked geometry.

Properties

DashCap

Gets or sets the shape at either end of each dash segment.

Declaration

public D2D1CapStyle DashCap { get; set; }

Property Value

Type	Description
D2D1CapStyle

DashOffset

Gets or sets a value that specifies an offset in the dash sequence. A positive dash offset value shifts the dash pattern, in units of stroke width, toward the start of the stroked geometry. A negative dash offset value shifts the dash pattern, in units of stroke width, toward the end of the stroked geometry.

Declaration

public float DashOffset { get; set; }

Property Value

Type	Description
float

DashStyle

Gets or sets a value that specifies whether the stroke has a dash pattern and, if so, the dash style.

Declaration

public D2D1DashStyle DashStyle { get; set; }

Property Value

Type	Description
D2D1DashStyle

Default

Gets default properties (Flat, Flat, Flat, Miter, 10, Solid, 0).

Declaration

public static D2D1StrokeStyleProperties Default { get; }

Property Value

Type	Description
D2D1StrokeStyleProperties

EndCap

Gets or sets the cap applied to the end of all the open figures in a stroked geometry.

Declaration

public D2D1CapStyle EndCap { get; set; }

Property Value

Type	Description
D2D1CapStyle

LineJoin

Gets or sets a value that describes how segments are joined.

Declaration

public D2D1LineJoin LineJoin { get; set; }

Property Value

Type	Description
D2D1LineJoin

MiterLimit

Gets or sets the limit of the thickness of the join on a mitered corner. This value is always treated as though it is greater than or equal to 1.0f.

Declaration

public float MiterLimit { get; set; }

Property Value

Type	Description
float

StartCap

Gets or sets the cap applied to the start of all the open figures in a stroked geometry.

Declaration

public D2D1CapStyle StartCap { get; set; }

Property Value

Type	Description
D2D1CapStyle

Methods

Equals(D2D1StrokeStyleProperties)

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

Declaration

public bool Equals(D2D1StrokeStyleProperties other)

Parameters

Type	Name	Description
D2D1StrokeStyleProperties	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 ==(D2D1StrokeStyleProperties, D2D1StrokeStyleProperties)

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

Declaration

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

Parameters

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

Returns

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

operator !=(D2D1StrokeStyleProperties, D2D1StrokeStyleProperties)

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

Declaration

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

Parameters

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

Returns

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

Implements

IEquatable<T>