splash_screen.h File Reference

Declares the splash screen workflow. More...

#include <functional>
#include <hal/video.h>
#include <SDL.h>

Include dependency graph for splash_screen.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	splash::show_splash_screen (SDL_Window *window, const VIDEO_MODE &videoMode, const std::function< bool()> &keepShowing)
	Show the splash screen until the supplied callback reports completion.
void	splash::show_splash_screen (SDL_Window *window, const VIDEO_MODE &videoMode, unsigned int durationMilliseconds=1500U)
	Show the splash screen for a fixed duration.

Detailed Description

Declares the splash screen workflow.

Function Documentation

show_splash_screen() [1/2]

void splash::show_splash_screen	(	SDL_Window *	window,
		const VIDEO_MODE &	videoMode,
		const std::function< bool()> &	keepShowing )

Show the splash screen until the supplied callback reports completion.

Parameters

window	SDL window used for splash rendering.
videoMode	Active video mode used to size the splash layout.
keepShowing	Callback that returns true while the splash screen should remain visible.

show_splash_screen() [2/2]

void splash::show_splash_screen	(	SDL_Window *	window,
		const VIDEO_MODE &	videoMode,
		unsigned int	durationMilliseconds = 1500U )

Show the splash screen for a fixed duration.

Parameters

window	SDL window used for splash rendering.
videoMode	Active video mode used to size the splash layout.
durationMilliseconds	Splash duration in milliseconds.