hx3d::graphics::Transition Class Reference

Transition between two screens. More...

#include <transition.hpp>

Public Member Functions
	Transition (window::Game *game)
	Create a transition. More...
void	start ()
	Start the transition.
void	reset ()
	Reset the transition.
void	setDuration (float duration)
	Set the transition duration. More...
bool	isRunning () const
	Is the transition running. More...
bool	isFinished () const
	Is the transition finished. More...
void	update (float delta)
	Update the transition. More...
virtual void	render (Batch &batch, Framebuffer &currentFB, Framebuffer &nextFB)=0
	Render the transition. More...
virtual void	onUpdate (float delta)
	On transition update callback. More...
virtual void	onDone ()
	On transition done callback.
virtual void	onStart ()
	On transition start callback.

Protected Attributes
float	_duration
	Duration in seconds.
float	_currentTime
	Current time in seconds.
bool	_running
	Is the transition running.
window::Game *	_game
	Current game.

Detailed Description

Transition between two screens.

Definition at line 38 of file transition.hpp.

Constructor & Destructor Documentation

hx3d::graphics::Transition::Transition

(

window::Game *

game

)

Create a transition.

Parameters

game	Game (Raw ptr)

Definition at line 26 of file transition.cpp.

Member Function Documentation

bool hx3d::graphics::Transition::isFinished

(

)

const

Is the transition finished.

Returns

True/False

Definition at line 50 of file transition.cpp.

bool hx3d::graphics::Transition::isRunning

(

)

const

Is the transition running.

Returns

True/False

Definition at line 54 of file transition.cpp.

void hx3d::graphics::Transition::onUpdate ( float  delta )

virtual

On transition update callback.

Parameters

delta

Delta time

Reimplemented in hx3d::graphics::FadeTransition.

Definition at line 67 of file transition.cpp.

virtual void hx3d::graphics::Transition::render ( Batch &  batch, Framebuffer &  currentFB, Framebuffer &  nextFB  )

pure virtual

Render the transition.

Parameters

batch	Batch
currentFB	Current framebuffer
nextFB	Next framebuffer

Implemented in hx3d::graphics::FadeTransition.

void hx3d::graphics::Transition::setDuration

(

float

duration

)

Set the transition duration.

Parameters

duration

Duration in seconds

Definition at line 46 of file transition.cpp.

void hx3d::graphics::Transition::update

(

float

delta

)

Update the transition.

Parameters

delta

Delta time

Definition at line 58 of file transition.cpp.

---

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

• engine/include/hx3d/graphics/transition.hpp
• engine/src/graphics/transition.cpp