Kanda Graphics 0.6.0
Loading...
Searching...
No Matches
FadeService Class Reference

More...

+ Inheritance diagram for FadeService:

Public Member Functions

 FadeService (int pollingRateMs=100, Func< IFadeManager > fadeManagerResolver=null)
 Creates a fade service.
 
async Task Perform (FadeDirection direction)
 Performs a fade from the current alpha in the target direction. Task completes when fade is complete.
 
bool IsComplete ()
 Returns true if the most recent fade has completed.
 

Detailed Description

Constructor & Destructor Documentation

◆ FadeService()

FadeService ( int pollingRateMs = 100,
Func< IFadeManager > fadeManagerResolver = null )
inline

Creates a fade service.

Parameters
pollingRateMsThe interval to check if a fade is completed while its being performed.
fadeManagerResolverA function to get the fade manager at runtime. Defaults to using FindObjectOfType in the scene.

Member Function Documentation

◆ IsComplete()

bool IsComplete ( )
inline

Returns true if the most recent fade has completed.

Implements IFadeService.

◆ Perform()

async Task Perform ( FadeDirection direction)
inline

Performs a fade from the current alpha in the target direction. Task completes when fade is complete.

Implements IFadeService.


The documentation for this class was generated from the following file: