Text Studio API Reference
This reference is generated from the shipped Text Studio assemblies and their XML documentation.
TextStudio
Section titled “TextStudio”- ActionContext: Context passed to action execution.
- ActionMarker: Parsed action data from text markup. Immutable once created.
- AnimationPhase: Identifies the appearance, persistent, or disappearance phase in which a glyph effect runs.
- ArcPlacement: Arc placement: distributes glyphs along a circular arc. Only controls position + path frame. Glyph rotation is handled globally by the hub’s…
- CharacterSubstitutionBinding: Binding of a presentation-layer character substitution to a glyph range.
- CharacterTimings: Punctuation-aware character timings for natural typewriter pacing.
- CirclePlacement: Circle placement: distributes glyphs evenly around a full circle. Rotation is handled by the hub-level PlacementOrientation module.
- CompiledTextStudio2DStyle: Validated immutable renderer-neutral 2D appearance intermediate representation.
- CompiledTextStudioAppearancePlan: Shared immutable programs and instance-owned source composition. Contains no rendering resources or clocks.
- CompiledTextStudioWritingStyle: Validated immutable writing asset and playback plan.
- CompiledWritingFont: Immutable compiled glyph paths indexed by font, glyph, and variation identity.
- CompiledWritingPhrase: Prepared centerline and outline paths for an exact resolved phrase and shaping fingerprint.
- CurvePlacement: Bends selected glyph baselines while preserving their source x spacing and line breaks.
- CurveType: Selects a built-in response curve or a custom animation curve for normalized sampling.
- DecorationBits: Which decoration tiles this glyph participates in. Combinable as flags so a single character can sit under an underline and a strikethrough at the…
- DirtyFlags: Identifies cached text, layout, animation, simulation, appearance, and writing work that must be refreshed, with independent extension bits for…
- EffectBinding: Binding of an effect to a glyph range within the text.
- EffectBlendMode: Determines how a composed effect layer combines its value with the glyph’s current transform, color, or render property.
- EffectEvaluationContext: Context passed to effect evaluation. Contains all timing and effect area information needed for effect computation without accessing global state.
- EffectInfoAttribute: Attaches display metadata to a code-defined effect so discovery tooling can render category grouping, tooltips, and markup examples.
- EffectPlaybackAsset: Reusable playback asset that maps elapsed time to normalized effect intensity with delay, looping, hold, and completion policy.
- EffectPlaybackCompletion: Chooses whether completed finite effect playback holds its final intensity or resets to zero.
- EvaluatedGlyphState: Per-glyph evaluated animation state. Output of the animation evaluation pipeline. 8 channels with per-channel blend mode support.
- GlyphInstanceFlags: Flags whether a glyph instance is visible, needs an update, or is controlled by simulation.
- GlyphLayoutInfo: Per-glyph layout data produced by the layout engine. Backend-neutral: TMP and UITK adapters translate their layout to this model.
- GlyphPlacement: Per-glyph placement result. 3D-capable with tangent and up vectors for path-following placement modes.
- GlyphRun: A run of visible glyphs with shared style properties.
- GridCellSizing: Controls whether grid cells follow rendered glyph bounds or authored dimensions.
- GridFlow: Controls which grid axis fills first.
- GridPlacement: Grid placement: arranges glyphs in a grid pattern.
- IEffectPlayback: Playback mode interface for effect timing/intensity.
- IGlyphMetricsProvider: Backend-neutral source of per-character advance widths and kerning adjustments. Implemented by renderers that have font metrics available (e.g. the…
- IPlacementContextStrategy: Extended placement contract for strategies that need rendered line ranges and sizing metadata in addition to the flat glyph positions.
- IPlacementStrategy: Interface for placement strategies. Placement modes transform linear layout positions into final 3D positions.
- IPresentationGlyphProvider: Addon extension point for presentation glyph substitution. Terminal FX, Mechanical Displays, and custom addons implement this to substitute visual…
- ISettingsProvider<T>: Settings cascade interface: Global SO → Shared SO → Local inline. Never cached - always read through provider for runtime swappability. Adopted from…
- ITextStudioAction: Action factory interface. Actions are invoked during text reveal (wait, speed change, events, etc.). Priority chain: Local component → Global…
- ITextStudioActionDefinitionProvider: Exposes discoverable tag metadata for an action implementation.
- ITextStudioAddonDirtyNotifier: Addon dirty notification interface. Addons signal the base controller when they need a presentation update.
- ITextStudioAnimationPlayback: Optional control of Text Studio-owned presentation time. Independent native clocks and external coroutines retain their own timing.
- ITextStudioBackendHost: Advanced text-backend host view. Everyday playback code should not depend on this contract.
- ITextStudioCapabilityReportProvider: Optional add-on diagnostics collected on demand, without dependencies from the base package.
- ITextStudioCharacterSubstitution: Defines a registered markup-driven transformation of presentation glyphs.
- ITextStudioCharacterSubstitutionRuntime: Per-host runtime instance that updates one character-substitution binding.
- ITextStudioContent: Focused content contract shared by component and UI Toolkit hosts. Use this view when a caller owns text content but not playback policy.
- ITextStudioController: Restricted playback controller exposed to custom actions while they execute.
- ITextStudioCue: User-facing marker for timeline instructions such as wait, speed, event, and input markers. Cues keep the existing action execution contract.
- ITextStudioCurve: Curve evaluation interface for effects and placement.
- ITextStudioEditModePreviewAction: Optional metadata marker for actions that are designed to behave predictably during edit-mode preview. Runtime-only actions still require the…
- ITextStudioEffect: Runtime leaf evaluator. Expansion-only definitions such as Composed Effects deliberately do not implement this interface and are flattened into leaf…
- ITextStudioEffectCapabilitiesProvider: Publishes renderer compatibility, performance, phase, and accessibility metadata for an effect.
- ITextStudioEffectControl: Focused renderer-neutral effect control shared by component and UI Toolkit hosts. External effects contribute after authored Reveal, Active, and…
- ITextStudioEffectDefinition: Base interface for all text effects. Effects modify glyph states through a channel-based evaluation model with explicit blend modes (not…
- ITextStudioEffectFactory: Creates an isolated leaf evaluator for one effect invocation. Factories are definitions, never invocation state, and are called only while a plan or…
- ITextStudioEffectMetadataProvider: Publishes effect identity, documentation, phase suggestions, and typed parameters.
- ITextStudioExtensionTagProcessor: Receives compiled extension tags and reveal-time tag events for one host.
- ITextStudioExternalEffectSource: Opt-in source for renderer-neutral effect contributions. Active sources are polled after the semantic plan is current and before layout, in host…
- ITextStudioExternalTextSource: Marker interface for any component that programmatically drives the text on a TextStudioText hub (localization bridges, data bindings, scripted…
- ITextStudioFrameComposer: Target-scoped stateful pose and response contributor.
- ITextStudioGlyphColorEncoder: Optional backend or renderer contract for encoding authored sRGB colors into its native glyph vertex format.
- ITextStudioGlyphGeometryProvider: Optional exact-outline or compound-convex geometry provider.
- ITextStudioGlyphImageProvider: Captures caller-owned immutable pixels on the provider’s required thread. A successful snapshot must match the entire request; no callback arrays or…
- ITextStudioGlyphImageRevisionProvider: Optional cheap image-content or binding revision. Change before publishing new pixels, palette data or atlas bindings, even when shaping is…
- ITextStudioGlyphSignalProvider: Provides target-scoped physical signal values for individual glyphs.
- ITextStudioIncrementalPreviewProvider: Progress and cancellation for stateful preview work spread over multiple updates.
- ITextStudioInputProvider: Supplies frame-based advance input to reveal actions without binding Text Studio to an input system.
- ITextStudioKeyedInputProvider: Extends advance input with named action keys used by keyed wait tags.
- ITextStudioLayoutBackend: Optional backend capability for publishing semantic glyph layout to Text Studio.
- ITextStudioMarkupPreprocessor: Transforms authored markup before Text Studio parses tags and builds its semantic plan.
- ITextStudioMeshBackend: Optional backend capability that renders evaluated glyph state into its target.
- ITextStudioPlacementExtension: Optional metadata contract for component-based placement extensions. The Text Studio hub owns selection and composition while add-ons provide…
- ITextStudioPlayback: Focused reveal and hide playback contract shared by every Text Studio host.
- ITextStudioPreviewStageProvider: Optional renderer extension for the shared Text Studio preview lifecycle. The base owns mode/view/quality selection and playback; renderers…
- ITextStudioPrimaryOutputOwner: Optional renderer contract for declaring primary visual-output ownership without coupling the Text Studio hub to TMP, a particular render component…
- ITextStudioReactionActionHost: Scene-local services supplied to a prepared reaction action.
- ITextStudioReactionActionState: Reusable host-local state. CreateState runs during preparation or pool growth, never in a warmed sample.
- ITextStudioReactionAnchorProvider: Optional native renderer pose for semantic reaction units.
- ITextStudioReactionAnchorSelectionCommand: Optional anchor selection carried into pre-commit outgoing capture.
- ITextStudioReactionBodyActionHost: Optional bridge to a target-scoped physics owner, without placing simulation in Text Studio.
- ITextStudioReactionBodyEventSource: Non-consuming event view for one released semantic body.
- ITextStudioReactionBodyProvider: Optional target-scoped owner of physical semantic-unit reactions.
- ITextStudioReactionBooleanInputProvider: Optional host input lookup for reaction-layer Boolean gates.
- ITextStudioReactionCapturePreparation: Lets a native provider prepare short-lived source data only while outgoing capture is needed.
- ITextStudioReactionCaptureProvider: Native renderer owns copied or detached resources and validates every versioned access.
- ITextStudioReactionCaptureProviderSource: Lets a text backend expose a native provider whose leases remain owned by its adapter.
- ITextStudioReactionChangeLimitCommand: Optional cap on outgoing semantic units accepted for one text-change capture.
- ITextStudioReactionCommand: Immutable result of compiling a custom reaction action.
- ITextStudioReactionConcurrencyCommand: Optional cap shared by layers using the same action asset. Overflow replaces the oldest response.
- ITextStudioReactionLeaseStartPolicy: Optional preflight after retained capture, before acquiring action state.
- ITextStudioReactionNamedAnchorHost: Optional host route for actions that select a native renderer anchor.
- ITextStudioReactionNamedAnchorProvider: Optional renderer-defined anchor such as a 3D glyph socket.
- ITextStudioReactionPendingAnchorHost: Reports a valid event unit whose visual layout has not been published yet.
- ITextStudioReactionPrewarmableCommand: Optional Play Mode preparation for actions that own pooled Unity objects.
- ITextStudioReactionPrewarmableState: Optional preparation hook for allocating reusable action state before responses execute.
- ITextStudioReactionRetainedWorldObjectProvider: Optional Play Mode bridge to one backend-owned world object for a physical retained response.
- ITextStudioReactionStartPolicy: Optional preflight for expected target loss before action state starts.
- ITextStudioReactionTriggerAnchorCommand: Optional current-frame anchor snapshot taken after presentation, before any action delay.
- ITextStudioReactionUIParticleHost: Optional host service for acquiring bounded particle output from the active UI renderer.
- ITextStudioReactionUIParticleOutput: Renderer-neutral commands write particles without owning UI elements.
- ITextStudioReactionUnitTextSource: Resolves the current semantic unit for host-independent glyph audio cues.
- ITextStudioReactionVisualOutputProvider: Optional presentation seam; the capture provider keeps native geometry ownership.
- ITextStudioRenderDomainProvider: Optional renderer contract used by authoring catalogs and diagnostics to distinguish flat text from extrusion-specific output without depending on…
- ITextStudioRenderer: Renderer add-on contract. Components that visualize TextStudio output (extruded 3D text, mechanical flip tiles, custom backends) implement this…
- ITextStudioRendererChannelSupport: Optional renderer extension contract for precise effect-channel compatibility. Text Studio keeps effect evaluation renderer-agnostic; renderers use…
- ITextStudioRendererEffectExecution: Optional renderer contract for exact prepared execution of compiled effect bindings. Returning TextStudioRendererEffectExecution.RendererExact is a…
- ITextStudioRevealState: Read-only reveal information exposed to character-substitution extensions.
- ITextStudioRuntimeFontSourceBackend: Optional configured font-source capability for authoring validation before a backend has committed layout.
- ITextStudioShapedGeometryBackend: Optional exact planar geometry accompanying the backend’s existing shaped glyph revision.
- ITextStudioShapedGeometryDiagnostics: Explains why a complete shaped geometry revision cannot currently be published.
- ITextStudioShapedGlyphBackend: Optional topology contract for renderers that need the exact shaped glyph IDs and font outlines selected by a text backend. This keeps complex…
- ITextStudioShapedGlyphFeatureProvider: Optional capability contract for consumers that need to distinguish exact shaped-glyph data from compatible fallback values.
- ITextStudioShapedGlyphImageBackend: Optional exact shaped-image capability. Request metadata can be available even when native pixel extraction is unavailable.
- ITextStudioShapedGlyphPreparationBackend: Optional authoring capability for shaping representative text independently from the live backend target. Implementations must not replace target…
- ITextStudioSourceColorBackend: Optional backend capability for refreshing source colors without rebuilding layout.
- ITextStudioStackAsset: Read-only shared contract implemented by persistent stack assets.
- ITextStudioStackItem: Minimal shared authoring contract for stack rows.
- ITextStudioStatefulPreviewProvider: Stateful preview lifecycle for simulations and other history-dependent extensions.
- ITextStudioTextBackend: Stable identity and lifecycle contract for an optional text backend. Source, layout, and mesh responsibilities are split into additive interfaces so…
- ITextStudioTextBackendAppearanceSupport: Optional capability contract for text backends that do not render Text Studio’s complete persistent 2D Appearance stack. Backends that omit this…
- ITextStudioTextBackendRenderChannelSupport: Optional capability contract that reports faithfully rendered shared effect channels.
- ITextStudioTextProjectionBackend: Optional native parsing which replaces source syntax with semantic text before reveal and effects.
- ITextStudioTextSource: Text source interface for canonical text input. Sources provide text with version tracking for dirty detection.
- ITextStudioTextSourceBackend: Optional backend capability for synchronizing authored markup with an external text target.
- ITextStudioVisibility: Focused runtime visibility contract. Visibility overrides never change authored markup.
- ITextStudioWaitLifecycleSink: Receives lifecycle notifications for waits that suspend reveal or hide playback. Implementations must not retain the supplied marker beyond the…
- ITextStudioWordBoundaryProvider: Optional per-host language tailoring. Return a UTF-16 end offset on a text-unit boundary.
- ITypewriterProvider: Compatibility contract for components that drive reveal and hide sequences through a typewriter-style API.
- LayoutSettings: Backend-neutral layout configuration.
- LinearPlacement: Linear placement: glyphs stay at their layout positions (identity transform).
- LineRange: Line segmentation range.
- OverflowPolicy: Overflow handling policy.
- ParagraphRange: Paragraph segmentation range.
- PathPosition: Controls which vertical part of a glyph is positioned on a curve path.
- PathSpacing: Controls how glyphs are distributed along path-following placements (Arc, Spline).
- PhaseParams: Per-glyph stagger parameters for animation phasing. Controls how effects stagger across characters, words, and lines.
- PlacementContext: Shared input for placement strategies. Keeps per-glyph positions contiguous while allowing path strategies to preserve rendered line boundaries.
- PlacementMode: Selects how glyphs are positioned, including built-in paths, grids, custom curves, and extension placement strategies.
- PlacementOrientation: Placement-agnostic orientation override. Placement Default preserves the strategy-authored rotation while the other policies reinterpret its frame.
- PlaybackMode: Selects how elapsed time produces effect intensity, including single runs, repeating cycles, ping-pong, external control, and an authored weight…
- PresentationFlags: Flags a presented glyph’s visibility, reveal, animation, substitution, and change state separately from canonical layout.
- PresentationGlyph: A single glyph in the presentation layer. Separates canonical text (what was authored) from visual text (what is displayed). Addons like Terminal FX…
- RegionToGlyphMap: Maps a named region to its glyph range.
- RendererCapabilities: Capability flags that describe what a renderer can express for a given frame. Used to warn users about mismatches (e.g. color effects on a…
- RevealMode: Selects the text units advanced by Typewriter reveal, from individual glyphs or letters to words, lines, regions, or a custom strategy.
- RevealTimingsPreset: Built-in reveal timing presets, used when the hub has no custom TypingTimingsBase asset assigned. See BuiltInTimings for the actual delay curves.
- StringTextSource: Mutable in-memory text source that tracks replacements and append operations for incremental compilation.
- SubstitutionState: Labels the presentation state of a character substitution, including scrambling, decryption, encryption, corruption, and resolved output.
- TextAlignment: Alignment modes for text layout.
- TextStudio2DAnimatedEffectKind: Clock-driven title treatments routed to fused field or Hero rendering by capability.
- TextStudio2DAnimatedEffectSpec: Compact deterministic parameters shared by the animated Appearance family. Playback uses the owning Text Studio presentation clock, so scrubbing…
- TextStudio2DBackplateVisibility: Chooses whether a glyph-derived backplate follows Typewriter reveal and hide or stays visible independently.
- TextStudio2DBatchKey: Renderer batch identity. It intentionally contains no style asset or fingerprint.
- TextStudio2DBevelSpec: Settings for beveled edge relief, lighting, highlight and shadow colors, and measurement units.
- TextStudio2DBlendMode: Selects the color compositing operation used to combine a 2D appearance layer with the layers beneath it.
- TextStudio2DBoundsExpansion: Conservative normalized expansion beyond source glyph bounds.
- TextStudio2DBucketSplitReason: Flags the rendering, resource, masking, or capability constraints that force compiled 2D appearance operations into separate buckets.
- TextStudio2DColorAdjustmentMode: Chooses between an explicit color matrix and standard controls such as exposure, saturation, hue, and tint.
- TextStudio2DColorAdjustmentPreset: Common color transforms that can be further edited as an explicit matrix.
- TextStudio2DColorAdjustmentSpec: A linear-light straight RGBA transform, separate from geometric coverage.
- TextStudio2DColorFaceMode: Chooses whether a color glyph keeps its original pixels, is tinted, or contributes only its silhouette to an appearance fill.
- TextStudio2DCompileContext: Renderer capability snapshot used for deterministic style compilation.
- TextStudio2DCompiledBucket: A contiguous range of compiled operations with its batch key, required shader features, and split reason.
- TextStudio2DCompiledOperation: A compiled appearance operation containing resolved paint, selector, relationship, compositing, and effect settings.
- TextStudio2DCompiledPaint: Renderer-neutral paint parameters with references into a compiled style gradient-stop table.
- TextStudio2DCompiledSelector: A compiled application-selector graph and its shared evaluation state for 2D appearance operations.
- TextStudio2DCostEstimate: Like-for-like workload estimate surfaced to diagnostics and authoring UI.
- TextStudio2DDecorationEndStyle: Analytic end geometry available to background and border decorations.
- TextStudio2DDecorationKind: Selects the text decoration to generate: underline, strikethrough, overline, background, or border.
- TextStudio2DDecorationLineSpec: Settings for decoration-line patterns, font metrics, phase, caps, and clearance around glyph ink.
- TextStudio2DDecorationShape: Selects the silhouette of a decoration surface, including geometric plates, custom polygons, and the source glyph’s own outline.
- TextStudio2DDecorationSpec: Settings for decoration geometry, topology, reveal visibility, line patterns, and ordered surface treatments.
- TextStudio2DDecorationTopology: Chooses whether decoration surfaces are built per line, as a connected selected range, or per text fragment.
- TextStudio2DDecorationVerticalAnchor: Controls the vertical reference used by an explicitly sized plate decoration.
- TextStudio2DDistanceDomain: Chooses the signed-distance measurement used by a distance-gradient paint.
- TextStudio2DExecutionPath: Selects automatic routing or an explicit fused-field, retained-geometry, or hero-compositor path for a 2D appearance style.
- TextStudio2DFauxDepthPaintMapping: Controls which coordinates drive paint across a faux-depth sweep.
- TextStudio2DFauxDepthSpec: Settings for silhouette extrusion direction, taper, falloff, edge softness, paint mapping, and contour lighting.
- TextStudio2DFillSpec: Settings for fill dilation, edge softness, measurement units, and preservation of native text appearance.
- TextStudio2DFourCornerGradient: Four colors bilinearly interpolated across a normalized rectangular paint domain.
- TextStudio2DGlowSpec: Settings for glow radius, core spread, rendering method, and measurement units.
- TextStudio2DGradientSpread: Controls how scalar gradients continue outside their normalized zero-to-one domain.
- TextStudio2DGradientStop: A color stop at a normalized position within a 2D paint gradient.
- TextStudio2DGraphicEffectKind: Professional editorial and print-inspired treatments for the 2D style stack.
- TextStudio2DGraphicEffectSpec: Compact parameters shared by the editorial effect family. Presets provide finished defaults; fluent modifiers expose deterministic expert controls…
- TextStudio2DGroupOrder: Chooses whether an appearance group inherits painter order, draws each layer across characters, or completes each character’s stack first.
- TextStudio2DHalftoneSizeRamp: Optional directional radius modulation for the halftone dot field.
- TextStudio2DLayer: One persistent, independently addressable row in a 2D appearance stack.
- TextStudio2DLayerDefaults: Shared defaults for layer authoring and ad-hoc appearance tags.
- TextStudio2DLayerKind: Identifies the operation performed by a 2D appearance layer, from painted fills and strokes to decorations, masks, effects, and adjustments.
- TextStudio2DLineCap: Selects the butt, round, or square shape used at the ends of a decoration-line segment.
- TextStudio2DLinePattern: Selects a solid, double, dotted, dashed, or wavy pattern for text decoration lines.
- TextStudio2DLinePhaseRestart: Chooses whether a decoration-line pattern restarts at each selector match or at each text line.
- TextStudio2DMappingSpace: Selects the coordinate space in which a paint is sampled, from individual glyphs and text ranges to object, screen, or world coordinates.
- TextStudio2DMaskSpec: Settings that select a source stack item as a mask with optional inversion and edge feathering.
- TextStudio2DMaterialResponseKind: Calibrated 2D surface responses evaluated from the shared signed-distance normal.
- TextStudio2DMaterialResponseSpec: Compact physically inspired surface response. Presets provide finished defaults while the fluent modifiers expose the professional lighting…
- TextStudio2DMetricMode: Chooses authored decoration-line measurements, automatic adjusted font metrics, or the font’s own metrics.
- TextStudio2DPaint: Typed paint shared by fills, strokes, glows, shadows, and decorations.
- TextStudio2DPaintAsset: A directly referenced paint. Layers resolve it once during style compilation.
- TextStudio2DPainterOrder: Controls whether overlapping glyphs complete one layer or their whole stack first.
- TextStudio2DPaintKind: Selects how a paint produces color, including solid colors, gradients, textures, patterns, procedural noise, and distance-based gradients.
- TextStudio2DPaintOverrides: Flags which mapping, tint, transform, spread, texture-fit, or distance settings override a shared paint asset at its point of use.
- TextStudio2DQualityTier: Selects the responsive, balanced, or hero quality budget used when compiling and rendering a 2D appearance style.
- TextStudio2DRangeMapping: Chooses whether range-space paint coordinates restart for each selector match or span the entire selection.
- TextStudio2DRendererCapabilities: Flags the distance-field, paint, compositing, geometry, and effect features a renderer supports when compiling 2D appearance styles.
- TextStudio2DRenderStatistics: Read-only snapshot of how one text rendered its 2D Appearance in the latest presentation update. Categories are disjoint, so their sum is the text’s…
- TextStudio2DRoute: How the shared 2D renderer executes one bound appearance program.
- TextStudio2DRouteReason: The first condition that selected a route. Diagnostics report it verbatim.
- TextStudio2DShaderFeatures: Flags the paint and appearance operations a compiled style needs its shader variants to implement.
- TextStudio2DShadowSpec: Settings for shadow offset, blur, spread, rendering method, and measurement units.
- TextStudio2DSharedSurfaceOrder: Chooses whether shared decoration surfaces are drawn before or after the characters they support.
- TextStudio2DSkipInk: Chooses whether decoration lines avoid glyph ink, using an automatic outline-or-metrics fallback or precise prepared appearance data.
- TextStudio2DSoftEffectRendering: Controls whether a soft field is evaluated from each glyph SDF or from the composited text silhouette.
- TextStudio2DSourceApplicability: Limits an appearance layer to text glyphs, color glyphs such as sprites, or both, with automatic source applicability available.
- TextStudio2DSourceFieldQuality: Requests source glyph-field density without coupling a style to one text backend.
- TextStudio2DSourceFieldRequest: Backend-neutral source field fidelity requested by a compiled appearance.
- TextStudio2DStrokeJoin: Selects the round, miter, or bevel shape used where adjacent segments of a 2D contour stroke meet.
- TextStudio2DStrokeSpec: Settings for stroke width, alignment, joins, dashes, edge softness, and measurement units.
- TextStudio2DStyleAsset: Persistent 2D appearance stack compiled into renderer-specific execution plans.
- TextStudio2DStyleCompiler: Compiles persistent 2D style assets into one shared backend-neutral plan.
- TextStudio2DStyleInheritanceMode: Combines a style with its parent by appending layers, replacing layers with matching persistent IDs, or replacing the inherited stack.
- TextStudio2DStyleRequirements: Flags the source data, rendering resources, coordinates, and processing features required by a compiled 2D appearance style.
- TextStudio2DStyles: Registers reusable appearances by their stable Tag ID. Runtime entries override the project catalog.
- TextStudio2DStyleSettings: Serializable appearance settings with independently owned layer data.
- TextStudio2DSurfaceSelection: Chooses whether a color adjustment affects a shared surface when any member glyph is selected or only when all its members are selected.
- TextStudio2DSurfaceTreatment: One independently painted treatment of an owned decoration surface.
- TextStudio2DTextureFit: Controls how an image is fitted into its selected paint frame.
- TextStudio2DUnit: Controls whether a field measurement is authored relative to the font em or in screen pixels.
- TextStudio2DWorldShadowMode: Controls alpha-clipped shadow casting for world-space 2D output.
- TextStudioActionAsset: ScriptableObject base for actions that can be registered in the database.
- TextStudioActionComponent: Scene-local action base. Attach next to a TextStudioText hub to make the tag available only for that hub, without touching global project settings.
- TextStudioActionDefinition: Immutable discovery metadata and parameter schema for a registered action tag.
- TextStudioActionDefinitionUtility: Matches action implementations against their canonical identifiers and aliases.
- TextStudioActions: Registers and resolves actions invoked by Text Studio markup.
- TextStudioApi: Public convenience API for common TextStudio operations. Wraps the hub with simple methods so callers can drive reveal without poking at the full…
- TextStudioAppearanceActivation: Activation metadata for a top-level appearance group. Inactive source data is retained.
- TextStudioAppearanceActivationMode: Chooses whether an appearance binding is always active or is activated only by matching appearance markup.
- TextStudioAppearanceApplyMode: Chooses whether an appearance binding replaces the current appearance stack or overlays its layers onto it.
- TextStudioAppearanceContribution: One persistent composition link, ordered from this contribution toward its backdrop.
- TextStudioAppearanceDefinition: One named definition. Invalid and disabled definitions still shadow enclosing names.
- TextStudioAppearanceDefinitions: Extracts named domains without compiling or activating unused definitions.
- TextStudioAppearanceDefinitionSource: Chooses whether an appearance binding uses an inline style definition or a shared style asset.
- TextStudioAppearanceDefinitionTable: A case-insensitive lookup of resolved appearance definitions with their extraction diagnostics.
- TextStudioAppearanceDiagnostic: A contextual appearance diagnostic; unresolved invocations remain inspectable.
- TextStudioAppearanceExposure: A typed leaf binding. Reordering layers or changing their labels does not change the target.
- TextStudioAppearanceMemory: Accounts payload capacity, not Unity/driver object overhead or the process managed heap. Borrowed textures are reported once and are never owned or…
- TextStudioAppearanceMemoryBudget: Application-wide envelopes for owned appearance payloads, including pending replacements.
- TextStudioAppearanceMemoryRejection: Details of a rejected appearance reservation, including requested GPU and CPU bytes and the available budget.
- TextStudioAppearanceMemorySnapshot: A snapshot of owned, pending, idle, peak, and borrowed appearance payloads with allocation, upload, cache, and eviction counters.
- TextStudioAppearanceOccurrence: One source invocation. Its immutable program can be shared with other invocations.
- TextStudioAppearanceParameterBinder: Applies named appearance-tag arguments to explicitly exposed layer and decoration-treatment properties.
- TextStudioAppearanceProperties: Typed property metadata and validated reading, writing, and target resolution for exposed appearance parameters.
- TextStudioAppearanceProperty: Identifies an appearance-layer property that can be read or overridden, such as paint color, opacity, stroke width, shadow offset, or glow radius.
- TextStudioAppearancePropertyDescriptor: Metadata describing an exposed appearance property, its value type, units, and named enum choices.
- TextStudioAppearanceRange: A half-open semantic range. Mapping domains remain intact when visible ranges acquire holes.
- TextStudioAppearanceResolution: Reports whether a requested appearance binding resolved to an active definition or is missing, disabled, or invalid.
- TextStudioAppearanceResourceKind: Classifies appearance memory allocations as source fields, paint textures, geometry, tables, hero targets, or preparation data.
- TextStudioAppearanceSource: Chooses the owner of a text component’s persistent 2D appearance.
- TextStudioAppearanceSpan: An authored appearance invocation, retained even when its definition cannot resolve.
- TextStudioAppearanceTagSyntax: Shared appearance spelling rules for parsing, diagnostics, and authoring assistance.
- TextStudioAppearanceValueType: Identifies the color, numeric, Boolean, or enum value accepted by an appearance-property descriptor.
- TextStudioApplicationSelector: Compact typed predicate tree used by persistent style layers and reusable by animation filters. Nodes are indexed rather than recursively allocated…
- TextStudioApplicationSelectorNode: One node in a compact indexed application-selector tree.
- TextStudioAudioPlayer: Plays pooled Audio Set cues from Typewriter events, Reactions, or explicit callers.
- TextStudioAudioPlayerClipSequenceMode: Chooses how successive audio cues select clips: in sequence, randomly, or randomly without immediately repeating a clip.
- TextStudioAudioPlayerCueTrigger: Chooses whether audio cues are driven by Typewriter events or Reaction dispatch.
- TextStudioAudioPlayerMarkerCue: Serializable marker route and clip set used by a Text Studio audio player.
- TextStudioAudioPlayerPlaybackMode: Chooses whether a new audio cue overlaps existing playback or interrupts the previous cue.
- TextStudioAudioPlayerRules: Pure routing and eligibility rules shared by runtime audio playback and validation.
- TextStudioAudioPlayerSettingsSource: Chooses audio-cue settings stored inline on the player or supplied by a reusable audio set.
- TextStudioAudioSet: Reusable glyph clip pool and marker-cue routing asset for Text Studio audio players.
- TextStudioAuthoringMode: Chooses between editing raw source markup and presenting the processed Text Studio output while authoring in Edit Mode.
- TextStudioAuthoringProfile: Selects the source markup dialect accepted before Text Studio compiles canonical tags.
- TextStudioAutoScrollFollower: Keeps a ScrollRect positioned near the most recently revealed TextMeshPro glyph.
- TextStudioBackendLayoutBuilder: Controlled writer that lets an optional backend publish layout without exposing Text Studio’s mutable layout storage.
- TextStudioBackendLayoutData: Structured zero-allocation layout publication request. Array inputs remain caller-owned and are copied into Text Studio storage only when committed…
- TextStudioBackendLayoutRequest: Transient layout request passed to a backend before it publishes glyph positions.
- TextStudioBackendShapedFontFace: Transient description of a shaped font face, including metrics and a bounded view of backend-owned font bytes.
- TextStudioBackendShapedGlyph: Immutable shaped-glyph topology and metrics published by a shaping-capable backend.
- TextStudioBackendShapedGlyphGeometry: Additional font-EM to reference-EM mapping without replacing shaped glyph identity.
- TextStudioBackendShapedPrimitive: Owned filled vector output which has no shaped font-glyph record, such as a formula rule.
- TextStudioBackendTextRequest: Transient compiled-text request passed to an external text backend.
- TextStudioBackendWriteHandling: Chooses how an active text backend handles direct text writes outside the hub: warn, import them as canonical source, or ignore them.
- TextStudioBehaviorDomain: Flags the default-effects, Typewriter, and Reaction domains that a behavior profile can supply.
- TextStudioBehaviorProfile: Reusable renderer-neutral behavior asset. Each enabled domain replaces the matching component-local fallback while all other host and renderer…
- TextStudioBehaviorResolver: Resolves behavior domains from an optional profile and component-local fallbacks.
- TextStudioBehaviorSettings: Complete renderer-neutral behavior snapshot used by behavior profiles and local hosts.
- TextStudioBehaviorValueSource: Identifies whether a resolved behavior setting came from the component or its assigned behavior profile.
- TextStudioBinding: Binds Text Studio markup, reveal playback, effects, placement, and visibility control to an existing UI Toolkit TextElement without requiring a…
- TextStudioBindingDiagnostic: Non-spamming runtime state surfaced by the binding authoring UI.
- TextStudioBindingDiagnosticCode: Stable diagnostic categories reported by a Text Studio UI Toolkit binding.
- TextStudioBindingSourceMode: Determines where a Text Studio UI Toolkit binding reads its authored markup.
- TextStudioBuiltInActionIds: Stable identifiers for actions included with Text Studio.
- TextStudioBuiltInEffectIds: Stable identifiers for effects included with Text Studio.
- TextStudioCanvasReactionParticleGraphic: Draws pooled reaction particles as spark geometry through normal Canvas masking.
- TextStudioCapabilityReport: Reusable, caller-owned capability snapshot. Collect again after configuration or topology changes.
- TextStudioCharacterSubstitutionContext: Transient update context provided to a character-substitution runtime.
- TextStudioCharacterSubstitutionDefinition: Metadata, aliases, examples, and parameter schema for one substitution tag.
- TextStudioCharacterSubstitutionResult: Reports the output and scheduling consequences of one substitution update.
- TextStudioCharacterVisibleEvent: Serialized callback carrying a visible-glyph index and displayed text.
- TextStudioCodeEffectAsset: Lean asset-backed definition for programmable leaf effects. Lifecycle, playback, curves, sequencing, and scope are authored by Composed Effect…
- TextStudioCodeEffectAsset<TState, TParameters>: Typed Code Effect asset with one default parameter struct and isolated per-glyph state.
- TextStudioColorAppearanceData: Build-reachable static image silhouettes. Original color textures remain independent from the scalar fields.
- TextStudioColorBlendMode: Chooses whether an effect replaces a glyph’s color, changes only its alpha, or multiplies the existing color.
- TextStudioColorSource: An immutable color image with its actual mesh and atlas UVs, expressed in source em coordinates.
- TextStudioColorUtility: Parses Text Studio color syntax and formats normalized hexadecimal color values.
- TextStudioCompiledWritingGlyph: Immutable glyph identity, design metrics, and prepared centerline and outline paths.
- TextStudioComposedEffectAsset: Reusable effect definition composed from ordered semantic effect and channel layers.
- TextStudioCompositionAuthoringSpace: Selects the 2D or 3D authoring controls used to configure a Composed Effect’s channel values.
- TextStudioCompositionChannel: Selects the glyph transform, color, opacity, UV, pivot, or corner-deformation channel driven by a Composed Effect layer.
- TextStudioCompositionColorMode: Chooses whether a Composed Effect color layer replaces the glyph color or multiplies its existing color.
- TextStudioCompositionLayer: One ordered effect or channel layer with phase, area, color, and influence-field configuration.
- TextStudioCompositionLayerKind: Identifies a Composed Effect layer as a channel operation, a referenced effect, or a Writing treatment.
- TextStudioCompositionTagSpec: Serializable tag selector used to scope a composed-effect layer to authored semantic tags.
- TextStudioCornerOffsets: Independent 2D offsets for the four vertices of a glyph quad. Values use Text Studio effect units and are applied before the glyph transform.
- TextStudioCurveDefinition: Serializable curve shape shared by inline settings and reusable profiles.
- TextStudioCurveMapping: Chooses whether custom-curve placement maps each selector match independently or maps the entire selected text as one range.
- TextStudioCurveProfile: Reusable shape sampled by effect playback and text placement.
- TextStudioCurveReference: One independently owned inline shape or a link to a reusable curve profile.
- TextStudioDefaultAttribute: Marks a field with a recommended default. The default property drawer renders a small reset button next to the field; clicking it writes the default…
- TextStudioDefaultEffectMode: Chooses whether default effects are disabled, fill gaps left by explicit effect tags, or apply alongside tagged effects.
- TextStudioDefaultEffectSettings: Serializable all-phase or per-phase default effect expressions applied when markup omits explicit effects.
- TextStudioDefaultEffectsSource: Identifies whether default effects are absent, supplied by a behavior profile, or authored inline on the text component.
- TextStudioDefaultSettings: Global Text Studio defaults. Text Studio does not ship a default settings asset. Users can optionally create one at Text Studio’s canonical…
- TextStudioDesignPresetAsset: Reusable one-click design recipe that assigns established Text Studio appearance, writing, and behavior assets without adding another runtime…
- TextStudioDeterministicHash: Stateless deterministic hashing for stable local variation without touching Unity random state.
- TextStudioDiagnostic: One markup diagnostic with severity, stable code, source range, message, and suggested action.
- TextStudioDiagnosticCode: Identifies the markup condition reported by a diagnostic, including recognized tags, syntax errors, missing parameters, incompatible backends, and…
- TextStudioDiagnosticReport: Immutable analyzed markup plus general and tag-specific diagnostics.
- TextStudioDiagnosticSeverity: Classifies markup diagnostics as information, warnings, or errors for authoring and validation feedback.
- TextStudioDialogueSource: Generic bridge for narrative, dialogue, subtitle, and speech-bubble systems. Third-party tools can call this component without taking a package…
- TextStudioDirtyGlyphView: Read-only view of the glyphs changed for the current frame.
- TextStudioEffectAliasAttribute: Declares an additional case-insensitive lookup name for a code-defined effect.
- TextStudioEffectAreaMode: Selects the glyph, word, line, paragraph, or matched range used as an effect’s spatial area.
- TextStudioEffectAreaSettings: Serializable semantic range selection used to limit an effect to glyphs, words, lines, or authored ranges.
- TextStudioEffectBoundsBehavior: Describes how an effect or renderer property can change rendered spatial bounds.
- TextStudioEffectCapabilities: Immutable phase, channel, performance, accessibility, determinism, render-domain, and bounds metadata for an effect.
- TextStudioEffectCompatibility: Compatibility result for an effect definition against one or more requested render domains.
- TextStudioEffectCompatibilityResolver: Resolves supported render domains and actionable compatibility status for effect definitions.
- TextStudioEffectCompatibilityState: Reports whether an effect fully or partly supports a target, is unsupported, or is blocked by a missing dependency.
- TextStudioEffectCurvePreset: Selects a named easing or response-curve recipe for effect parameters, including custom and reversed progress curves.
- TextStudioEffectDefinitionAsset: Serialized base for leaf and expansion-only effect definitions.
- TextStudioEffectInvocation: One externally submitted renderer-neutral effect layer and its normalized progress, intensity, phase, and glyph range.
- TextStudioEffectLayer: An owned effect layer. Dispose it to remove only this layer from the text.
- TextStudioEffectMetadata: Immutable discovery and parameter metadata for one effect definition.
- TextStudioEffectPerformanceTier: Classifies how an effect performs its work, from ordinary real-time evaluation to vertex streaming, material updates, geometry refresh, prepared…
- TextStudioEffectPlaybackPreset: Selects a reusable timing recipe for effect playback, including one-shot, looping, ping-pong, weighted, appearance, external, and custom playback.
- TextStudioEffectPlaybackRole: Defines whether authored playback controls an effect’s strength or its spatial progress.
- TextStudioEffects: Registers and resolves effect definitions, curves, and playback strategies. Runtime registrations have priority over project and built-in entries.
- TextStudioEffectUnitContext: Renderer-neutral per-unit source geometry, color, semantic indices, and world-space snapshots for effect evaluation.
- TextStudioEmissionHandle: Generation-safe reference to one active temporary emission.
- TextStudioEmissionMergeMode: Chooses whether matching temporary-text requests remain independent, sum their numeric values, or replace the active value within the merge window.
- TextStudioEmissionOutputSpace: Selects world coordinates, screen-projected positioning, or parent-local coordinates for a temporary-text emission.
- TextStudioEmissionOverflowPolicy: Chooses whether an emitter at capacity recycles its oldest active emission or rejects the incoming request.
- TextStudioEmissionPreset: Reusable presentation and lifecycle policy for temporary text. Gameplay meaning remains in the asset name and caller, not the runtime engine.
- TextStudioEmissionRequest: One temporary text request. Use the emitter convenience methods for common calls.
- TextStudioEmitter: Owns bounded, temporary Text Studio hosts. Presentation remains in profiles and prefabs.
- TextStudioExtensionApi: Version information for renderer-neutral Text Studio extension contracts.
- TextStudioExtensionProviderKind: Identifies an extension registration that supplies glyph geometry, event signals, or stateful preview behavior.
- TextStudioExtensionProviderRegistration: Generation-safe token for a registered neutral extension provider.
- TextStudioExtensionRegistrationFailure: Reports why an extension registration failed, including invalid targets or providers and invalid or conflicting glyph authority.
- TextStudioExtensionRegistry: Target-scoped registry for pose composition, exclusive transform authority, exact geometry, physical signals, and stateful preview. Registration may…
- TextStudioExtensions: Registers and resolves extension tags, character substitutions, and tag expansions.
- TextStudioExtensionTag: Immutable occurrence of a registered extension tag mapped to source and visible-glyph ranges.
- TextStudioExtensionTagBoundary: Identifies whether a parsed extension-tag invocation marks a single text position or a glyph range.
- TextStudioExtensionTagDefinition: Immutable schema and dispatch policy for a registered extension tag.
- TextStudioExtensionTagDispatch: Flags whether an extension tag dispatches during plan construction, on reveal, and when skipped content is flushed.
- TextStudioExtensionTagShape: Declares whether an extension tag’s syntax represents a single point or a paired range around text.
- TextStudioExternalEffectDriver: Exposes one effect definition as externally driven progress and intensity. The component owns no clock or lifecycle, so Animator, Timeline, tweens…
- TextStudioExternalEffectSubmissionContext: Allocation-free submission view passed to an external effect source.
- TextStudioFontAppearanceData: Build-safe font curves and MTSDF tiers. Players consume prepared fields and never execute a desktop baker.
- TextStudioFrame: Read-only frame view passed to every ITextStudioRenderer each pipeline tick. The view owns no buffers and does not allocate. Its data is…
- TextStudioFrameComposerRegistration: Registration token for one frame composer and its authority lease.
- TextStudioFrameCompositionContext: Canonical frame plus the independently composed target receiving it.
- TextStudioFrameTarget: Reference-identity target for one independently composed Text Studio output.
- TextStudioFrameTargetKind: Identifies the backend, external renderer, UI Toolkit output, or custom target associated with an extension’s text frame.
- TextStudioGenerationHandle: Generation-safe identifier used by extension registrations and authority leases.
- TextStudioGlyphAuthorityChannels: Flags the glyph transform, velocity, and visual-response channels exclusively claimed by a registered extension authority.
- TextStudioGlyphAuthorityLease: Generation-safe proof of exclusive target authority.
- TextStudioGlyphAuthorityRequest: Exclusive channel and glyph range requested by a stateful extension.
- TextStudioGlyphChangeSet: Semantic glyph correspondence for a text replacement. A changed glyph exits or enters; a retained glyph stays visually continuous across the…
- TextStudioGlyphColorBounds: Renderer-neutral local coordinates used to sample a glyph’s source corner colors. TMP-backed bounds are relative to the character origin and…
- TextStudioGlyphColorQuad: Renderer-neutral source colors for the four canonical corners of a glyph. The order matches TMP quads: bottom-left, top-left, top-right, bottom-right.
- TextStudioGlyphFieldContract: Explicit material contract for optional high-fidelity glyph fields. Multi Distance uses alpha for the Euclidean distance and the median RGB value…
- TextStudioGlyphFieldFormat: Channel layout supplied by a flat-text backend for one glyph atlas.
- TextStudioGlyphGeometryBuffer: Reusable destination for provider-supplied convex glyph geometry.
- TextStudioGlyphGeometryCapabilities: Flags whether a geometry provider supplies glyph bounds and planar or spatial convex shapes for simulation and interaction.
- TextStudioGlyphGeometryDetail: Selects fast or accurate geometry sampling when an extension requests glyph bounds or convex shapes.
- TextStudioGlyphGeometryRequest: Allocation-free geometry request for a renderer-neutral glyph identity.
- TextStudioGlyphIdentity: Stable semantic identity for one glyph within a compiled source generation.
- TextStudioGlyphImageAlpha: Whether stored RGB channels are independent or multiplied by alpha in the declared channel encoding. Alpha is linear coverage; providers with…
- TextStudioGlyphImageCapture: Captures exact images at the shaping boundary on the main thread. No Unity texture, pooled callback array or backend is retained by a successful…
- TextStudioGlyphImageColorSpace: Encoding of the image RGB channels; alpha is always linear coverage.
- TextStudioGlyphImageIdentity: Stable exact rasterization identity. ClusterText is the complete UTF-16 cluster, including ligatures and joiners; a Unicode scalar is not a…
- TextStudioGlyphImageRequest: One exact shaped occurrence. Revisions and layout positions are separate from the reusable raster identity.
- TextStudioGlyphImageSnapshot: Owned, immutable, bottom-row-first RGBA image in a glyph’s baseline plane. Workers may read this object without a Texture or backend lifetime.
- TextStudioGlyphImageStatus: Result of an exact shaped-image request. Missing capability never implies an empty image.
- TextStudioGlyphInstanceState: Complete renderer-neutral source, placement, animation, color, and simulation state for one glyph.
- TextStudioGlyphPose: Rest-relative or absolute pose contribution for one composed glyph.
- TextStudioGlyphQuadTransform: Resolved transform for one glyph quad. Render backends use this to apply Text Studio placement, animation, pivot, color, and alpha consistently.
- TextStudioGlyphQuadTransformer: Shared quad-space transform utility for TMP-style render backends.
- TextStudioGlyphSignalState: Bounded per-glyph physical signal values for visual response mapping.
- TextStudioGlyphStateWriter: Allocation-free writer scoped to one registered authority lease.
- TextStudioGlyphTransition: Canonical Typewriter state for one shaped text unit, independent of its renderer.
- TextStudioGlyphTransitionView: Allocation-free frame view over the owning Typewriter. Valid for the current frame only.
- TextStudioGlyphVisualBounds: Renderer-neutral local glyph bounds plus source visibility metadata.
- TextStudioGlyphVisualResponse: Bounded visual response contribution derived from simulation signals.
- TextStudioGlyphVisualResponseChannels: Flags the color, alpha, and scale response channels supplied by an extension that owns glyph visual response.
- TextStudioInfluenceField: One spatial falloff shape that multiplies a composed layer’s semantic area influence.
- TextStudioInfluenceFieldAxis: Selects the local X, Y, or Z axis used to orient an influence field.
- TextStudioInfluenceFieldCombine: Chooses how an influence field combines its weight with other fields: multiply, add, maximum, or minimum.
- TextStudioInfluenceFieldShape: Selects the spatial or procedural shape that produces an effect’s influence weight, including linear, radial, target-distance, and noise fields.
- TextStudioInfluenceFieldSpace: Selects whether an influence field samples source layout, normalized source text, placed text, or world coordinates.
- TextStudioInfluenceFieldStack: Ordered spatial influence fields combined into one allocation-free per-glyph weight.
- TextStudioInstantRange: Inclusive visible-glyph range whose reveal timing is collapsed to one instant boundary.
- TextStudioMarkerBinding: Serializable marker route, payload formatting policy, enabled state, and scene callback.
- TextStudioMarkerEventRouter: Inspector-friendly marker router for gameplay hooks such as dialogue commands, audio cues, camera beats, and quest events.
- TextStudioMarkerPayloadMode: Chooses the string delivered by a routed marker event: all joined arguments, the route’s event name, or its first argument.
- TextStudioMarkupDiagnostics: Analyzes authored markup for syntax, registration, compatibility, and parameter problems without rendering it.
- TextStudioMarkupPreprocessContext: Immutable context describing the host and source of one markup preprocessing pass.
- TextStudioMarkupSyntax: Configures project-wide or per-host authoring syntax without adding provider dependencies.
- TextStudioMessageEvent: Serialized callback carrying a message channel and payload.
- TextStudioMotionPolicy: Chooses full, reduced, or disabled motion for text effects, or inherits the project motion-accessibility setting.
- TextStudioMotionSettings: Global reduced-motion policy used to resolve effect and transition behavior.
- TextStudioNamedTagParameter: One parsed named parameter, flag, or multiplicative modifier from a tag.
- TextStudioNumberFormat: Shared numeric presentation used by persistent content and temporary emissions. Formatting occurs only when content changes.
- TextStudioOutputCapabilities: One output’s advertised capabilities. Unknown channels are never treated as unsupported.
- TextStudioOwnershipMode: Reports text and rendering ownership, distinguishing backend mirroring, driven text, external sources, and single or combined renderer output.
- TextStudioPageNavigator: Controls TextMeshPro page overflow manually or follows the page containing the latest revealed glyph.
- TextStudioPageUtility: Shared TMP page-overflow helpers for renderers and decorations.
- TextStudioParameterAliasAttribute: Adds an alternate inline markup parameter name for an effect field.
- TextStudioPhaseMask: Flags the reveal, active, and hide phases in which an effect invocation is enabled.
- TextStudioPlacementDimension: Describes whether a placement stays in the text plane or uses depth.
- TextStudioPlacementOrientation: Shared orientation policies used by path and spatial placement extensions.
- TextStudioPlanView: Read-only semantic plan consumed by renderers and integrations.
- TextStudioPlaySoundAction: Reusable Text Studio action asset that plays one of its configured audio clips when a matching markup action is reached during text playback.
- TextStudioPlaySoundActionComponent: Scene-bound sound action that can play through a supplied AudioSource and optionally pause text reveal until the clip ends.
- TextStudioPreparedColorField: A prepared scalar silhouette and the exact static image geometry from which it was produced.
- TextStudioPreparedFieldTier: Density and the full signed-distance decode interval are independent, explicit quantities.
- TextStudioPreparedGlyphField: One shaped glyph’s field placement. Bounds and canonical font curves use em coordinates.
- TextStudioPreparedWritingPath: Immutable adaptively flattened path prepared only when authored data changes.
- TextStudioPreparedWritingPoint: One allocation-free sample in a prepared stroke-distance stream.
- TextStudioPreparedWritingStroke: Prepared pen-down range with true-distance playback metadata.
- TextStudioPresentationGlyphWriter: Controlled writer for presentation-glyph substitutions.
- TextStudioPreview: Preview controller attached to a TextStudioText hub. Exposes Play / Pause / Restart / Scrub / ShowEndState operations that work identically in edit…
- TextStudioPreview.State: Opaque snapshot of preview playback, scrubbing, segments, and timing settings for later restoration.
- TextStudioPreviewCameraPose: Renderer-supplied camera framing for a preview stage.
- TextStudioPreviewDiagnostic: Renderer-specific preview status with an optional suggested action.
- TextStudioPreviewDiagnosticSeverity: Classifies preview-stage feedback as information, success, warning, or error.
- TextStudioPreviewQuality: Chooses draft or full quality for preview-stage rendering.
- TextStudioPreviewSegment: Flags the reveal, active, and hide segments included in an authoring preview’s playback cycle.
- TextStudioPreviewStageCapabilities: Flags the views, comparison modes, quality controls, and material or lighting diagnostics offered by a preview-stage provider.
- TextStudioPreviewStageMode: Selects automatic preview composition, flat 2D output, the active renderer’s output, or a comparison view.
- TextStudioPreviewStageSettings: Immutable renderer-preview mode, viewpoint, quality, and comparison layout.
- TextStudioPreviewView: Selects a front, perspective, side, or orbit camera view for a preview stage.
- TextStudioPrimaryOutputOwnership: How an external renderer relates to the text backend’s primary visual output.
- TextStudioProjectSettings: Optional user-created project-level settings. Ships zero assets by default; a user can create one via Assets → Create → Text Studio → Project…
- TextStudioRangeAttribute: Compact ranged float attribute used by Text Studio effect authoring. Renders as a slider with optional snap increment and unit suffix.
- TextStudioReactionAction: Selects the response performed by a Reaction: play an effect, send a signal, play an audio cue, or invoke a custom action.
- TextStudioReactionActionAsset: Asset-only authoring definition; scene references belong to host bindings.
- TextStudioReactionActionEvents: Flags the completion, arrival, impact, break, and return events a Reaction action can emit for dependent responses.
- TextStudioReactionActionRequirements: Flags the live or retained anchors, geometry, targets, physics, and output capabilities a Reaction action requires.
- TextStudioReactionActionSample: Events and event time produced by one action sample, including whether its target was lost.
- TextStudioReactionAnchor: A semantic text unit pose resolved by its current renderer host.
- TextStudioReactionAnchorSpace: Coordinate system used by a resolved reaction anchor.
- TextStudioReactionAsset: Reusable reaction definitions. Live state and scene bindings belong to each host.
- TextStudioReactionBallisticMotionActionAsset: One finite, deterministic launch of a renderer-owned retained semantic unit.
- TextStudioReactionBodyEventSession: Session token for observing events from one released semantic body without consuming them.
- TextStudioReactionBuiltInLibrary: Package-owned reaction assets exposed through the shared Built-In picker.
- TextStudioReactionBuiltInLibrary.Entry: Authored catalog entry linking a built-in reaction recipe to its display information, resource path, and supported outputs.
- TextStudioReactionCancelReason: Identifies why a running Reaction was cancelled, including explicit requests, host or text changes, lost targets, unsupported capabilities, and…
- TextStudioReactionCanvasGraphic: Draws a retained native text mesh through normal Canvas masking and hierarchy order.
- TextStudioReactionCaptureCapability: Side-effect-free backend support result with a stable, allocation-free explanation.
- TextStudioReactionCaptureIntent: Declares whether capture requests a glyph-presentation copy or detachment from live text; the provider reports support separately.
- TextStudioReactionCaptureRequest: Requests a retained outgoing resource or a current-frame anchor snapshot.
- TextStudioReactionCaptureSupport: Reports whether outgoing-glyph capture is unsupported, supported with declared visual limitations, or exact.
- TextStudioReactionChangeKind: Identifies a Reaction-triggering text change as replacement, append, replay, or no change.
- TextStudioReactionContext: Immutable event data. Unit indices refer to the source generation that emitted the event.
- TextStudioReactionDependencyEvent: Selects the predecessor’s completion, arrival, impact, break, or return event that starts a dependent Reaction.
- TextStudioReactionEffectSource: Chooses a built-in effect or a custom effect asset for a Reaction’s effect response.
- TextStudioReactionLayer: A finite response. Timing here controls the response, never typewriter progression.
- TextStudioReactionLease: Backend-owned retained output. Slots are versioned; releasing a copied handle twice must be harmless.
- TextStudioReactionMotionActionAsset: Analytic retained-unit motion; the capture provider owns the visible output.
- TextStudioReactionOutputKinds: Text outputs a built-in reaction recipe is designed for. Renderer Independent recipes suit every host; otherwise a recipe is offered when a host has…
- TextStudioReactionOverlap: Chooses whether repeated Reaction triggers may overlap, restart the existing response, or are ignored while it runs.
- TextStudioReactionPanelTargetBinding: A UI Toolkit target resolved within the binding’s current panel.
- TextStudioReactionPrefabActionAsset: Plays one pooled prefab per selected unit; particle prefabs use the same lifetime.
- TextStudioReactionPreviewCapability: Declares whether a Reaction action supports only Play Mode, direct deterministic seeking, or bounded resimulation during authoring previews.
- TextStudioReactionRecipe: Renderer-neutral reaction configuration selected by a host or behavior profile.
- TextStudioReactionResourceClass: Flags the glyph geometry, material state, sprites, decorations, and layered geometry retained by a Reaction capture.
- TextStudioReactionSource: Identifies whether Reaction settings are absent, selected from a built-in recipe, supplied by a custom recipe, or authored inline.
- TextStudioReactionSpawnAnchor: Chooses whether a spawned Reaction object follows a live text unit or uses a captured outgoing-unit pose.
- TextStudioReactionTarget: Selects the text units affected by a Reaction: all text, the triggering unit, word or line, or changed incoming or outgoing units.
- TextStudioReactionTrigger: Semantic events emitted by the text lifecycle, independently of rendering.
- TextStudioReactionUIParticle: One particle in the active UI renderer’s local units relative to an event anchor.
- TextStudioReactionUIParticleLease: A versioned output owned by the active UI renderer.
- TextStudioReactionUISparkActionAsset: A bounded, deterministic spark burst drawn by the active UI renderer.
- TextStudioReactionVisualSample: Motion and color of one retained unit in its source renderer’s local text space.
- TextStudioReactionWorldTargetBinding: A scene-local world or Canvas target referenced by reaction layers through a key.
- TextStudioReadOnlyBuffer<T>: Zero-allocation read-only view over a bounded portion of an engine-owned array. The view is valid only for the duration documented by the API that…
- TextStudioReadOnlyBuffer<T>.Enumerator: Value-type enumerator over the bounded engine-owned buffer.
- TextStudioReducedMotionBehavior: Declares whether an effect is preserved, reduced, or disabled when reduced motion is requested.
- TextStudioRenderChannels: Flags the evaluated glyph transform, geometry, and surface channels a renderer needs to consume.
- TextStudioRenderDirectiveWriter: Allocation-free writer for target-scoped typed renderer directives.
- TextStudioRenderDomain: Flags whether an effect supports flat text, extruded 3D text, or both output domains.
- TextStudioRendererEffectExecution: How one compiled effect binding is executed for the current renderer set.
- TextStudioRendererEffectExecutionRequest: Allocation-free request used to negotiate exact renderer execution for one compiled effect binding. The plan and effect instances are engine-owned…
- TextStudioRendererEffectExecutionView: Read-only per-binding ownership selected by the hub after every relevant renderer accepted exact execution. A false result means the shared CPU…
- TextStudioRenderPropertyBlendModes: Flags the additive, multiplicative, override, and interpolation operations supported by a render-property descriptor.
- TextStudioRenderPropertyDescriptor: Immutable registration contract for one namespaced renderer property.
- TextStudioRenderPropertyGlyphView: Read-only renderer-property values for one glyph.
- TextStudioRenderPropertyId: Stable serialized identifier for a renderer property.
- TextStudioRenderPropertyPerformanceClass: Classifies the work needed to update a render property, including immediate evaluation, vertex streaming, geometry refresh, prepared deformation, or…
- TextStudioRenderPropertyRegistry: Registry for typed renderer properties. Serialized assets retain stable IDs.
- TextStudioRenderPropertyStage: Identifies the pipeline stage that applies a render property, from glyph and vertex evaluation to materials, geometry, topology, or simulation.
- TextStudioRenderPropertyValue: Typed scalar, vector, color, or unsigned renderer-property value.
- TextStudioRenderPropertyValueType: Identifies the scalar, vector, color, or unsigned-integer value stored by a render-property descriptor.
- TextStudioRenderPropertyView: Transient read-only view over pooled renderer-property planes.
- TextStudioRenderPropertyWriter: Scoped allocation-free writer passed to effects.
- TextStudioResolvedBehaviorSettings: Resolves the three renderer-neutral behavior domains independently.
- TextStudioResolvedEffectBinding: Resolved effect definition plus its authored binding.
- TextStudioRevealDebugSnapshot: Immutable reveal/timing snapshot for inspectors, diagnostics, and integration health checks. Reading this type does not mutate the text pipeline.
- TextStudioRevealState: Reports Typewriter playback as idle, revealing, paused, waiting between loops, or complete.
- TextStudioRuntimeServices: Process-wide service overrides used by Text Studio runtime components. Assign TextStudioRuntimeServices.InputProvider before playback to replace the…
- TextStudioSelectorComparison: Selects the equality or ordered comparison used by a numeric or render-property selector condition.
- TextStudioSelectorNodeKind: Identifies a selector condition or composition node, including text ranges, tags, source colors, semantic state, coverage, properties, and Boolean…
- TextStudioSelectorSemanticState: Flags the visibility, reveal phase, and word or line boundary states that a selector can match on text units.
- TextStudioSequenceDirection: Selects logical text order or a spatial direction for ordering selected text units.
- TextStudioSequenceOrder: Chooses forward, backward, center-out, edges-in, simultaneous, or deterministic random ordering for a text-unit sequence.
- TextStudioSequenceSettings: Serializable ordering, grouping, direction, seed, and stagger spread for reveal or hide sequencing.
- TextStudioShapedGlyphFeature: Optional shaped-glyph data that an external backend can publish.
- TextStudioShapedGlyphFeatureSet: Describes which shaped-glyph features are present and which represent the backend’s final rendered state rather than a compatible derivation.
- TextStudioShapedGlyphPreparationSnapshot: Caller-owned shaped glyph and font-face data for one representative preparation sample.
- TextStudioSignal: Normalized signal math shared by component and UI Toolkit integrations.
- TextStudioSignalDestination: Chooses whether a signal driver writes normalized effect progress or effect intensity.
- TextStudioSignalDriver: Applies one normalized signal through the shared external-effect contract each runtime frame.
- TextStudioSignalSource: Chooses whether a signal driver reads an explicit normalized value, audio amplitude, or beat input.
- TextStudioSoundClipSelection: Chooses sequential, random, or named clip selection for a sound action invoked from text markup.
- TextStudioSourceColorMetric: Selects hue, saturation, perceptual luminance, or alpha when source glyph color contributes an effect’s influence weight.
- TextStudioSourceColorSelector: Optional source-color range selector that filters a composed layer by hue, saturation, luminance, or alpha.
- TextStudioSourceModeAuthoringAttribute: Marks the source selector for Text Studio’s retained UI Builder authoring control.
- TextStudioStackChange: Classifies which compiled stack domains changed.
- TextStudioStackDiagnostic: One deterministic validation or compilation diagnostic.
- TextStudioStackDiagnosticSeverity: Classifies appearance-stack validation and compilation feedback as information, warnings, or errors.
- TextStudioStackFingerprint: Independent deterministic identities for style compilation domains.
- TextStudioStackFingerprintUtility: Compares stack fingerprint domains to distinguish topology, parameter, render-state, and bounds changes.
- TextStudioStackItemId: Stable serialized identity shared by Text Studio appearance-stack items.
- TextStudioStatefulPreviewFidelity: Reports how a stateful extension reconstructs preview state: exact evaluation, reset-and-replay, checkpoint recovery, or approximation.
- TextStudioStatefulPreviewSeekMode: Chooses whether a stateful preview seek prioritizes a fast result or exact state reconstruction.
- TextStudioSurfaceGroup: Explicit additional lettering sources for glyph-derived surfaces on this text. The owning style renders the surface once.
- TextStudioSurfaceMask: Logical glyph surfaces that a renderer property may target.
- TextStudioTagAnalysisContext: Optional backend, catalog, and project-specific suggestion values used by markup diagnostics.
- TextStudioTagBackend: Flags the text backends and feature levels for which a catalogued markup tag is supported.
- TextStudioTagCatalog: Searchable catalog of supported tags assembled from built-ins and installed extension contracts.
- TextStudioTagCategories: Stable category identifiers used to group tags in discovery and authoring UI.
- TextStudioTagCategory: Groups catalogued markup tags by purpose, including effects, cues, formatting, integrations, and appearance.
- TextStudioTagDefinition: Immutable discovery and validation schema for one built-in, native, action, or extension tag.
- TextStudioTagDiagnostic: Diagnostic annotation associated with one parsed tag occurrence.
- TextStudioTagExpansionClosingMode: Chooses closing markup derived automatically from an expansion’s opening markup or supplied explicitly by the author.
- TextStudioTagExpansionEntry: One stable shorthand tag expansion with opening and derived or custom closing markup.
- TextStudioTagExpansionSheet: Reusable shorthand-tag sheet resolved before canonical markup parsing.
- TextStudioTagKind: Identifies how parsed markup is interpreted, including native formatting, effects, extensions, actions, markers, Typewriter controls, expansions…
- TextStudioTagOwnership: Identifies whether Text Studio consumes a markup tag or passes it through to the active text backend.
- TextStudioTagParameterDefinition: Parameter name, aliases, type, requirement, defaults, examples, and suggestion metadata for a tag.
- TextStudioTagParameterKind: Declares the value format accepted by a markup parameter, including numbers, colors, vectors, pivots, routes, and asset references.
- TextStudioTagParameterOperation: Chooses whether a named markup parameter assigns a value or multiplies the parameter’s existing value.
- TextStudioTagParameterRequirement: Declares whether a tag optionally accepts parameters, requires them, or forbids them.
- TextStudioTagParameters: Allocation-free read view over positional and named parameters parsed from one tag. Lookup is case-insensitive and later named values take precedence.
- TextStudioTagShape: Declares whether a catalogued tag surrounds a text range, marks a single point, or is self-contained markup.
- TextStudioTagSuggestionKeys: Stable lookup keys for injecting project-specific parameter suggestions.
- TextStudioText: Central TextStudio hub. Owns the authored markup, runs the full pipeline (tokenize, resolve, layout, placement, reveal, effects) once per tick, and…
- TextStudioTextBackendCapabilities: Flags the shaping, bidirectional text, color, rich-text, editing, geometry, and animation features exposed by a text backend.
- TextStudioTextBackendChange: Classifies a backend notification so the hub can refresh the affected data.
- TextStudioTextBackendIds: Stable identifiers used to select built-in text backends.
- TextStudioTextChangeMode: Controls how currently displayed content leaves when typewriter-driven text is replaced.
- TextStudioTextChangeScope: Controls which semantic glyphs participate in an animated text replacement.
- TextStudioTextProjection: Immutable, complete native parse projection with original formula provenance.
- TextStudioTextProjectionSpan: One owned mapping from projected UTF-16 text to its original input span.
- TextStudioTextRange: A half-open range of logical text units, resolved relative to one scope.
- TextStudioTextShapingRisk: Detects Unicode patterns that may require a complex-shaping-capable text backend.
- TextStudioTextUnit: Mapping between one semantic reveal unit and its resolved, display, source, and visible-glyph ranges.
- TextStudioTextUnitBoundary: Allocation-free Unicode text-unit traversal using UTF-16 offsets. Inline objects remain atomic.
- TextStudioTimingContext: Allocation-free semantic context supplied to custom reveal timing assets.
- TextStudioTimingDiagnostic: Snapshot of reveal timing, active wait state, and estimated completion for diagnostics UI.
- TextStudioTimingDiagnostics: Converts runtime reveal snapshots into stable timing diagnostics.
- TextStudioTimingEvaluator: Calculates the delay in seconds after one semantic text unit becomes visible.
- TextStudioTimings: Registers and resolves reusable typing-timing assets.
- TextStudioTypewriterEventRelay: Bridges Text Studio playback events to serialized UnityEvents for scene authoring.
- TextStudioTypewriterPreset: Reusable authoring asset containing a complete typewriter settings recipe and gallery metadata.
- TextStudioTypewriterRecipe: Chooses a built-in preset, custom preset asset, or inline settings as one resolvable typewriter recipe.
- TextStudioTypewriterSettings: Complete serializable reveal, hide, timing, transition-effect, skip, and looping configuration for a typewriter host.
- TextStudioTypewriterSkipHideMode: Chooses whether skipping hide removes glyphs immediately or lets the current hide effect finish.
- TextStudioTypewriterSkipRevealMode: Chooses whether skipping reveal settles reveal effects immediately or lets those effects finish after all units become revealed.
- TextStudioTypewriterSource: Identifies whether Typewriter settings are absent, selected from a built-in preset, supplied by a custom preset, or authored inline.
- TextStudioTypewriterStartMode: Chooses manual Typewriter start or automatic start when the host is enabled, its text changes, or either event occurs.
- TextStudioTypewriterTimingMode: Chooses whether typing follows its cadence or waits for a unit’s reveal animation to finish before applying the reading pause.
- TextStudioTypewriterWaitEvent: Serialized callback carrying glyph index, character, wait kind, and duration in seconds.
- TextStudioTypewriterWaitInfo: Immutable notification describing a timed, input, or custom wait in reveal or hide playback.
- TextStudioTypewriterWaitKind: Identifies a Typewriter wait that ends after a duration, on input, or through a custom wait handler.
- TextStudioUITK: Attaches, retrieves, and detaches Text Studio through Unity’s native text binding slot.
- TextStudioUITKCapabilities: Reports UI Toolkit animation and text-generator capabilities for the active Unity version.
- TextStudioUITKFeatureSet: Reports a UI Toolkit binding’s supported feature level as unavailable, basic text output, or full Text Studio parity.
- TextStudioUITKTextGeneratorPreference: Chooses UI Toolkit’s standard text generator, prefers its advanced generator, or follows the project default.
- TextStudioUITKUpdateMode: Selects whether a UI Toolkit binding owns its playback clock or is stepped by its host.
- TextStudioUnityUITextBackend: Drives a legacy Text through Text Studio while preserving Unity’s Canvas mesh pipeline. The component must run before other mesh modifiers so…
- TextStudioVisibilityDiagnostics: Evaluates whether a Text Studio host has content, a valid target, layout, glyphs, and visible output.
- TextStudioVisibilityIssue: Flags inactive state, missing content or targets, reveal state, and ownership conditions that explain why text may not be visible.
- TextStudioVisibilityReport: Immutable visibility-readiness report with issue flags, diagnostic state, and user guidance.
- TextStudioVisualCapabilities: Flags the logical mappings, glyph metrics, bounds, orientation, atlas, distance-field, and source-color data available in a backend visual snapshot.
- TextStudioVisualFontSource: A per-font companion record keeps resource references out of each visual glyph.
- TextStudioVisualGlyph: Renderer-neutral glyph source and its semantic text-unit owner.
- TextStudioVisualSnapshot: Allocation-free visual-source view consumed by style, geometry, compositor, and extension renderers. Buffers remain engine-owned and are valid only…
- TextStudioVisualSourceKind: Identifies a visual snapshot entry as an ordinary font glyph, a color font glyph, or an inline sprite.
- TextStudioVisualVersion: Independent source revisions used to invalidate only dependent renderer caches.
- TextStudioWordBoundary: Unicode default word boundaries. Dictionary-based languages may supply a host-specific provider.
- TextStudioWorldBatchGroup: Opt-in world batching for one atomic text assembly. Every enabled descendant world-space Text Studio text draws its complete Appearance in painter…
- TextStudioWriting3DMode: Selects how one Writing Style is presented by an extruded 3D renderer.
- TextStudioWritingBrush: Analytical retained-ribbon profile used without extra textures, materials, or draws.
- TextStudioWritingCompiler: Compiles writing assets into bounded true-distance paths and deterministic fallback data.
- TextStudioWritingConfiguration: Reusable writing appearance and playback settings.
- TextStudioWritingDataLevel: Describes the strongest source data backing a resolved writing result.
- TextStudioWritingDirection: Selects the cardinal or diagonal direction used by directional Writing reveals.
- TextStudioWritingGlyphKey: Stable font, glyph, and variation identity for an authored glyph path.
- TextStudioWritingGlyphRecord: Serializable glyph metrics and authored centerline and outline strokes for one font variation.
- TextStudioWritingKnot: One cubic path knot. Control points are stored in the same coordinate space as the knot.
- TextStudioWritingMode: The authored visual promise made by a writing style.
- TextStudioWritingModeUtility: Maps writing modes to the source data required by their authored appearance.
- TextStudioWritingResolution: One explicit deterministic result from the honest writing fallback ladder.
- TextStudioWritingResolver: Selects compatible phrase or glyph paths and reports fallback to ink coverage or ordinary typewriter reveal.
- TextStudioWritingResolveRequest: Describes the resolved phrase, shaping identity, glyph variation, and backend data available for writing path selection.
- TextStudioWritingShapingFingerprint: Computes shaped phrase identities from text, glyph variation, clustering, and layout without translation or backend unit scale.
- TextStudioWritingSourceKind: Identifies whether Writing resolved to a prepared phrase path, glyph paths, glyph coverage, ordinary Typewriter behavior, or no source.
- TextStudioWritingStroke: An authored pen-down path. Separate rows represent explicit pen lifts.
- TextStudioWritingStrokeCap: Selects the round, butt, or square shape used at the ends of a rendered Writing stroke.
- TextStudioWritingStrokeJoin: Selects the round, bevel, or miter shape used where adjacent Writing stroke segments meet.
- TextStudioWritingStrokeRole: Distinguishes a prepared Writing path along a stroke centerline from one following a glyph outline.
- TextStudioWritingStyleAsset: Reusable glyph drawing treatment evaluated by the Typewriter lifecycle.
- TextToken: Flat token struct output by the tokenizer. References ranges into the source text via indices.
- TokenKind: Token types produced by the single-pass tokenizer.
- TypingTimingsBase: Base class for semantic reveal pacing. Returned values are waits applied after the current text unit has become visible.
- UnityInputManagerTextStudioInputProvider: Advance-input provider backed by Unity’s built-in UnityEngine.Input.anyKeyDown state.
- WavePlacement: Wave placement: applies a sine wave offset to layout Y positions. The local tangent of the sine curve is stored in tangent so the hub’s rotation…
- WordRange: Word segmentation range.
- WordTimings: Word-paced reveal timing settings.
- WritingFontAsset: Font-specific authored centerlines and prepared contours keyed by glyph variation.
- WritingPhraseAsset: Authored stroke data for one exact shaped phrase and layout fingerprint.
TextStudio.BuiltIns
Section titled “TextStudio.BuiltIns”- BuiltInReactionPresets: Curated reaction starting points. Convert a selection to Inline for per-host edits.
- CodeEffectBase: Base class for stateless code-defined effects. All parameters are fields with sensible defaults. These never reference UnityEngine.Object subclasses…
- ITextStudioBuiltIn: Implemented by code-defined built-ins so editor and runtime tooling can read common metadata.
- TextStudioBuiltInReactionPreset: A curated reusable response stack compiled without an asset load.
TextStudio.Editor
Section titled “TextStudio.Editor”- ITextStudioAuthoringCapabilityProvider: Implemented by optional editor packages that add authoring support for another text render domain. Providers must have a parameterless constructor.
- ITextStudioGalleryProvider: Editor extension point that contributes discoverable creation or setup cards to the Text Gallery. Implementations must have a parameterless…
- ITextStudioTMPSetupProvider: Editor extension point that adds Text Studio setup actions for selected TextMeshPro targets. Implementations must have a parameterless constructor.
- TextGalleryCard: Immutable gallery contribution describing discovery text, preview content, and user actions.
- TextGalleryCardActionState: Current primary and optional secondary actions displayed by a gallery card.
- TextGalleryCategory: Selects the gallery’s setup, reveal, effects, design, placement, or add-on category, with an option to show every card.
- TextGalleryPreviewContext: Describes the gallery surface requesting a card preview.
- TextGalleryPreviewFactory: Creates an editor-owned preview element for a Text Gallery card.
- TextGalleryPreviewQuality: Identifies the preview route actually provided by a gallery card, including native UI Toolkit, fallbacks, static or live rendering, and TMP material…
- TextGalleryProductionMetadata: Typed production guidance shown alongside a gallery card. Preview fidelity remains a separate concern so a card never implies that its lightweight…
- TextGalleryReducedMotionSupport: Behavior exposed when users request less motion.
- TextGalleryRenderCost: High-level render cost disclosed by a gallery recipe.
- TextGalleryRendererSupport: Renderer families on which a gallery recipe can be used as authored.
- TextGalleryResourceRequirements: External or prepared data required by a gallery recipe.
- TextGalleryWorkflow: The primary Text Studio workflow demonstrated or installed by a gallery card.