Skip to content

ITextStudioEffectControl

InterfaceTextStudioTextStudio
public interface ITextStudioEffectControl

Focused renderer-neutral effect control shared by component and UI Toolkit hosts. External effects contribute after authored Reveal, Active, and Hide effects without owning playback or changing authored markup.

ApplyExternalEffect(ITextStudioEffectDefinition, float, float, int, int)

Section titled “ApplyExternalEffect(ITextStudioEffectDefinition, float, float, int, int)”
bool ApplyExternalEffect(ITextStudioEffectDefinition effect, float progress, float intensity = 1, int startGlyph = -1, int endGlyph = -1)

Adds one externally driven effect contribution for the next evaluation.

Parameters

Name Type
effect TextStudio.ITextStudioEffectDefinition
progress System.Single
intensity System.Single
startGlyph System.Int32
endGlyph System.Int32

Returns

System.Boolean

void RestartEffects()

Restarts effect-local clocks and state without changing reveal progress.

void RefreshEffectBindings()

Re-resolves authored and external effect definitions after their content changes.