ITextStudioPreviewStageProvider

InterfaceTextStudioTextStudio

public interface ITextStudioPreviewStageProvider

Optional renderer extension for the shared Text Studio preview lifecycle. The base owns mode/view/quality selection and playback; renderers configure only their representative stage and report renderer-specific diagnostics.

Methods

ConfigurePreviewStage(in TextStudioPreviewStageSettings)

void ConfigurePreviewStage(in TextStudioPreviewStageSettings settings)

Applies renderer-specific stage configuration without taking ownership of playback.

Parameters

Name	Type
settings	TextStudio.TextStudioPreviewStageSettings

ResetPreviewStage()

void ResetPreviewStage()

Restores stage state changed by preview configuration.

TryGetPreviewCameraPose(in TextStudioPreviewStageSettings, out TextStudioPreviewCameraPose)

bool TryGetPreviewCameraPose(in TextStudioPreviewStageSettings settings, out TextStudioPreviewCameraPose pose)

Tries to supply renderer-appropriate camera framing for the requested preview.

Parameters

Name	Type
settings	TextStudio.TextStudioPreviewStageSettings
pose	TextStudio.TextStudioPreviewCameraPose

Returns

System.Boolean

CollectPreviewDiagnostics(List)

void CollectPreviewDiagnostics(List<TextStudioPreviewDiagnostic> diagnostics)

Appends current renderer warnings and readiness information to the supplied list.

Parameters

Name	Type
diagnostics	System.Collections.Generic.List{TextStudio.TextStudioPreviewDiagnostic}

Properties

PreviewStageId

string PreviewStageId { get; }

Gets the stable provider identifier persisted by preview selection.

Returns

System.String

PreviewStageName

string PreviewStageName { get; }

Gets the user-facing renderer preview name.

Returns

System.String

IsPreviewStageAvailable

bool IsPreviewStageAvailable { get; }

Gets whether the renderer can currently construct its preview stage.

Returns

System.Boolean

PreviewStageCapabilities

TextStudioPreviewStageCapabilities PreviewStageCapabilities { get; }

Gets the views, quality modes, and diagnostics supported by the provider.

Returns

TextStudio.TextStudioPreviewStageCapabilities