Skip to content

TextStudioWritingConfiguration

StructTextStudioTextStudio
public struct TextStudioWritingConfiguration

Reusable writing appearance and playback settings.

TextStudioWritingConfiguration(TextStudioWritingMode, TextStudioWritingDirection, Color, float, float, float, float, float, bool, TextStudioWritingStrokeCap, TextStudioWritingStrokeJoin, float, TextStudioReducedMotionBehavior, TextStudioWriting3DMode, float, float, int, TextStudioWritingBrush)

Section titled “TextStudioWritingConfiguration(TextStudioWritingMode, TextStudioWritingDirection, Color, float, float, float, float, float, bool, TextStudioWritingStrokeCap, TextStudioWritingStrokeJoin, float, TextStudioReducedMotionBehavior, TextStudioWriting3DMode, float, float, int, TextStudioWritingBrush)”
public TextStudioWritingConfiguration(TextStudioWritingMode mode, TextStudioWritingDirection direction, Color color, float width = 0.08, float edgeSoftness = 0.02, float strokeGap = 0.02, float fillStart = 0.72, float fillDuration = 0.28, bool reverse = false, TextStudioWritingStrokeCap cap = TextStudioWritingStrokeCap.Round, TextStudioWritingStrokeJoin join = TextStudioWritingStrokeJoin.Round, float miterLimit = 4, TextStudioReducedMotionBehavior reducedMotionBehavior = TextStudioReducedMotionBehavior.Reduce, TextStudioWriting3DMode threeDMode = TextStudioWriting3DMode.SurfaceReveal, float threeDSurfaceOffset = 0.002, float threeDReliefDepth = 0.025, int threeDRadialSegments = 8, TextStudioWritingBrush brush = TextStudioWritingBrush.Solid)

Creates authored writing settings for brush appearance, stroke geometry, reveal timing, reduced motion, and 3D presentation.

Parameters

NameType
modeTextStudio.TextStudioWritingMode
directionTextStudio.TextStudioWritingDirection
colorUnityEngine.Color
widthSystem.Single
edgeSoftnessSystem.Single
strokeGapSystem.Single
fillStartSystem.Single
fillDurationSystem.Single
reverseSystem.Boolean
capTextStudio.TextStudioWritingStrokeCap
joinTextStudio.TextStudioWritingStrokeJoin
miterLimitSystem.Single
reducedMotionBehaviorTextStudio.TextStudioReducedMotionBehavior
threeDModeTextStudio.TextStudioWriting3DMode
threeDSurfaceOffsetSystem.Single
threeDReliefDepthSystem.Single
threeDRadialSegmentsSystem.Int32
brushTextStudio.TextStudioWritingBrush

public TextStudioWritingConfiguration WithColor(Color color)

Returns a copy that draws its strokes in color and keeps every other setting.

Parameters

NameType
colorUnityEngine.Color

Returns

TextStudio.TextStudioWritingConfiguration

public TextStudioWritingMode Mode { get; }

Returns

TextStudio.TextStudioWritingMode

public TextStudioWritingDirection Direction { get; }

Returns

TextStudio.TextStudioWritingDirection

public TextStudioWritingBrush Brush { get; }

Returns

TextStudio.TextStudioWritingBrush

public TextStudioWritingStrokeCap Cap { get; }

Returns

TextStudio.TextStudioWritingStrokeCap

public TextStudioWritingStrokeJoin Join { get; }

Returns

TextStudio.TextStudioWritingStrokeJoin

public TextStudioReducedMotionBehavior ReducedMotionBehavior { get; }

Returns

TextStudio.TextStudioReducedMotionBehavior

public Color Color { get; }

Returns

UnityEngine.Color

public float Width { get; }

Returns

System.Single

public float EdgeSoftness { get; }

Returns

System.Single

public float StrokeGap { get; }

Returns

System.Single

public float FillStart { get; }

Returns

System.Single

public float FillDuration { get; }

Returns

System.Single

public float MiterLimit { get; }

Returns

System.Single

public bool Reverse { get; }

Returns

System.Boolean

public TextStudioWriting3DMode ThreeDMode { get; }

Returns

TextStudio.TextStudioWriting3DMode

public float ThreeDSurfaceOffset { get; }

Returns

System.Single

public float ThreeDReliefDepth { get; }

Returns

System.Single

public int ThreeDRadialSegments { get; }

Returns

System.Int32

public static TextStudioWritingConfiguration Default { get; }

Returns

TextStudio.TextStudioWritingConfiguration