TextStudioExtensionRegistry

ClassTextStudioTextStudio

public sealed class TextStudioExtensionRegistry

Target-scoped registry for pose composition, exclusive transform authority, exact geometry, physical signals, and stateful preview. Registration may allocate; warmed frame composition does not.

Methods

TryRegisterFrameComposer(in TextStudioFrameTarget, ITextStudioFrameComposer, in TextStudioGlyphAuthorityRequest, out TextStudioFrameComposerRegistration, out TextStudioExtensionRegistrationFailure)

public bool TryRegisterFrameComposer(in TextStudioFrameTarget target, ITextStudioFrameComposer composer, in TextStudioGlyphAuthorityRequest authority, out TextStudioFrameComposerRegistration registration, out TextStudioExtensionRegistrationFailure failure)

Registers a frame composer and grants its requested glyph authority when available.

Parameters

Name	Type
target	TextStudio.TextStudioFrameTarget
composer	TextStudio.ITextStudioFrameComposer
authority	TextStudio.TextStudioGlyphAuthorityRequest
registration	TextStudio.TextStudioFrameComposerRegistration
failure	TextStudio.TextStudioExtensionRegistrationFailure

Returns

System.Boolean

UnregisterFrameComposer(TextStudioFrameComposerRegistration)

public bool UnregisterFrameComposer(TextStudioFrameComposerRegistration registration)

Removes a frame composer registration and releases its authority lease.

Parameters

Name	Type
registration	TextStudio.TextStudioFrameComposerRegistration

Returns

System.Boolean

IsFrameComposerRegistrationCurrent(TextStudioFrameComposerRegistration)

public bool IsFrameComposerRegistrationCurrent(TextStudioFrameComposerRegistration registration)

Reports whether a frame composer registration and its authority lease are still current.

Parameters

Name	Type
registration	TextStudio.TextStudioFrameComposerRegistration

Returns

System.Boolean

RegisterGeometryProvider(in TextStudioFrameTarget, ITextStudioGlyphGeometryProvider, int)

public TextStudioExtensionProviderRegistration RegisterGeometryProvider(in TextStudioFrameTarget target, ITextStudioGlyphGeometryProvider provider, int priority = 0)

Registers a prioritized glyph geometry provider for a target.

Parameters

Name	Type
target	TextStudio.TextStudioFrameTarget
provider	TextStudio.ITextStudioGlyphGeometryProvider
priority	System.Int32

Returns

TextStudio.TextStudioExtensionProviderRegistration

RegisterSignalProvider(in TextStudioFrameTarget, ITextStudioGlyphSignalProvider, int)

public TextStudioExtensionProviderRegistration RegisterSignalProvider(in TextStudioFrameTarget target, ITextStudioGlyphSignalProvider provider, int priority = 0)

Registers a prioritized glyph signal provider for a target.

Parameters

Name	Type
target	TextStudio.TextStudioFrameTarget
provider	TextStudio.ITextStudioGlyphSignalProvider
priority	System.Int32

Returns

TextStudio.TextStudioExtensionProviderRegistration

RegisterStatefulPreviewProvider(in TextStudioFrameTarget, ITextStudioStatefulPreviewProvider, int)

public TextStudioExtensionProviderRegistration RegisterStatefulPreviewProvider(in TextStudioFrameTarget target, ITextStudioStatefulPreviewProvider provider, int priority = 0)

Registers a prioritized stateful preview provider for a target.

Parameters

Name	Type
target	TextStudio.TextStudioFrameTarget
provider	TextStudio.ITextStudioStatefulPreviewProvider
priority	System.Int32

Returns

TextStudio.TextStudioExtensionProviderRegistration

UnregisterProvider(TextStudioExtensionProviderRegistration)

public bool UnregisterProvider(TextStudioExtensionProviderRegistration registration)

Removes a geometry, signal, or stateful preview provider registration.

Parameters

Name	Type
registration	TextStudio.TextStudioExtensionProviderRegistration

Returns

System.Boolean

TryWriteGlyphGeometry(in TextStudioGlyphGeometryRequest, TextStudioGlyphGeometryBuffer)

public bool TryWriteGlyphGeometry(in TextStudioGlyphGeometryRequest request, TextStudioGlyphGeometryBuffer destination)

Writes glyph geometry using the highest-priority available provider for the target.

Parameters

Name	Type
request	TextStudio.TextStudioGlyphGeometryRequest
destination	TextStudio.TextStudioGlyphGeometryBuffer

Returns

System.Boolean

TryGetGlyphSignals(in TextStudioFrameTarget, int, out TextStudioGlyphSignalState)

public bool TryGetGlyphSignals(in TextStudioFrameTarget target, int glyphIndex, out TextStudioGlyphSignalState signals)

Returns glyph signals from the highest-priority available provider for the target.

Parameters

Name	Type
target	TextStudio.TextStudioFrameTarget
glyphIndex	System.Int32
signals	TextStudio.TextStudioGlyphSignalState

Returns

System.Boolean

TryGetStatefulPreviewProvider(in TextStudioFrameTarget, out ITextStudioStatefulPreviewProvider)

public bool TryGetStatefulPreviewProvider(in TextStudioFrameTarget target, out ITextStudioStatefulPreviewProvider provider)

Returns the highest-priority available stateful preview provider for the target.

Parameters

Name	Type
target	TextStudio.TextStudioFrameTarget
provider	TextStudio.ITextStudioStatefulPreviewProvider

Returns

System.Boolean

Properties

HasActiveFrameComposers

public bool HasActiveFrameComposers { get; }

Returns

System.Boolean