ITextStudio3DBuilds
public interface ITextStudio3DBuildsFocused geometry build, validation, and prewarming contract.
Methods
Section titled “Methods”
RebuildGeometry()
Section titled “RebuildGeometry()”void RebuildGeometry()Immediately rebuilds generated geometry on Unity’s main thread from the current text and authoring state.
ScheduleGeometryBuild()
Section titled “ScheduleGeometryBuild()”TextStudio3DBuildRequest ScheduleGeometryBuild()Coalesces a deferred main-thread rebuild and returns a request that can be queried or canceled before dispatch.
Returns
TextStudio.ThreeD.TextStudio3DBuildRequest
CancelGeometryBuild(TextStudio3DBuildRequest)
Section titled “CancelGeometryBuild(TextStudio3DBuildRequest)”bool CancelGeometryBuild(TextStudio3DBuildRequest request)Cancels a matching pending build request if it has not started.
Parameters
| Name | Type |
|---|---|
request |
TextStudio.ThreeD.TextStudio3DBuildRequest |
Returns
System.Boolean
GetGeometryBuildRequestState(TextStudio3DBuildRequest)
Section titled “GetGeometryBuildRequestState(TextStudio3DBuildRequest)”TextStudio3DBuildRequestState GetGeometryBuildRequestState(TextStudio3DBuildRequest request)Returns whether a request is pending, completed, canceled, superseded, or unknown to this renderer.
Parameters
| Name | Type |
|---|---|
request |
TextStudio.ThreeD.TextStudio3DBuildRequest |
Returns
TextStudio.ThreeD.TextStudio3DBuildRequestState
PrewarmGlyphs(string, int)
Section titled “PrewarmGlyphs(string, int)”TextStudio3DPrewarmResult PrewarmGlyphs(string characters, int maxGlyphs = 256)Synchronously warms shared geometry for a bounded set of unique Unicode scalars without replacing the rendered mesh.
Parameters
| Name | Type | Description |
|---|---|---|
characters |
System.String | Characters whose resolved glyph geometry should be cached. |
maxGlyphs |
System.Int32 | Maximum unique Unicode scalars to process, clamped to 256. |
Returns
TextStudio.ThreeD.TextStudio3DPrewarmResult
ValidateCurrentGeometry()
Section titled “ValidateCurrentGeometry()”TextStudio3DGeometryValidationReport ValidateCurrentGeometry()Validates the latest post-module glyph buffers and assembled output without changing normal render behavior.
Returns
TextStudio.ThreeD.TextStudio3DGeometryValidationReport
Properties
Section titled “Properties”
TextStudio3DStats Stats { get; }Returns
TextStudio.ThreeD.TextStudio3DStats