TextStudio3DPreparedGlyphImage
public sealed class TextStudio3DPreparedGlyphImage : ScriptableObjectPrepared exact shaped image and reusable solid. It stores owned pixels and canonical geometry and needs no shaping backend or font at playback.
Methods
Section titled “Methods”
TryPrepare(TextStudioGlyphImageSnapshot, in TextStudio3DImageTracePolicy, float, out string, CancellationToken)
Section titled “TryPrepare(TextStudioGlyphImageSnapshot, in TextStudio3DImageTracePolicy, float, out string, CancellationToken)”public bool TryPrepare(TextStudioGlyphImageSnapshot image, in TextStudio3DImageTracePolicy policy, float bodyDepth, out string diagnostic, CancellationToken cancellationToken = default)Explicit preparation only. Failure or cancellation leaves the previous asset payload intact; playback never calls the generator.
Parameters
| Name | Type |
|---|---|
image |
TextStudio.TextStudioGlyphImageSnapshot |
policy |
TextStudio.ThreeD.TextStudio3DImageTracePolicy |
bodyDepth |
System.Single |
diagnostic |
System.String |
cancellationToken |
System.Threading.CancellationToken |
Returns
System.Boolean
CaptureGlyphImage(in TextStudioGlyphImageRequest, out TextStudioGlyphImageSnapshot, out string)
Section titled “CaptureGlyphImage(in TextStudioGlyphImageRequest, out TextStudioGlyphImageSnapshot, out string)”public TextStudioGlyphImageStatus CaptureGlyphImage(in TextStudioGlyphImageRequest request, out TextStudioGlyphImageSnapshot snapshot, out string diagnostic)Returns the prepared glyph image only when its identity matches the exact image request.
Parameters
| Name | Type |
|---|---|
request |
TextStudio.TextStudioGlyphImageRequest |
snapshot |
TextStudio.TextStudioGlyphImageSnapshot |
diagnostic |
System.String |
Returns
TextStudio.TextStudioGlyphImageStatus
Constructors
Section titled “Constructors”
TextStudio3DPreparedGlyphImage()
Section titled “TextStudio3DPreparedGlyphImage()”public TextStudio3DPreparedGlyphImage()Properties
Section titled “Properties”
PreparationIdentity
Section titled “PreparationIdentity”public string PreparationIdentity { get; }Returns
System.String
DefaultAppearance
Section titled “DefaultAppearance”public TextStudio3DImageAppearance DefaultAppearance { get; }Returns
TextStudio.ThreeD.TextStudio3DImageAppearance
Diagnostic
Section titled “Diagnostic”public string Diagnostic { get; }Returns
System.String
IsPrepared
Section titled “IsPrepared”public bool IsPrepared { get; }Returns
System.Boolean
BaselineBounds
Section titled “BaselineBounds”public Rect BaselineBounds { get; }Returns
UnityEngine.Rect
ShapedAdvance
Section titled “ShapedAdvance”public Vector2 ShapedAdvance { get; }Returns
UnityEngine.Vector2
PreparedRequest
Section titled “PreparedRequest”public TextStudioGlyphImageRequest PreparedRequest { get; }Returns
TextStudio.TextStudioGlyphImageRequest
RetainedPayloadBytes
Section titled “RetainedPayloadBytes”public long RetainedPayloadBytes { get; }Returns
System.Int64