Kanzi  3.9.7
Kanzi Engine API
kanzi::SplashScreen Class Reference

Splash screen. More...

#include <kanzi/core.ui/application/splash.hpp>

Public Member Functions

void clear (Renderer &renderer)
 Clear remains, that might have been stayed from splash screen rendering. More...
 
bool isFinished () const
 Returns whether splash screen timeout has elapsed and splash screen could be removed. More...
 
void render (Renderer3D &renderer, const GraphicsOutput &graphicsOutput)
 Render. More...
 
 SplashScreen (Domain *domain, chrono::milliseconds timeout)
 Constructor. More...
 
void update (chrono::milliseconds deltaTime)
 Update. More...
 

Detailed Description

Splash screen.

Handles rendering a splash screen and reserving associated resources.

Constructor & Destructor Documentation

kanzi::SplashScreen::SplashScreen ( Domain domain,
chrono::milliseconds  timeout 
)
explicit

Constructor.

Creating a splash screen will implicitly reserve all resources.

Parameters
domainDomain.
timeoutSplash screen timer countdown.

Member Function Documentation

void kanzi::SplashScreen::update ( chrono::milliseconds  deltaTime)

Update.

Parameters
deltaTimeDuration since last call to update().
void kanzi::SplashScreen::render ( Renderer3D renderer,
const GraphicsOutput graphicsOutput 
)

Render.

Parameters
rendererRenderer to use.
graphicsOutputGraphics output to render to.
void kanzi::SplashScreen::clear ( Renderer renderer)

Clear remains, that might have been stayed from splash screen rendering.

Parameters
rendererRenderer to use.
bool kanzi::SplashScreen::isFinished ( ) const

Returns whether splash screen timeout has elapsed and splash screen could be removed.


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