Skip to content

TextStudioChannelRegistry

ClassTextStudioTextStudio
public static class TextStudioChannelRegistry

Domain-local registry that validates channel layouts and applies extension values to evaluated glyph state.

public static bool Register(in TextStudioChannelDescriptor descriptor)

Registers a valid channel when its layout fits and no incompatible descriptor owns the same ID.

Parameters

Name Type
descriptor TextStudio.TextStudioChannelDescriptor

Returns

System.Boolean

public static bool Unregister(string descriptorId)

Removes an extension channel by stable ID; built-in channels cannot be removed.

Parameters

Name Type
descriptorId System.String

Returns

System.Boolean

TryGet(string, out TextStudioChannelDescriptor)

Section titled “TryGet(string, out TextStudioChannelDescriptor)”
public static bool TryGet(string descriptorId, out TextStudioChannelDescriptor descriptor)

Tries to resolve a registered channel by case-insensitive stable ID.

Parameters

Name Type
descriptorId System.String
descriptor TextStudio.TextStudioChannelDescriptor

Returns

System.Boolean

public static void GetAll(List<TextStudioChannelDescriptor> descriptors)

Replaces the supplied list contents with all registered descriptors in stable layout order.

Parameters

Name Type
descriptors System.Collections.Generic.List{TextStudio.TextStudioChannelDescriptor}

Apply(ref EvaluatedGlyphState, string, Vector4, float, EffectBlendMode, TextStudioSurfaceMask)

Section titled “Apply(ref EvaluatedGlyphState, string, Vector4, float, EffectBlendMode, TextStudioSurfaceMask)”
public static bool Apply(ref EvaluatedGlyphState state, string descriptorId, Vector4 value, float influence = 1, EffectBlendMode blendMode = EffectBlendMode.Override, TextStudioSurfaceMask surfaceMask = TextStudioSurfaceMask.All)

Applies one extension-channel payload using the descriptor’s layout and supported blend modes.

Parameters

Name Type
state TextStudio.EvaluatedGlyphState
descriptorId System.String
value UnityEngine.Vector4
influence System.Single
blendMode TextStudio.EffectBlendMode
surfaceMask TextStudio.TextStudioSurfaceMask

Returns

System.Boolean: false when the channel is missing, incompatible, or unsupported.