Text Studio — 3D API Reference

This reference is generated from the shipped Text Studio — 3D assemblies and their XML documentation.

TextStudio.ThreeD

Back3DSpec: Back-cap closure, tessellation, and relief authoring for one layer.
BevelJoinType: Bevel join types for polygon offsetting.
BevelProfile: 2D cross-section of a bevel, swept around a glyph contour. A profile is an ordered list of (offsetXY, offsetZ) samples that define a polyline…
BevelSides: Which ends of a layer’s extrusion receive a bevel. When layers are stacked, bevels only belong on the outward-facing ends of the overall solid…
BevelSpec: One end of a layer’s bevel (either front or back cap), with independent size, thickness, offset, profile, join style, and miter-limit controls.
Body3DSpec: Depth, cross-section, and sweep authoring for the layer body.
BodyShell3DMode: Whether the swept glyph body is solid or reduced to a bounded wall shell.
BodyShell3DSpec: Independent wall recipe for the extruded body cross-section.
BodySweep3DMode: How the extruded body travels from its back face to its front face.
BodySweep3DSpec: Body sweep selection independent from front-face treatment.
BuiltInBevelProfiles: Code-defined library of reusable BevelProfile assets. Instances are lazily allocated as hidden scriptable objects (…
BuiltInBevelProfiles.Id: Enum-friendly IDs for the built-in profiles.
BuiltInExtrudeStyles: Code-defined 3D extrusion preset library. No shipped .asset files required. Resolved at runtime when no Extrude3DStyle is assigned, and exposed to…
BuiltInExtrudeStyles.Preset: Selects a built-in 3D text appearance recipe with predefined geometry layers and materials.
BuiltInExtrudeStyles.PresetCategory: Groups built-in extrusion recipes by their primary geometry or appearance treatment so preset pickers can present related styles together.
BuiltInExtrudeStyles.Recipe: Public-data description of a built-in style. Every call to BuiltInExtrudeStyles.GetRecipe(BuiltInExtrudeStyles.Preset) owns a fresh layer array that…
BuiltInMaterials: Shared runtime material library used by the built-in 3D styles. Shipped material assets live under Resources so they can be resolved from any Asset…
BuiltInMaterialSets: Curated, package-relative material sets for beginner-friendly surface styling.
BuiltInMaterialSets.Preset: Selects a coordinated built-in material set for styling the surface regions of 3D text.
Cap3DMode: Whether one end of the extruded layer is closed by a cap or intentionally open.
CapRefinement3DMode: Controls how a closed cap is tessellated before optional relief deformation.
CapRefinement3DSpec: Independent topology refinement recipe for one closed cap.
CompiledTextStudio3DAppearancePlan: Immutable, typed 3D programs and semantic occurrence composition. Owns no rendering resources.
CompiledTextStudio3DStyle: Validated, resolved snapshot consumed by the runtime geometry pipeline. Authored stroke inheritance is flattened once when the style changes rather…
Contour3DSpec: Contour selection, expansion, and outline-ring authoring for one layer.
ContourCornerFlags: Marks whether a contour corner was authored, derived, or preserved as a sharp feature.
ContourErrorPolicy: Declared positional allowances in the set’s current coordinate units, not measured error claims.
ContourLoopRange: A closed contiguous loop. Parent loops precede children; nested outer islands own a new component.
ContourLoopRole: Distinguishes a filled outer boundary from an enclosed hole boundary.
ContourProvenanceKind: Describes whether an edge is traced to an analytic source interval or was generated during processing.
ContourRepeat3DCornerPolicy: Policy applied to sharp points on a repeated contour path.
ContourRepeat3DDistribution: Rule used to resolve the number of repeated contour attachments.
ContourRepeat3DProvider: Built-in geometry providers repeated at deterministic physical intervals around contours.
ContourRepeat3DSpec: Discrete geometry repeated at stable physical intervals around selected cap contours.
ContourRoundingModule: Rounds sharp glyph-outline corners before extrusion while preserving counters and advance widths.
ContourSide: One directed edge as observed at a vertex. The incoming interval ends at that vertex; the outgoing interval starts there. SourceInterval parameters…
ContourSourceSegment: Original segment identity plus its immutable curve in this contour set’s coordinate space.
ContourTangentContinuity: States whether the incoming and outgoing tangents form a continuous curve at a vertex.
ContourTangentKind: Identifies whether an edge tangent comes from the source curve or its geometric approximation.
ContourTube3DSpec: A closed circular or custom cross-section swept around glyph contours.
ContourTube3DSurface: Terminal cap surfaces that can receive a contour tube.
ContourVertex: A contour position with directed neighboring edges and corner continuity metadata.
CounterBevel3DMaterialMode: Surface regions used by the bevels surrounding glyph counters and hollow shells.
Decoration3DProfileRecipe: Built-in cross-sections for material-addressable cap decorations.
Decoration3DSpec: Geometry attached to or emitted from the primary layer surfaces.
Deformation3DSpec: Topology-stage deformation applied through the depth of one layer.
Deformer3DAxis: Chooses the primary coordinate axis along which a mesh deformation operation is evaluated.
Deformer3DSpace: Selects the coordinate space and glyph, word, line, or text grouping used to evaluate deformation bounds and operations.
Deformer3DSpec: An ordered, inspectable deformation operation in a DeformerModule .
Deformer3DType: Selects the continuous mesh deformation algorithm applied by an operation, such as bending, wrapping, twisting, or procedural displacement.
DeformerBounds3D: Bounds and edge falloff used by one mesh deformer. Automatic bounds follow the selected semantic coordinate space; custom bounds are expressed…
DeformerModule: Applies an ordered stack of continuous, topology-preserving operations to every generated 3D glyph region before mesh assembly.
DepthParameterizationKind: How a compiled solid responds to authored body depth.
DepthShape: Depth-axis shape modifiers applied to the body between bevels. These turn a straight extrusion into a tapered column, twisted shaft, or bulging…
Edge3DSpec: Bevel and boundary-edge treatment shared by the front and back ends.
Extrude3DStyle: Reusable 3D text style preset. Controls extrusion, bevels, and material assignment. Create via Assets → Create → Text Studio → 3D → Extrude Style…
ExtrusionPathAsset: Serializable extrusion-path contract for reusable authoring assets. Implementations must expose a deterministic identity that changes whenever their…
ExtrusionPathFrameSample: Additional cross-section controls layered over a path’s sampled frame.
FaceRelief3DMode: Cap-face shaping independent from the layer’s body sweep.
FaceRelief3DSpec: Controls the relief surface generated across the front cap.
Font3D: Generated source-outline companion for a TMP font. It contains only the exact font bytes and their provenance. Reusable generated geometry lives in…
Front3DSpec: Front-cap closure, tessellation, and relief authoring for one layer.
GlyphDecorationModule: Places pooled prefab decorations at generated glyph sockets in Play Mode.
GlyphMeshData: Raw mesh data for a single generated glyph, before assembly into final Unity Mesh.
GlyphSolidBakedReason: Deterministic reasons that retain full depth-dependent construction.
GlyphSolidEligibility: Reports the selected depth policy without inspecting a style name.
IExtrusionPath: Abstraction for a 3D extrusion path used by BodySweep3DMode.Path . Implementations sample a position + orientation frame at normalised parameter t ∈…
IExtrusionPathCacheIdentity: Stable content identity for extrusion paths that may participate in shared geometry caches. Implementations must change…
IExtrusionPathFrameProfile: Optional advanced frame contract for an IExtrusionPath . Existing path implementations remain valid without it and receive an open, identity profile.
ITextStudio3DAuthoring: Focused authoring and style contract for a Text Studio 3D renderer.
ITextStudio3DBuilds: Focused geometry build, validation, and prewarming contract.
ITextStudio3DContourModifier: Extends the pre-geometry pipeline by editing glyph contours through a build-scoped module context.
ITextStudio3DDecorationProvider: Adds module-owned decorative geometry to generated glyph entries.
ITextStudio3DDeformer: Transforms generated glyph buffers after per-glyph geometry has been built.
ITextStudio3DFaceReliefProvider: Supplies custom front or back face relief during the geometry build.
ITextStudio3DFeedbackOutput: Optional interaction adapter that translates generic control feedback into device haptics.
ITextStudio3DGlyphs: Focused stable-handle contract for querying and changing generated glyph output.
ITextStudio3DLifecycleModule: Receives host attachment and activity transitions for reusable module assets.
ITextStudio3DPhysicalLetters: Focused explicit physical-letter control and logical-body query contract.
ITextStudio3DPostProcessor: Processes the final assembled mesh after glyph geometry has been combined.
ITextStudio3DRenderInput: A capture-owned, deterministic input history. All times are seconds from the start of the take.
ITextStudio3DRenderInputProvider: Implemented by an enabled component beside the source text to snapshot an external input history for Render Studio.
ITextStudio3DSweepPathProvider: Configures a custom depth sweep path before glyph body generation.
ITextStudio3DTextInputTarget: Accepts focus, editing, selection, and submission commands from a spatial keyboard or input adapter.
ITextStudio3DVisualModule: Observes final per-frame glyph state without mutating the shared animation pipeline.
LayerScope3DMode: Semantic group that receives a layer when its selection matches.
LayerSelection3DMode: How an authored layer chooses the visible glyphs it affects.
LayerSelection3DSpec: Selects which visible glyphs receive a layer without changing the layer’s geometry recipe. Selection is evaluated before stacking, so omitted layers…
LayerStacking3DMode: How an authored layer relates to the preceding depth stack.
LayoutElementModule: Applies curve-weighted position, rotation, and scale after base text placement and before mesh assembly.
LayoutModuleScope: Chooses whether a layout transform is applied independently to each glyph or once around the center of the complete generated text.
LinearExtrusionPath: Identity path: reproduces the original straight-Z extrusion. Useful as a default and for tests.
LODParams: Deterministic construction parameters; LevelIndex carries no scheduling meaning.
MaterialRegion: Built-in material regions for submesh assignment. Active custom modules may register build-local values beginning after MaterialRegion.BackBevel .
MeshOutputMode: Output modes for 3D mesh assembly.
MicroChamferKind: Identifies a vertex inserted at the start or end of a small corner chamfer.
Module3DBase: Base class for Text Studio 3D modules that plug into the TextStudio3DText geometry pipeline. Modules are for genuinely 3D-specific concerns that…
ModuleContext: Context passed to modules during pipeline execution. Contours are detached copies of the font-outline cache, so pre-geometry edits cannot corrupt…
ModuleExecutionStage: Flags choosing when a module participates in the 3D text pipeline, including geometry processing, mesh assembly, lifecycle, and final visual…
ModuleVariableType: Identifies the value category of a named module input so requests can match the serialized value held by a shared VariableHolder.
PathMaterialMapping3DMode: UV policy for surfaces that travel along an extrusion path.
Placement3DSpec: Layer-to-layer placement independent from contour and geometry construction.
QuadraticBezierExtrusionPath: Quadratic Bézier path between (0,0,0) → (0,0,-depth), with an optional mid- control point that bends the path out of the straight line. Useful for…
QuadraticBezierExtrusionPathAsset: Reusable quadratic extrusion sweep with deterministic content identity. Inspector edits and QuadraticBezierExtrusionPathAsset.Configure(Vector3…
QualityTierSelector: Finite construction levels and explicit error budgets. Construction detail is independent of runtime scheduling.
StrokeAlignment: Alignment mode for the stroke (true outline) ring, relative to the source glyph silhouette. Picture a pen of width width tracing the glyph boundary…
StrokeInheritMode: Cascade policy controlling how a layer’s strokes relate to the previous (already-resolved) layer’s strokes. Works like CSS inheritance: Override…
StrokeSpec: Parameters for the "true outline" stroke pass. When StrokeSpec.width is greater than zero, the geometry generator replaces the layer’s source…
SubmeshRange: A contiguous range of indices corresponding to a single MaterialRegion .
Surface3DSpec: Material assignments and mapping for every currently supported layer region.
SurfaceMapping3DMode: Texture-coordinate projection used by one layer’s generated surfaces.
SurfaceMapping3DOverride: Overrides texture mapping for one built-in semantic surface.
SurfaceMapping3DSet: Default texture mapping plus optional semantic-surface overrides. Surface boundaries use the same region metadata as materials, exports, LODs, and…
SurfaceMapping3DSpec: Projection and transform policy for generated surfaces.
TextStudio3DAnimationBackend: Selects automatic, main-thread, or parallel processing preferences for animated 3D mesh updates.
TextStudio3DAppearanceOccurrence: A resolved invocation of a full 3D style. Mapping coordinates use Domain even when replacement splits its visible ranges.
TextStudio3DAttachmentDistribution: Selects whether deterministic attachment samples are distributed by surface area, contour arc length, or a mixture of both.
TextStudio3DAttachmentDomains: Flags selecting contour and surface attachment sample domains requested by companion effect consumers.
TextStudio3DAttachmentExposurePolicy: Identifies the surface state represented by an attachment sample, currently the finalized text surface.
TextStudio3DAttachmentOrientation: Primary direction used by contour attachments and named socket rotations.
TextStudio3DAttachmentPose: Current world-space frame of an attachment. Static samples remain unchanged as text moves.
TextStudio3DAttachmentRequest: Immutable demand for deterministic attachment samples.
TextStudio3DAttachmentSample: A topology-stable local-space sample from finalized text geometry.
TextStudio3DAttachmentSnapshot: Short-lived immutable view valid until its subscription revision changes.
TextStudio3DAttachmentSubscription: Reference-type attachment lease owned by one companion consumer.
TextStudio3DAuxiliaryCapacityScope: How a retained effect’s declared auxiliary-vertex ceiling scales.
TextStudio3DBackingShape: Canonical generated backing silhouettes.
TextStudio3DBoundsBehavior: Declares whether a module leaves mesh bounds unchanged, stays inside the source bounds, requires recalculation, or may expand unpredictably.
TextStudio3DBoundsContourSource: Canonical contour fitted dynamically around the incoming text contour bounds.
TextStudio3DBuildRequest: Renderer-owned token for a cancellable geometry build. New requests supersede work already dispatched.
TextStudio3DBuildRequestState: Reports the status of a renderer-owned geometry build request, distinguishing pending work, completion, cancellation, supersession, failure, and…
TextStudio3DBuiltInEffectIds: Stable identifiers for effects included with Text Studio 3D.
TextStudio3DButton: Provides a pressable 3D control that renders a text label and raises a click event on activation.
TextStudio3DCompanionClockFlags: Flags describing clock sampling state for companion effects, including first samples, paused clocks, reverse playback, seeks, and discontinuities.
TextStudio3DCompanionControl: Exclusive, instance-owned control of a source effect family’s build progress or discharge intensity.
TextStudio3DCompanionEffectRecord: Semantic invocation identity shared with secondary renderers. Evaluate coverage and appearance through the source text.
TextStudio3DCompanionEffectSnapshot: Immutable revisions, clocks and counts for the current prepared companion effects.
TextStudio3DCompanionEvaluationStatistics: Work and execution mode from the last bulk companion query. Counts describe CPU evaluation, not GPU simulation or rendering.
TextStudio3DCompanionFamily: Source effect families whose build progress or intensity a script can drive.
TextStudio3DCompanionGlyphSemantic: Segmentation and stable seed data used by exact per-glyph timing.
TextStudio3DCompanionInfluence: Evaluated source coverage at one attachment, before companion-specific density or quality.
TextStudio3DConcurrentPressPolicy: Chooses whether a spatial control accepts only the first pressing pointer or allows multiple independent pointer press sessions.
TextStudio3DContourAsset: Reusable serialized 2D contour data for logos, symbols, and program operands.
TextStudio3DContourIssue: Problems that make a 2D contour unsafe for deterministic 3D geometry generation.
TextStudio3DContourLoopInfo: Immutable information about one arc-length-parameterized contour loop.
TextStudio3DContourPolicies: Explicit source-curve allowances for the supported font normalization range.
TextStudio3DContourProgram: Reusable ordered contour composition. It can begin from the incoming text contour, its fitted bounds, or a contour asset, then apply transformed…
TextStudio3DContourProgramOperation: One ordered boolean or clipping operation in a contour program.
TextStudio3DContourProgramSource: Starting contour used by a reusable contour program.
TextStudio3DContourProgramStep: Serializable parameters for one reusable contour-program operation.
TextStudio3DContourSample: A position and stable local frame sampled at physical distance along a contour loop.
TextStudio3DContourSampler: Allocation-free sampling of the flattened contour’s physical distance. The immutable owner is retained, and attributed tangents describe its…
TextStudio3DContourSet: Canonical immutable closed contours. Empty geometry is valid and retains its advance; a missing glyph is represented by null at the provider boundary.
TextStudio3DContourSourceAsset: Reusable contour source accepted by contour programs.
TextStudio3DContourTubeProfile: Reusable closed cross-section swept along a glyph contour by ContourTube3DSpec . Points use normalized radial (X) and face-normal (Y) coordinates…
TextStudio3DContourUtility: Explicit validation and geometry-preserving construction of authored polygons.
TextStudio3DContourValidationReport: Detailed result from an explicit contour validation pass.
TextStudio3DControl: Interaction-system-independent base for spatial controls. Every pointer keeps an independent hover and press session, while controls decide whether…
TextStudio3DControlLayout: Arranges an ordered set of spatial controls in linear, grid, circular, spline, or volume layouts.
TextStudio3DControlLayoutMode: Selects the spatial arrangement used to position an ordered set of 3D controls, including linear, grid, circular, spline, and volume layouts.
TextStudio3DControlPool: Owns a bounded Unity object pool for reusable world-space control prefab instances.
TextStudio3DControlState: Combinable interaction states used to resolve a spatial control’s label, surface, scale, and depth feedback.
TextStudio3DControlTheme: Maps combined hover, focus, press, selection, disabled, and error states to reusable control visuals.
TextStudio3DControlVisual: Applies a control’s resolved theme state to label geometry, surface renderers, and specialized moving parts.
TextStudio3DControlVisualKind: Identifies the semantic control role of a visual component that presents labels, surfaces, and optional moving parts.
TextStudio3DControlVisualStyle: Describes label, surface, scale, and depth feedback for one combined control state.
TextStudio3DDecorationAttachment: Controls whether a prefab decoration retains its socket pose from the geometry build or follows the glyph’s animated socket.
TextStudio3DDesignPresetAsset: Reusable apply-once 3D design recipe assembled from established Text Studio owners. The recipe itself is never retained by the renderer after…
TextStudio3DDropdown: Combines a selected 3D option label with a reusable list panel that can be opened and closed.
TextStudio3DDwellIndicator: Tracks uninterrupted gaze hover, presents normalized dwell progress, and optionally activates its control.
TextStudio3DEffectCapability: Immutable preparation, scheduling, bounds, and capacity contract for a native 3D effect.
TextStudio3DEffectExecutionDomain: Renderer execution domains used by prepared native 3D effects.
TextStudio3DEffectExecutionRoute: How a prepared effect is scheduled in the renderer.
TextStudio3DEffectFallbackReason: Why an invocation cannot use prepared playback yet.
TextStudio3DEffectPreparationInvalidation: Inputs that are allowed to invalidate prepared effect data.
TextStudio3DEffectPreparedData: Immutable data that an effect requires before playback can begin.
TextStudio3DEffectSpatialField: A spherical effect field measured in world units, independent of text scale.
TextStudio3DElectricDischarge: Deterministic phase authority shared by the retained bolt, local illumination and companion emission.
TextStudio3DElectricDischargePhase: Stages of one deterministic electric discharge cycle, from charging and leader growth through attachment, return stroke, branch decay, and afterglow.
TextStudio3DElectricDischargeState: Immutable phase, progress and intensity for one deterministic electric discharge sample.
TextStudio3DElectricDischargeTiming: Relative phase durations for the native discharge and all companion consumers.
TextStudio3DEntryCollection: Allocation-free indexed and pattern-enumerable view over all generated glyph-layer entries in a module build.
TextStudio3DEntryCollection.Enumerator: Pattern enumerator over build-scoped generated entry views.
TextStudio3DEntryView: Read-only view over one generated glyph-layer entry. The view references the active module context and allocates no wrapper objects.
TextStudio3DFeedbackKind: Identifies the control event that requests visual, audio, or haptic feedback, including hover, press, activation, value changes, rejection, and…
TextStudio3DFeedbackRequest: Describes semantic control feedback and an optional normalized haptic impulse requested for one interaction.
TextStudio3DFeedbackRequestEvent: Unity event that publishes generic visual, audio, or haptic feedback requests.
TextStudio3DGeneratedContourAsset: Reusable procedural backing source for contour programs.
TextStudio3DGeneratedLodOverride: Automatic is Unity’s generated LOD selection; explicit overrides are restored after higher-priority surface access ends.
TextStudio3DGeometryCacheStats: Read-only occupancy, memory, hit, insertion, replacement, and eviction counters for the shared glyph-geometry cache.
TextStudio3DGeometryDiagnostics: Retained construction qualification for a generated or prepared glyph payload.
TextStudio3DGeometryImpact: Classifies a module’s effect on geometry, distinguishing lifecycle or visual work from vertex updates and topology changes.
TextStudio3DGeometryValidationReport: Aggregate result from validating one or more generated glyph meshes.
TextStudio3DGeometryValidator: Reusable, allocation-stable validator for generated glyph mesh buffers. One validator instance owns its scratch storage and can be reused across…
TextStudio3DGlyphCollection: Allocation-free indexed and pattern-enumerable view over visible glyph identities in a module build.
TextStudio3DGlyphCollection.Enumerator: Pattern enumerator over build-scoped visible-glyph views.
TextStudio3DGlyphEntryCollection: Allocation-free pattern-enumerable view over the generated layer entries belonging to one visible glyph.
TextStudio3DGlyphEntryCollection.Enumerator: Pattern enumerator over generated entries for one visible glyph.
TextStudio3DGlyphHandle: Stable reference to one visible-glyph and authored-layer entry that becomes stale when its owner replaces topology.
TextStudio3DGlyphHandleCollection: Allocation-free view of every generated layer entry addressed by a visible-glyph range. Enumerated handles remain stable until the owning renderer…
TextStudio3DGlyphHandleCollection.Enumerator: Pattern enumerator that resolves current handles without allocating a collection.
TextStudio3DGlyphLibraries: Explicit ownership for prepared geometry loaded from AssetBundles or Addressables. Dispose the returned token before unloading the content that owns…
TextStudio3DGlyphLibrary: Persistent, material-neutral geometry for exact font, topology, and quality variants. A library can serve multiple fonts and styles without…
TextStudio3DGlyphLibraryRegistration: Owns one runtime glyph-library registration and releases it when disposed.
TextStudio3DGlyphRange: Topology-versioned selection of consecutive Text Studio visible glyph identities. The range becomes stale when the renderer replaces or clears its…
TextStudio3DGlyphView: Read-only build-scoped view of one visible glyph and all generated layer entries that belong to it.
TextStudio3DHandedness: Identifies the left or right hand associated with an interaction pointer, or no hand for input that has no handedness.
TextStudio3DImageAppearance: Zero preserves existing monochrome geometry; newly prepared image content uses NativeAppearance explicitly.
TextStudio3DImageContourResult: Detached contour preparation result, including an explicit empty-mask result and deterministic work counts.
TextStudio3DImageContours: Worker-safe deterministic marching squares over owned RGBA alpha. It does not infer vector curves from pixels.
TextStudio3DImageFallback: Explicit response to missing exact pixels; no Unicode substitution or invisible success is permitted.
TextStudio3DImageTracePolicy: Bounded binary-center tracing. Foreground is four-connected, background eight-connected; only exact collinear simplification is performed.
TextStudio3DInputContentType: Selects character filtering and display masking rules for a spatial text field, including unrestricted, numeric, password, and PIN input.
TextStudio3DInputField: Provides a focusable spatial text field with caret, selection, content filtering, masking, validation, and submission.
TextStudio3DInteractionContext: Immutable pointer snapshot carrying interaction identity, phase, world pose, pressure, time, and optional feedback output.
TextStudio3DInteractionContextEvent: Unity event that publishes immutable spatial interaction snapshots.
TextStudio3DInteractionPhase: Identifies the current step of a spatial pointer interaction, covering hover, press, drag, release, cancellation, and control activation.
TextStudio3DInteractionSource: Identifies the input mechanism that produced a spatial interaction, including desktop pointers, touch, XR pointing, gaze, navigation, and scripted…
TextStudio3DKeyboardCommand: Selects the editing, caret, selection, submission, or cancellation command sent by a spatial keyboard to its active text input target.
TextStudio3DKeyboardKey: Maps activation of a spatial control to one character-editing or keyboard command.
TextStudio3DLayer: Single layer in a Text Studio 3D layer stack. Controls extrusion depth, bevels, depth-axis shaping, material assignment, and topology. Its…
TextStudio3DLifecycleEvent: Allocation-free lifecycle notification emitted by TextStudio3DText . A build request ID of zero means the topology was produced by a normal hub…
TextStudio3DLifecycleState: Identifies a 3D text lifecycle notification for enabling, building or clearing topology, disabling, or destroying the renderer.
TextStudio3DList: Presents an ordered option collection as selectable 3D text rows with disabled-item handling.
TextStudio3DMaterialRegionDefinition: Describes one semantic material region registered by a custom 3D module.
TextStudio3DMaterialRegionRegistry: Per-renderer, per-build registry for semantic regions emitted by custom geometry modules. Built-in region values remain stable at 0-8; custom values…
TextStudio3DMaterialSet: Reusable material assignments for all built-in 3D surface regions. Applying a set changes materials only and preserves the layer’s mapping policy.
TextStudio3DMemoryPressure: Coordinates idle cache trimming and cancellation without destroying live rendered or queried payloads.
TextStudio3DMemorySnapshot: On-demand payload accounting. Shared categories are process-wide and must not be added once per renderer. Referenced categories overlap their shared…
TextStudio3DMemoryTrimReport: One completed main-thread trim. Ownership estimates do not claim immediate GC or driver memory reclamation.
TextStudio3DMenuAction: UnityEvent-friendly menu command for a 3D Button.
TextStudio3DMenuActionType: Selects the spatial menu command for showing or stacking a panel, returning to the previous panel, or closing menus.
TextStudio3DMenuController: Shows one spatial menu panel at a time and maintains bounded push/pop navigation history.
TextStudio3DMenuFactory: Instantiates production spatial UI prefabs resolved through a caller-supplied library.
TextStudio3DMenuPrefabLibrary: Resolves package-provided production prefabs by stable spatial UI role without requiring a fixed package path.
TextStudio3DMenuTransition: Animates a spatial panel between hidden and shown local poses using unscaled time.
TextStudio3DMeshChannels: Flags declaring the vertex streams, index data, and material-region metadata required by a 3D extension module.
TextStudio3DMeshDetailPreset: Coordinated polygon-detail presets for procedural 3D text.
TextStudio3DMeshQualityCertificate: One fixed-depth, bidirectional whole-surface certificate against authored output. It makes no analytic-source claim.
TextStudio3DModuleDescriptor: Immutable capability report for one extension module. The conservative defaults on Module3DBase keep raw callback modules safe when they declare…
TextStudio3DModuleRole: Flags identifying the extension responsibilities a module provides, including contour editing, relief, sweep paths, deformation, decorations…
TextStudio3DModuleThreading: Declares a 3D module’s compatibility with main-thread execution, managed jobs, or Burst processing.
TextStudio3DNamedSocket: A reusable named socket definition. The semantic anchor is resolved from the current rendered glyph, then the offset and Euler rotation are applied…
TextStudio3DNavigationDirection: Specifies spatial or sequential focus movement between 3D controls; explicit directional links can override automatic spatial selection.
TextStudio3DNavigationGroup: Owns focus navigation across spatial controls using explicit links, order, or position-based scoring.
TextStudio3DNavigationLinks: Defines optional per-direction focus targets that override a navigation group’s spatial resolution.
TextStudio3DOption: Stores a stable ID, label, presentation assets, interactability, and application metadata for one selectable item.
TextStudio3DOptionEvent: Unity event that publishes a defensive option snapshot after selection changes.
TextStudio3DOptionPresentation: Arranges authored option controls as a flat list, depth stack, rotary wheel, or radial menu.
TextStudio3DOptionPresentationMode: Chooses how authored option controls are presented as a flat list, depth stack, rotary wheel, or radial menu.
TextStudio3DOutlineCacheStats: Observable ownership and lifetime counters for one renderer’s parsed font-provider registry, glyph-outline LRUs, and parser-specific codepoint…
TextStudio3DPerformanceProfile: Workload presets that configure mesh output ownership, animation processing, chunk size, and automatic LOD behavior for 3D text.
TextStudio3DPlacementPattern: Selects the spatial form used to distribute and orient glyphs, including curved arrangements, a staircase, and a three-dimensional grid.
TextStudio3DPlacementPreset: Selects a named starting configuration of spatial placement parameters for common helical, carousel, globe, tunnel, staircase, and grid arrangements.
TextStudio3DPointerButton: Identifies the pointer button involved in a spatial interaction, or None for input without a button.
TextStudio3DPointerCapturePolicy: Chooses whether a pressed pointer continues delivering drag and release updates to a control after leaving its collider.
TextStudio3DPointerRaycaster: Routes scripted, mouse, touch, ray, gaze, and direct pointer sessions to colliders owned by spatial controls.
TextStudio3DPreparedEffectStats: Read-only diagnostics for one renderer’s prepared native-effect plan.
TextStudio3DPreparedGlyphImage: Prepared exact shaped image and reusable solid. It stores owned pixels and canonical geometry and needs no shaping backend or font at playback.
TextStudio3DPrewarmResult: Reports bounded exact-glyph preparation, reuse, unavailable variants, invalid geometry, truncation, and unsupported configurations.
TextStudio3DProgressBar: Presents a bounded numeric value through a 3D label and an optional local-scale fill transform.
TextStudio3DProjectedQualityError: Screen-space silhouette and normal error bounds for one qualified camera view.
TextStudio3DProjectSettings: Canonical Text Studio 3D project configuration. Prepared font bindings and reusable authoring coverage live here while the prepared mesh payload…
TextStudio3DQualityBudget: Explicit authoring policy. Default is unconfigured, never a measured quality preset.
TextStudio3DQualityCatalog: Immutable finite level catalog. Availability is supplied separately and never changes construction identity.
TextStudio3DQualityCertificationDiagnostics: Construction observations, kept separate from frame-selection cost and certificate identity.
TextStudio3DQualityCertificationLimits: Explicit construction budget, not a measured shipping preset.
TextStudio3DQualityCertificationStatus: Reports why whole-surface quality certification completed or stopped.
TextStudio3DQualityConstructionLevel: Requests a reduced mesh construction level by bevel detail and curve tolerance.
TextStudio3DQualityDecision: The desired and available quality levels with their worst projected error and selection status.
TextStudio3DQualityDecisionStatus: Explains whether a quality level was qualified, held, unavailable, or needs more evidence.
TextStudio3DQualityErrorEnvelope: Producer-owned geometry evidence. Construction tolerances alone do not establish this contract.
TextStudio3DQualityErrorReference: The reference against which a producer established a complete output error bound.
TextStudio3DQualityLevel: One bounded construction level. Index zero is the exact authored ceiling.
TextStudio3DQualityMigrationStatus: Reports whether serialized legacy viewport thresholds need an explicit quality budget or recovery.
TextStudio3DQualityNormalModel: Identifies the surface normal interpretation covered by a quality certificate.
TextStudio3DQualityProjection: Conservative homogeneous displacement bounds for a complete, producer-qualified local error envelope.
TextStudio3DQualityProjectionReason: Identifies the evidence or projection condition that prevents a finite quality bound.
TextStudio3DQualityProjectionStatus: Reports whether projected error is bounded, cannot be qualified, or lies outside the view.
TextStudio3DQualitySelection: Pure selection over certified finite levels and caller-owned availability. It cannot start runtime preparation.
TextStudio3DQualityState: Caller-owned transition state. Neither time nor availability enters a geometry key.
TextStudio3DQualityView: Value snapshot of one camera in the error envelope’s frame. Plane normals point into the frustum. No camera or array is retained.
TextStudio3DReleaseActivationPolicy: Controls whether release activates a pressed control only while the pointer is over it or anywhere while that pointer remains captured.
TextStudio3DRenderInputTarget: Provides capture-owned text controls and translates recorded world positions into the isolated take.
TextStudio3DRenderProperties: Defines and registers the stable material, vertex, and topology property IDs supported by Text Studio 3D effects.
TextStudio3DRepositionHandle: Moves a target transform along a pointer-defined drag plane while retaining the standard spatial control lifecycle.
TextStudio3DRuntimeGeometryPolicy: Determines whether one text object may generate missing glyph geometry or must resolve exact variants from the canonical project store or registered…
TextStudio3DRuntimeOverrideFields: Flags identifying which visibility, depth, tint, material, and quality values override authored 3D text settings at runtime.
TextStudio3DRuntimeOverrides: Immutable, non-destructive runtime layer for visibility, depth, tint, material, and bounded quality overrides.
TextStudio3DSelector: Cycles through an ordered option collection and publishes index, item, and label selection events.
TextStudio3DShaderAbi: The public vertex and prepared-effect wire contract. Versions describe declarations, not native qualification.
TextStudio3DShaderBakeBehavior: Whether a pipeline supports baking only from an explicitly frozen submitted snapshot.
TextStudio3DShaderContract: Immutable, versioned declaration. Validity does not certify device formats, visuals or timings.
TextStudio3DShaderContractAsset: Authoring data for a customer shader. Put an asset below a Resources/TextStudio3D/ShaderContracts directory for automatic registration in Editor and…
TextStudio3DShaderContractAsset.PassDefinition: Serializable authoring values for one named shader pass, converted into an immutable pass contract.
TextStudio3DShaderContractAsset.PipelineDefinition: Serializable authoring values for one render pipeline variant and its declared passes.
TextStudio3DShaderCoverage: Fragment capabilities only. These flags never grant a CPU rendered-coverage query or raycast evaluator.
TextStudio3DShaderDecisionReason: Why negotiation rejected the requested shader route or selected its explicitly supplied CPU fallback.
TextStudio3DShaderExecution: Execution routes a pipeline declares, from static geometry through prepared vertex effects; flags describe capability rather than measured shader…
TextStudio3DShaderExecutionDecision: A declaration-based scheduling result, not evidence of native shader or packed-format qualification.
TextStudio3DShaderExecutionNegotiation: Matches a requested rendering route against registered shader declarations and each material’s active passes.
TextStudio3DShaderExecutionRequest: One compatible renderer group. HasExactCpuFallback is an explicit caller guarantee that its CPU implementation preserves all requested…
TextStudio3DShaderFeature: Optional shader inputs and effects that must be supported by both a pipeline and its requested passes.
TextStudio3DShaderGeometryPositionSource: A declared position dependency only. Exact CPU queries still require an independently qualified evaluator for every active displacement feature.
TextStudio3DShaderNormalInterpolation: A source declaration only; current material features and the placed normal transform must also qualify.
TextStudio3DShaderPassContract: One authored pass. Absent roles are unsupported; an engine fallback pass is not silently declared.
TextStudio3DShaderPassRole: Roles of authored shader passes; declaring a role does not imply a substitute pass when it is absent.
TextStudio3DShaderPipelineContract: A capability declaration for the selected SubShader’s RenderPipeline tag.
TextStudio3DShaderPose: Current and previous vertex poses supplied to a shader pass.
TextStudio3DShaderRegistry: Owns shader-reference/material-mode registrations on the main thread. Register customer declarations before rendering and dispose their leases with…
TextStudio3DShaderTransport: Effect-data transports available to a shader pipeline.
TextStudio3DShaderVertexLayout: Vertex upload layouts declared by a pipeline; candidate packed layouts require separate native qualification.
TextStudio3DSlider: Maps pointer movement or programmatic activation onto a bounded numeric range and optional 3D thumb.
TextStudio3DSocketKind: Semantic anchors available on every current glyph handle.
TextStudio3DSocketPose: Immutable world-space socket pose resolved from the current rendered glyph state. Direct semantic lookup uses the outward normal as up and the face…
TextStudio3DSpatialGridFlow: Chooses whether rows, columns, or depth layers are filled first when distributing consecutive glyphs in a spatial grid.
TextStudio3DSpatialKeyboard: Dispatches spatial key commands to an explicit input field or the field that currently owns global text focus.
TextStudio3DSpatialPlacement: Component-provided spatial placement for the shared Text Studio placement pipeline. It computes only position/orientation; ordinary Text Studio…
TextStudio3DSpatialPrefabEntry: Associates a spatial UI role with the production prefab used to instantiate that control or menu.
TextStudio3DSpatialPrefabKind: Identifies the control or menu role used to resolve a production prefab from a spatial UI prefab library.
TextStudio3DStats: Read-only snapshot of current geometry, output, animation, physics, and recent rebuild workload.
TextStudio3DStrokeBindingInfo: Value-only identity of the exact source selected before geometry-cache lookup. An empty native identity denotes a direct authored-key request.
TextStudio3DStrokeBuildDiagnostics: Immutable extraction, exact binding and consumer diagnostics retained after pooled build scratch is returned.
TextStudio3DStrokeBuildInput: Immutable per-glyph geometry input. Actual authored paths are resolved before a geometry cache is consulted.
TextStudio3DStrokeConfidence: Describes the evidence available for an extracted or authored stroke path.
TextStudio3DStrokeDiagnostics: Structural evidence and resource accounting. Topology verification does not certify medial-axis accuracy or native performance.
TextStudio3DStrokeEdge: One arc-length polyline between graph nodes. A loop has equal start/end nodes and an explicit coincident terminal point.
TextStudio3DStrokeExtractionSettings: Bounded extraction controls in the contour’s coordinate units. These are work limits, not measured quality claims.
TextStudio3DStrokeExtractor: Identifies the method that produced a stroke centerline graph.
TextStudio3DStrokeFallbackPolicy: Controls whether a missing authored stroke is rejected or replaced by automatic extraction.
TextStudio3DStrokeFontBinding: Explicit mapping from prepared native font bytes and collection face to an authored Writing font key. Glyph indices are never remapped.
TextStudio3DStrokeGraph: Immutable shared centerline graph for placement and tube generation; contains no Unity object or callback-owned buffer.
TextStudio3DStrokeIssues: Flags missing inputs, topology problems, and work or output limits encountered during stroke construction.
TextStudio3DStrokeNode: A shared stroke graph point with local clearance and component connectivity.
TextStudio3DStrokeNodeKind: Classifies a stroke graph node by its connection role.
TextStudio3DStrokePoint: A sampled point on a stroke edge with tangent, clearance, and cumulative arc length.
TextStudio3DStrokeSourceMode: Selects perimeter geometry, automatic centerline extraction, or an authored stroke path.
TextStudio3DStrokeSourceSettings: Serialized authoring choices. A compiled snapshot resolves the Unity asset before any worker receives build input.
TextStudio3DStyleBinding: Chooses how a linked style is resolved.
TextStudio3DStyleCompiler: Validates authored 3D layers and resolves inheritance into deterministic runtime geometry and material snapshots.
TextStudio3DStyleDirtyFlags: Flags distinguishing material refreshes from topology rebuilds when a compiled 3D style changes.
TextStudio3DStyleFingerprint: Separates deterministic topology, material, and complete-content identity for a compiled style.
TextStudio3DStyleIssue: Reports one informational, warning, or error condition found while resolving an authored style layer.
TextStudio3DStyleIssueSeverity: Classifies a style compiler diagnostic as informational, a warning, or an error so authoring tools can present its importance.
TextStudio3DStyles: Registers 3D styles by stable Tag ID, with explicit runtime overrides above the project catalog.
TextStudio3DStyleSource: Chooses instance-owned layers or a linked style.
TextStudio3DSurfaceAccess: Explicit preparation/residency ownership. Dispose releases generated-LOD retention; a disabled owner invalidates the lease.
TextStudio3DSurfaceAttachment: A hit-derived persistent attachment retaining actual canonical detail until disposed.
TextStudio3DSurfaceBackfaces: Controls whether a ray may hit triangles facing away from its origin.
TextStudio3DSurfaceFallback: Identifies detail retention or a slower evaluation path used to keep surface queries exact.
TextStudio3DSurfaceHit: Contains the nearest exact hit, including a reusable triangle reference and its current world pose.
TextStudio3DSurfaceQueryDiagnostics: Per-call work and effective-detail diagnostics. Counts describe executed work, never performance qualification.
TextStudio3DSurfaceQueryMode: Geometry follows submitted vertices. Fragment alpha, clipping and transparency require RenderedCoverage.
TextStudio3DSurfaceQueryOptions: Limits ray distance and selects the surface mode, face orientation, and material regions to test.
TextStudio3DSurfaceQueryStatus: Reports the outcome of a surface query or the reason exact evaluation was unavailable.
TextStudio3DSurfaceReference: Identifies one exact compiled triangle. It is not semantic correspondence between independently tessellated LODs.
TextStudio3DText: 3D text renderer add-on. This component no longer owns text, reveal, placement, animation, font choice, or layout. The central TextStudioText hub…
TextStudio3DTextBoundsComposition: How the incoming text contour composes with a generated text-bounds backing.
TextStudio3DTheme: Reusable project theme that supplies a shared font, prepared 3D font data, default and named extrusion styles, and interaction visuals for themed…
TextStudio3DThemeAction: UnityEvent-friendly action that applies one theme to a scope.
TextStudio3DThemeScope: Supplies an inheritable 3D theme to descendant text and controls, falling through when no theme is assigned.
TextStudio3DThemeStyleBinding: Selects a theme’s default style, named variation, control-label style, or gameplay-feedback style for a themed 3D text object.
TextStudio3DThemeStyleVariation: Read-only named style variation stored by a reusable 3D theme.
TextStudio3DToggle: Provides a two-state spatial control with separate labels and a value-changed event.
TextStudio3DTopologySampling: Sampling policy for effects that rebuild geometry rather than deforming a stable mesh.
TextStudio3DVertexUploadDecision: Layout selection only. A declaration and device support do not establish visual, normal-error or performance qualification.
TextStudio3DVertexUploadFallback: Reason a requested packed vertex upload uses the qualified float layout instead.
TextStudio3DVertexUploadPolicy: Selects a declared upload layout across all materials while keeping float as the qualified default.
TextStudio3DVertexUploadPreference: Float remains the qualified default. PackedSNorm16Prototype explicitly requests an unqualified device prototype.
TextStudio3DVisualModuleContext: Read-only final-frame context passed to visual-only 3D modules.
TextStudio3DWritableBuffer<T>: Retained writable scratch storage owned by one module context. Request the same element type and slot on later builds to reuse capacity without…
TextStudio3DWritingStrokeAdapter: 3D-owned adapter. Writing remains renderer independent. Only explicit Centerline strokes are accepted.
VariableHolder: Typed variables shared by 3D modules on a text object.
VariableHolder.Variable: Typed module input with a case-insensitive lookup key; use its owner for runtime changes.