BackgroundEffect Class Reference

Base class for background effects. More...

#include <Game/BackgroundEffect.h>

Inherited by MusicVisualizerEffect, and StarFieldEffect.

List of all members.

Public Member Functions
	BackgroundEffect (const Rectf &size)
	Constructor.
virtual	~BackgroundEffect ()
	Deconstructor.
const Rectf &	GetSize ()
	Gets the size of the effect.
virtual bool	Init ()=0
	Initializes the effect. Called once before Update and Draw are called.
virtual void	Update (float dt)=0
	Updates the effect. Called once per frame.
virtual void	Draw ()=0
	Draws the effect.

---

Detailed Description

Base class for background effects.

---

Constructor & Destructor Documentation

BackgroundEffect::BackgroundEffect

(

const Rectf &

size

)

[inline]

Constructor.

Parameters:

[in]

size

the that the effect will fill.

---

Member Function Documentation

const Rectf& BackgroundEffect::GetSize

(

)

[inline]

Gets the size of the effect.

Returns:

the rectangle that the effect exists in.

virtual bool BackgroundEffect::Init

(

)

[pure virtual]

Initializes the effect. Called once before Update and Draw are called.

Returns:

true if the initialization was successful, false otherwise.

Implemented in MusicVisualizerEffect, and StarFieldEffect.

virtual void BackgroundEffect::Update

(

float

dt

)

[pure virtual]

Updates the effect. Called once per frame.

Parameters:

[in]

dt

the time in seconds since the last frame.

Implemented in MusicVisualizerEffect, and StarFieldEffect.

---

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

• BackgroundEffect.h