Interface ISceneTransition

Namespace

Gloam.Core.Interfaces

Assembly

Gloam.Core.dll

Represents a transition between two scenes

public interface ISceneTransition

Properties

IsActive

Gets whether the transition is currently active

bool IsActive { get; }

Property Value

bool

IsComplete

Gets whether the transition has completed

bool IsComplete { get; }

Property Value

bool

SourceScene

Gets the source scene (the scene being transitioned from)

IScene? SourceScene { get; }

Property Value

IScene

TargetScene

Gets the target scene (the scene being transitioned to)

IScene TargetScene { get; }

Property Value

IScene

Transition

Gets the transition effect being used

ITransition? Transition { get; }

Property Value

ITransition

Methods

StartAsync(CancellationToken)

Starts the scene transition

ValueTask StartAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Cancellation token

Returns

ValueTask

UpdateAsync(TimeSpan, CancellationToken)

Updates the scene transition

ValueTask UpdateAsync(TimeSpan deltaTime, CancellationToken ct = default)

Parameters

deltaTime TimeSpan

Time elapsed since last update

ct CancellationToken

Cancellation token

Returns

ValueTask