Vkm::Engine::SplashSystem Class Reference

Shows the vendor logo, then the project's, over black at startup. More...

#include <splash_system.h>

Inheritance diagram for Vkm::Engine::SplashSystem:

Public Member Functions
void	update (FrameContext &ctx) override
	Execute this system for the current frame.
void	add (const std::string &path, float hold)
	Append path to the sequence.
void	setFade (float seconds)
	Set the fade at each end of every entry.
Public Member Functions inherited from Vkm::Engine::System
virtual bool	isReplayed () const
	Whether this system may be re-run over a tick that already happened.
virtual void	init (FrameContext &ctx)
	Called once after all systems are registered, before the first update.
virtual void	shutdown ()
	Called once on engine shutdown.
virtual void	fixedUpdate (FrameContext &ctx)
	Execute this system at the fixed simulation rate.

Detailed Description

Shows the vendor logo, then the project's, over black at startup.

Lives on the system rather than in a boot scene, so it survives a world swap. Steps on the frame clock, not the tick, so it keeps fading while paused. Runs once per process.

Member Function Documentation

update()

void Vkm::Engine::SplashSystem::update ( FrameContext & ctx )

overridevirtual

Execute this system for the current frame.

Parameters

ctx	This frame's services and the products published so far.

Reimplemented from Vkm::Engine::System.

add()

void Vkm::Engine::SplashSystem::add	(	const std::string &	path,
		float	hold )

Append path to the sequence.

A missing file is dropped with a log line rather than shown as a black pause.

Parameters

path	Image to show, as an absolute path.
hold	Seconds at full opacity, besides the two fades.

setFade()

void Vkm::Engine::SplashSystem::setFade ( float seconds )

inline

Set the fade at each end of every entry.

Parameters

seconds

Fade length, in and out; zero cuts.

---

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

• system/splash/splash_system.h