TextStudioReactionVisualSample

StructTextStudioTextStudio

public readonly struct TextStudioReactionVisualSample

Motion and color of one retained unit in its source renderer’s local text space.

Fields

LocalOffset

public readonly Vector3 LocalOffset

Returns

UnityEngine.Vector3

LocalRotation

public readonly Quaternion LocalRotation

Returns

UnityEngine.Quaternion

LocalScale

public readonly Vector3 LocalScale

Returns

UnityEngine.Vector3

Alpha

public readonly float Alpha

Returns

System.Single

Tint

public readonly Color32 Tint

Returns

UnityEngine.Color32

Constructors

TextStudioReactionVisualSample(Vector3, Quaternion, Vector3, float)

public TextStudioReactionVisualSample(Vector3 localOffset, Quaternion localRotation, Vector3 localScale, float alpha)

Creates a retained-output transform sample with clamped opacity and a white tint.

Parameters

Name	Type
localOffset	UnityEngine.Vector3
localRotation	UnityEngine.Quaternion
localScale	UnityEngine.Vector3
alpha	System.Single

TextStudioReactionVisualSample(Vector3, Quaternion, Vector3, float, Color32)

public TextStudioReactionVisualSample(Vector3 localOffset, Quaternion localRotation, Vector3 localScale, float alpha, Color32 tint)

Creates a retained-output transform sample with clamped opacity and the supplied tint.

Parameters

Name	Type
localOffset	UnityEngine.Vector3
localRotation	UnityEngine.Quaternion
localScale	UnityEngine.Vector3
alpha	System.Single
tint	UnityEngine.Color32

Methods

NeedsColorUpdate(float, Color32)

public bool NeedsColorUpdate(float lastAlpha, Color32 lastTint)

Reports whether opacity or any tint channel differs from the previously submitted color state.

Parameters

Name	Type
lastAlpha	System.Single
lastTint	UnityEngine.Color32

Returns

System.Boolean

ApplyColor(Color32)

public Color32 ApplyColor(Color32 source)

Multiplies a source color by this sample’s tint and opacity for retained-output rendering.

Parameters

Name	Type
source	UnityEngine.Color32

Returns

UnityEngine.Color32