TextStudio2DAnimatedEffectSpec

StructTextStudioTextStudio

public struct TextStudio2DAnimatedEffectSpec

Compact deterministic parameters shared by the animated Appearance family. Playback uses the owning Text Studio presentation clock, so scrubbing, pause, reverse, and reduced motion remain coherent.

Constructors

TextStudio2DAnimatedEffectSpec(TextStudio2DAnimatedEffectKind, TextStudio2DMappingSpace, float, float, float, float, float, float, float, float, Vector2, Color, Color, int, int, TextStudioReducedMotionBehavior)

public TextStudio2DAnimatedEffectSpec(TextStudio2DAnimatedEffectKind kind, TextStudio2DMappingSpace mapping, float amount, float speed, float phase, float scale, float width, float softness, float amplitude, float frequency, Vector2 direction, Color primaryColor, Color secondaryColor, int seed, int historyFrames, TextStudioReducedMotionBehavior reducedMotionBehavior)

Creates an animated-effect specification with the supplied mapping, timing, shape, colors, seed, history, and reduced-motion behavior.

Parameters

Name	Type
kind	TextStudio.TextStudio2DAnimatedEffectKind
mapping	TextStudio.TextStudio2DMappingSpace
amount	System.Single
speed	System.Single
phase	System.Single
scale	System.Single
width	System.Single
softness	System.Single
amplitude	System.Single
frequency	System.Single
direction	UnityEngine.Vector2
primaryColor	UnityEngine.Color
secondaryColor	UnityEngine.Color
seed	System.Int32
historyFrames	System.Int32
reducedMotionBehavior	TextStudio.TextStudioReducedMotionBehavior

Methods

Preset(TextStudio2DAnimatedEffectKind)

public static TextStudio2DAnimatedEffectSpec Preset(TextStudio2DAnimatedEffectKind kind)

Returns a polished deterministic starting point for an animated family.

Parameters

Name	Type
kind	TextStudio.TextStudio2DAnimatedEffectKind

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithTiming(float, float, float)

public TextStudio2DAnimatedEffectSpec WithTiming(float amount, float speed, float phase)

Returns an animated-effect copy with the supplied amount, speed, and phase.

Parameters

Name	Type
amount	System.Single
speed	System.Single
phase	System.Single

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithShape(float, float, float, float, float, Vector2)

public TextStudio2DAnimatedEffectSpec WithShape(float scale, float width, float softness, float amplitude, float frequency, Vector2 direction)

Returns an animated-effect copy with the supplied scale, width, softness, amplitude, frequency, and direction.

Parameters

Name	Type
scale	System.Single
width	System.Single
softness	System.Single
amplitude	System.Single
frequency	System.Single
direction	UnityEngine.Vector2

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithColors(Color, Color)

public TextStudio2DAnimatedEffectSpec WithColors(Color primary, Color secondary)

Returns an animated-effect copy with the supplied primary and secondary colors.

Parameters

Name	Type
primary	UnityEngine.Color
secondary	UnityEngine.Color

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithMapping(TextStudio2DMappingSpace)

public TextStudio2DAnimatedEffectSpec WithMapping(TextStudio2DMappingSpace mapping)

Returns an animated-effect copy using the supplied mapping space.

Parameters

Name	Type
mapping	TextStudio.TextStudio2DMappingSpace

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithSeed(int)

public TextStudio2DAnimatedEffectSpec WithSeed(int seed)

Returns an animated-effect copy using the supplied deterministic seed.

Parameters

Name	Type
seed	System.Int32

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithHistoryFrames(int)

public TextStudio2DAnimatedEffectSpec WithHistoryFrames(int historyFrames)

Returns an animated-effect copy with the supplied temporal-history frame count.

Parameters

Name	Type
historyFrames	System.Int32

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithReducedMotion(TextStudioReducedMotionBehavior)

public TextStudio2DAnimatedEffectSpec WithReducedMotion(TextStudioReducedMotionBehavior behavior)

Returns an animated-effect copy with the supplied reduced-motion behavior.

Parameters

Name	Type
behavior	TextStudio.TextStudioReducedMotionBehavior

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

Properties

Kind

public TextStudio2DAnimatedEffectKind Kind { get; }

Returns

TextStudio.TextStudio2DAnimatedEffectKind

Mapping

public TextStudio2DMappingSpace Mapping { get; }

Returns

TextStudio.TextStudio2DMappingSpace

Amount

public float Amount { get; }

Returns

System.Single

Speed

public float Speed { get; }

Returns

System.Single

Phase

public float Phase { get; }

Returns

System.Single

Scale

public float Scale { get; }

Returns

System.Single

Width

public float Width { get; }

Returns

System.Single

Softness

public float Softness { get; }

Returns

System.Single

Amplitude

public float Amplitude { get; }

Returns

System.Single

Frequency

public float Frequency { get; }

Returns

System.Single

Direction

public Vector2 Direction { get; }

Returns

UnityEngine.Vector2

PrimaryColor

public Color PrimaryColor { get; }

Returns

UnityEngine.Color

SecondaryColor

public Color SecondaryColor { get; }

Returns

UnityEngine.Color

Seed

public int Seed { get; }

Returns

System.Int32

HistoryFrames

public int HistoryFrames { get; }

Returns

System.Int32

ReducedMotionBehavior

public TextStudioReducedMotionBehavior ReducedMotionBehavior { get; }

Returns

TextStudio.TextStudioReducedMotionBehavior