Level H Engine
Public Member Functions | Private Attributes | List of all members
Splash Class Reference

A State that contains and runs the splash screen. More...

#include <Splash.h>

Inheritance diagram for Splash:
Inheritance graph
Collaboration diagram for Splash:
Collaboration graph

Public Member Functions

 Splash (StateManager *stateManager, SDL_Window *window)
 Constructs the State object. More...
 
 ~Splash ()
 Destructs the State object. More...
 
bool input ()
 Handles the State input. More...
 
void update ()
 A function to update the State. More...
 
void draw ()
 A function to draw the State to the screen. More...
 
- Public Member Functions inherited from State
 State (StateManager *stateManager, SDL_Window *window, std::string name)
 Constructs a State object. More...
 
virtual ~State ()
 A virtual destructor for the State object. More...
 
SDL_Window * getWindow ()
 Gets the window. More...
 
std::string getName ()
 Gets the name of the state. More...
 
void destroyState ()
 A function to destroy all data in a state. More...
 

Private Attributes

TimersplashTimer
 The timer keeping the splash screen open. More...
 
std::string splashSprite
 The splash screen sprite. More...
 

Additional Inherited Members

- Protected Attributes inherited from State
StateManagerstateManager
 A pointer to the state manager. More...
 
SDL_Window * window
 The window to display to. More...
 
std::string name
 The state name. More...
 
bool destroyed
 A boolean for if the state is destroyed. More...
 

Detailed Description

A State that contains and runs the splash screen.

Constructor & Destructor Documentation

◆ Splash()

Splash::Splash ( StateManager stateManager,
SDL_Window *  window 
)

Constructs the State object.

Parameters
stateManagerA pointer to the StateManager.
windowA pointer to the window in use.
Here is the call graph for this function:

◆ ~Splash()

Splash::~Splash ( )

Destructs the State object.

Here is the call graph for this function:

Member Function Documentation

◆ draw()

void Splash::draw ( )
virtual

A function to draw the State to the screen.

Implements State.

Here is the call graph for this function:

◆ input()

bool Splash::input ( )
virtual

Handles the State input.

Returns
If false then quit the State.

Implements State.

Here is the call graph for this function:

◆ update()

void Splash::update ( )
virtual

A function to update the State.

Implements State.

Here is the call graph for this function:

Member Data Documentation

◆ splashSprite

std::string Splash::splashSprite
private

The splash screen sprite.

◆ splashTimer

Timer* Splash::splashTimer
private

The timer keeping the splash screen open.


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