Skip to content

TextStudio2DStrokeSpec

StructTextStudioTextStudio
public struct TextStudio2DStrokeSpec

Settings for stroke width, alignment, joins, dashes, edge softness, and measurement units.

TextStudio2DStrokeSpec(float, float, TextStudio2DStrokeJoin, float, float[], float, float, TextStudio2DUnit, TextStudio2DLineCap, bool)

Section titled “TextStudio2DStrokeSpec(float, float, TextStudio2DStrokeJoin, float, float[], float, float, TextStudio2DUnit, TextStudio2DLineCap, bool)”
public TextStudio2DStrokeSpec(float width, float alignment = 0, TextStudio2DStrokeJoin join = TextStudio2DStrokeJoin.Round, float miterLimit = 4, float[] dashPattern = null, float dashOffset = 0, float softness = 0, TextStudio2DUnit units = TextStudio2DUnit.Em, TextStudio2DLineCap dashCap = TextStudio2DLineCap.Butt, bool continueAcrossContours = false)

Creates a stroke specification with copied dash lengths and the supplied outline, softness, unit, and contour settings.

Parameters

NameType
widthSystem.Single
alignmentSystem.Single
joinTextStudio.TextStudio2DStrokeJoin
miterLimitSystem.Single
dashPatternSystem.Single[]
dashOffsetSystem.Single
softnessSystem.Single
unitsTextStudio.TextStudio2DUnit
dashCapTextStudio.TextStudio2DLineCap
continueAcrossContoursSystem.Boolean

public TextStudio2DStrokeSpec WithAlignment(float alignment)

Returns a stroke copy with the supplied alignment from inside through centered to outside.

Parameters

NameType
alignmentSystem.Single

Returns

TextStudio.TextStudio2DStrokeSpec

public TextStudio2DStrokeSpec WithSoftness(float softness)

Returns a stroke copy with the supplied edge softness.

Parameters

NameType
softnessSystem.Single

Returns

TextStudio.TextStudio2DStrokeSpec

public TextStudio2DStrokeSpec WithUnits(TextStudio2DUnit units)

Returns a stroke copy using the supplied measurement units.

Parameters

NameType
unitsTextStudio.TextStudio2DUnit

Returns

TextStudio.TextStudio2DStrokeSpec

public float GetDash(int index)

Returns the dash or gap length at the specified index, throwing if the index is outside the pattern array.

Parameters

NameType
indexSystem.Int32

Returns

System.Single

public float Width { get; }

Returns

System.Single

public float Alignment { get; }

Alignment from -1 inside through 0 centered to +1 outside.

Returns

System.Single

public TextStudio2DStrokeJoin Join { get; }

Returns

TextStudio.TextStudio2DStrokeJoin

public float MiterLimit { get; }

Returns

System.Single

public int DashCount { get; }

Returns

System.Int32

public float DashOffset { get; }

Returns

System.Single

public TextStudio2DLineCap DashCap { get; }

Returns

TextStudio.TextStudio2DLineCap

public bool ContinueAcrossContours { get; }

Returns

System.Boolean

public float Softness { get; }

Returns

System.Single

public TextStudio2DUnit Units { get; }

Returns

TextStudio.TextStudio2DUnit