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)

Declaration

public readonly bool Equals(D2D1StrokeStyleProperties other)

Parameters

Type	Name	Description
D2D1StrokeStyleProperties	other

Returns

Type	Description
bool

Equals(object?)

Declaration

public override readonly bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

NativeReadFrom(nint)

Declaration

public static D2D1StrokeStyleProperties NativeReadFrom(nint buffer)

Parameters

Type	Name	Description
nint	buffer

Returns

Type	Description
D2D1StrokeStyleProperties

NativeReadFrom(nint, Span<D2D1StrokeStyleProperties>)

Declaration

public static void NativeReadFrom(nint buffer, Span<D2D1StrokeStyleProperties> objects)

Parameters

Type	Name	Description
nint	buffer
Span<D2D1StrokeStyleProperties>	objects

NativeRequiredSize()

Declaration

public static int NativeRequiredSize()

Returns

Type	Description
int

NativeRequiredSize(int)

Declaration

public static int NativeRequiredSize(int count)

Parameters

Type	Name	Description
int	count

Returns

Type	Description
int

NativeWriteTo(nint, in D2D1StrokeStyleProperties)

Declaration

public static void NativeWriteTo(nint buffer, in D2D1StrokeStyleProperties obj)

Parameters

Type	Name	Description
nint	buffer
D2D1StrokeStyleProperties	obj

NativeWriteTo(nint, ReadOnlySpan<D2D1StrokeStyleProperties>)

Declaration

public static void NativeWriteTo(nint buffer, ReadOnlySpan<D2D1StrokeStyleProperties> objects)

Parameters

Type	Name	Description
nint	buffer
ReadOnlySpan<D2D1StrokeStyleProperties>	objects

Operators

operator ==(D2D1StrokeStyleProperties, D2D1StrokeStyleProperties)

Declaration

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

Parameters

Type	Name	Description
D2D1StrokeStyleProperties	left
D2D1StrokeStyleProperties	right

Returns

Type	Description
bool

operator !=(D2D1StrokeStyleProperties, D2D1StrokeStyleProperties)

Declaration

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

Parameters

Type	Name	Description
D2D1StrokeStyleProperties	left
D2D1StrokeStyleProperties	right

Returns

Type	Description
bool

Implements

IEquatable<T>