ITextStudioTextBackend
public interface ITextStudioTextBackendStable identity and lifecycle contract for an optional text backend. Source, layout, and mesh responsibilities are split into additive interfaces so future backend features do not require changing this base contract.
Methods
Section titled “Methods”
Attach(TextStudioText)
Section titled “Attach(TextStudioText)”void Attach(TextStudioText owner)Attaches the backend to a host and begins observing its target.
Parameters
| Name | Type | Description |
|---|---|---|
owner |
TextStudio.TextStudioText | Host that will issue backend requests. |
Detach()
Section titled “Detach()”void Detach()Stops observation and releases backend-owned output state.
Properties
Section titled “Properties”
BackendId
Section titled “BackendId”string BackendId { get; }Gets the stable namespaced identifier persisted by backend selection.
Returns
System.String
DisplayName
Section titled “DisplayName”string DisplayName { get; }Gets the user-facing backend name.
Returns
System.String
Priority
Section titled “Priority”int Priority { get; }Gets the selection priority used when compatible backends compete.
Returns
System.Int32
IsAvailable
Section titled “IsAvailable”bool IsAvailable { get; }Gets whether the backend can currently drive its target.
Returns
System.Boolean
TargetObject
Section titled “TargetObject”Object TargetObject { get; }Gets the Unity object whose output is controlled by this backend.
Returns
UnityEngine.Object
Capabilities
Section titled “Capabilities”TextStudioTextBackendCapabilities Capabilities { get; }Gets the shaping, rendering, and editing features implemented by the backend.
Returns
TextStudio.TextStudioTextBackendCapabilities
Events
Section titled “Events”
Changed
Section titled “Changed”event Action<TextStudioTextBackendChange> ChangedOccurs when text, layout, or mesh state changes outside the host pipeline.
Returns
System.Action{TextStudio.TextStudioTextBackendChange}