Sky Zone Omega - PC Version
 All Classes Namespaces Files Functions Variables Macros
Public Member Functions | Private Attributes | List of all members
S_Splash Class Reference

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

#include <S_Splash.h>

Inheritance diagram for S_Splash:
Inheritance graph
Collaboration diagram for S_Splash:
Collaboration graph

Public Member Functions

 S_Splash (S_StateManager *stateManager, SDL_Renderer *renderer, C_Vec2 dimensions, C_Music *backgroundMusic)
 Constructs the State object. More...
 
 ~S_Splash ()
 Destructs the State object. More...
 
bool input ()
 Handles the State input. More...
 
void update (float dt)
 A function to update the State. More...
 
void draw ()
 A function to draw the State to the screen. More...
 
- Public Member Functions inherited from S_State
 S_State (S_StateManager *stateManager, SDL_Renderer *renderer, C_Vec2 dimensions)
 Constructs the State object. More...
 
virtual ~S_State ()
 A virtual destructor for the State object. More...
 

Private Attributes

C_MusicbackgroundMusic
 The background music. More...
 
float * universalSpeed
 A pointer for the universal speed of the menu. More...
 
C_Texturesplash
 The splash image. More...
 
C_TimersplashTimer
 The timer keeping the splash screen open. More...
 

Additional Inherited Members

- Protected Attributes inherited from S_State
S_StateManagerstateManager
 A pointer to the state manager. More...
 
SDL_Renderer * renderer
 A pointer to the renderer. More...
 
C_Vec2 dimensions
 The screen dimensions. More...
 

Detailed Description

A State that contains and runs the splash screen.

Author
Jamie Slowgrove

Constructor & Destructor Documentation

S_Splash::S_Splash ( S_StateManager stateManager,
SDL_Renderer *  renderer,
C_Vec2  dimensions,
C_Music backgroundMusic 
)

Constructs the State object.

Parameters
stateManagerA pointer to the StateManager.
rendererA pointer to the renderer.
dimensionsThe screen dimensions.
backgroundMusicThe background music of the State.
S_Splash::~S_Splash ( )

Destructs the State object.

Member Function Documentation

void S_Splash::draw ( )
virtual

A function to draw the State to the screen.

Implements S_State.

Here is the call graph for this function:

bool S_Splash::input ( )
virtual

Handles the State input.

Returns
If false then quit the State.

Implements S_State.

void S_Splash::update ( float  dt)
virtual

A function to update the State.

Parameters
dtThe delta time.

Implements S_State.

Here is the call graph for this function:

Member Data Documentation

C_Music* S_Splash::backgroundMusic
private

The background music.

C_Texture* S_Splash::splash
private

The splash image.

C_Timer* S_Splash::splashTimer
private

The timer keeping the splash screen open.

float* S_Splash::universalSpeed
private

A pointer for the universal speed of the menu.


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