Skip to content

TextStudioEffectCompatibilityResolver

ClassTextStudioTextStudio
public static class TextStudioEffectCompatibilityResolver

Resolves supported render domains and actionable compatibility status for effect definitions.

GetSupportedDomains(ITextStudioEffectDefinition)

Section titled “GetSupportedDomains(ITextStudioEffectDefinition)”
public static TextStudioRenderDomain GetSupportedDomains(ITextStudioEffectDefinition definition)

Gets declared render domains, defaulting to all domains for definitions without capability metadata.

Parameters

Name Type
definition TextStudio.ITextStudioEffectDefinition

Returns

TextStudio.TextStudioRenderDomain

Resolve(ITextStudioEffectDefinition, TextStudioRenderDomain)

Section titled “Resolve(ITextStudioEffectDefinition, TextStudioRenderDomain)”
public static TextStudioEffectCompatibility Resolve(ITextStudioEffectDefinition definition, TextStudioRenderDomain requestedDomains)

Compares an effect’s declared domains with a requested renderer domain set.

Parameters

Name Type
definition TextStudio.ITextStudioEffectDefinition
requestedDomains TextStudio.TextStudioRenderDomain

Returns

TextStudio.TextStudioEffectCompatibility

BuildUnsupportedReason(TextStudioRenderDomain)

Section titled “BuildUnsupportedReason(TextStudioRenderDomain)”
public static string BuildUnsupportedReason(TextStudioRenderDomain supported)

Builds user-facing guidance for requested render domains outside the supported set.

Parameters

Name Type
supported TextStudio.TextStudioRenderDomain

Returns

System.String