TextStudioCompositionLayer
public sealed class TextStudioCompositionLayer : ITextStudioEffect, ITextStudioEffectDefinition, ITextStudioEffectCapabilitiesProviderOne ordered effect or channel layer with phase, area, color, and influence-field configuration.
Methods
Section titled “Methods”
CreateChannel(TextStudioCompositionChannel)
Section titled “CreateChannel(TextStudioCompositionChannel)”public static TextStudioCompositionLayer CreateChannel(TextStudioCompositionChannel channel)Creates a layer targeting one built-in renderer-neutral channel.
Parameters
| Name | Type |
|---|---|
channel |
TextStudio.TextStudioCompositionChannel |
Returns
TextStudio.TextStudioCompositionLayer
CreateRenderProperty(string)
Section titled “CreateRenderProperty(string)”public static TextStudioCompositionLayer CreateRenderProperty(string propertyId)Creates a layer targeting a registered render property by stable namespaced ID.
Parameters
| Name | Type |
|---|---|
propertyId |
System.String |
Returns
TextStudio.TextStudioCompositionLayer
CreateEffect(string)
Section titled “CreateEffect(string)”public static TextStudioCompositionLayer CreateEffect(string effectId)Creates a layer that invokes a registered effect definition by stable ID.
Parameters
| Name | Type |
|---|---|
effectId |
System.String |
Returns
TextStudio.TextStudioCompositionLayer
CreateWriting(TextStudioWritingStyleAsset)
Section titled “CreateWriting(TextStudioWritingStyleAsset)”public static TextStudioCompositionLayer CreateWriting(TextStudioWritingStyleAsset writingStyle)Creates a layer that schedules one shared writing style through composition phases.
Parameters
| Name | Type |
|---|---|
writingStyle |
TextStudio.TextStudioWritingStyleAsset |
Returns
TextStudio.TextStudioCompositionLayer
Evaluate(ref EvaluatedGlyphState, in EffectEvaluationContext)
Section titled “Evaluate(ref EvaluatedGlyphState, in EffectEvaluationContext)”public void Evaluate(ref EvaluatedGlyphState state, in EffectEvaluationContext context)Evaluates this layer’s semantic scope, fields, timing, and payload into one glyph state.
Parameters
| Name | Type |
|---|---|
state |
TextStudio.EvaluatedGlyphState |
context |
TextStudio.EffectEvaluationContext |
Constructors
Section titled “Constructors”
TextStudioCompositionLayer()
Section titled “TextStudioCompositionLayer()”public TextStudioCompositionLayer()Properties
Section titled “Properties”
public string Id { get; }Returns
System.String
StableId
Section titled “StableId”public string StableId { get; }Returns
System.String
DisplayName
Section titled “DisplayName”public string DisplayName { get; }Returns
System.String
Enabled
Section titled “Enabled”public bool Enabled { get; }Returns
System.Boolean
public TextStudioCompositionLayerKind Kind { get; }Returns
TextStudio.TextStudioCompositionLayerKind
Channel
Section titled “Channel”public TextStudioCompositionChannel Channel { get; }Returns
TextStudio.TextStudioCompositionChannel
RenderPropertyId
Section titled “RenderPropertyId”public string RenderPropertyId { get; }Returns
System.String
UsesRenderProperty
Section titled “UsesRenderProperty”public bool UsesRenderProperty { get; }Returns
System.Boolean
ColorMode
Section titled “ColorMode”public TextStudioCompositionColorMode ColorMode { get; }Returns
TextStudio.TextStudioCompositionColorMode
ColorGradient
Section titled “ColorGradient”public Gradient ColorGradient { get; }Returns
UnityEngine.Gradient
CustomPlayback
Section titled “CustomPlayback”public EffectPlaybackAsset CustomPlayback { get; }Returns
TextStudio.EffectPlaybackAsset
CustomCurveAsset
Section titled “CustomCurveAsset”public TextStudioCurveProfile CustomCurveAsset { get; }Returns
TextStudio.TextStudioCurveProfile
EffectId
Section titled “EffectId”public string EffectId { get; }Returns
System.String
EffectParameters
Section titled “EffectParameters”public string EffectParameters { get; }Returns
System.String
WritingStyle
Section titled “WritingStyle”public TextStudioWritingStyleAsset WritingStyle { get; }Returns
TextStudio.TextStudioWritingStyleAsset
Phases
Section titled “Phases”public TextStudioPhaseMask Phases { get; }Returns
TextStudio.TextStudioPhaseMask
Intensity
Section titled “Intensity”public float Intensity { get; }Returns
System.Single
TimeOffset
Section titled “TimeOffset”public float TimeOffset { get; }Returns
System.Single
Timing
Section titled “Timing”public PhaseParams Timing { get; }Returns
TextStudio.PhaseParams
Sequence
Section titled “Sequence”public TextStudioSequenceSettings Sequence { get; }Returns
TextStudio.TextStudioSequenceSettings
DefaultArea
Section titled “DefaultArea”public TextStudioEffectAreaSettings DefaultArea { get; }Returns
TextStudio.TextStudioEffectAreaSettings
BlendMode
Section titled “BlendMode”public EffectBlendMode BlendMode { get; }Returns
TextStudio.EffectBlendMode
SurfaceMask
Section titled “SurfaceMask”public TextStudioSurfaceMask SurfaceMask { get; }Returns
TextStudio.TextStudioSurfaceMask
Vector
Section titled “Vector”public Vector3 Vector { get; }Returns
UnityEngine.Vector3
Unsigned
Section titled “Unsigned”public uint Unsigned { get; }Returns
System.UInt32
SpatialInfluence
Section titled “SpatialInfluence”public TextStudioInfluenceFieldStack SpatialInfluence { get; }Returns
TextStudio.TextStudioInfluenceFieldStack
SourceColorSelector
Section titled “SourceColorSelector”public TextStudioSourceColorSelector SourceColorSelector { get; }Returns
TextStudio.TextStudioSourceColorSelector
Selector
Section titled “Selector”public TextStudioApplicationSelector Selector { get; }Returns
TextStudio.TextStudioApplicationSelector
Capabilities
Section titled “Capabilities”public TextStudioEffectCapabilities Capabilities { get; }Gets immutable capabilities used by authoring validation and runtime compatibility checks.
Returns
TextStudio.TextStudioEffectCapabilities