Index - Photon 0.0.2

Photon 0.0.2

Simple Open Source 2D Game API

Index

Everything

Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

T
	Task Global Task
~	Task, Task
	Task Management, TaskManager
	TaskManager Global TaskManager
~	TaskManager, TaskManager
	TaskPtr, Task
	TextSink
	Texture Global Texture
	Throwable Global Throwable
	throwOpenALError, AudioCore
	Timer Global Timer
~	Timer, Timer
	Timing, Application
U
	ubyte
	uint
	unpause, Timer
	unpauseTask, TaskManager
	update State Task
	Utility, Color
V
	Variables Color VersionInfo
	Vector2 Global Vector2
	verbose, Log
	VersionInfo Global VersionInfo
	VersionInfo Utilities
	Viewport/ Projection, Application
W
	warning, Log
	what, Throwable
	Window, Application
	writeMessage, LogSink
X
	x, Vector2
Y
	y, Vector2

Task( const std:: string & name,
PriorityLevel priority = PRI_NORMAL )

Constructor, every task needs a name and priority.

virtual ~Task()

Virtual destructor, exists simply to make inheritance safe.

TaskManager class, maintains a list of Tasks and manages their status, handles adding, deleting, pausing, and unpausing tasks.

TaskManager()

TaskManager constructor, initializes task manager

~TaskManager()

TaskManager destructor, destroys task manager

Pointer to a task, used since Task is abstract and will always be accessed via a pointer.

LogSink to be used with Log for simple text file output.

Simple OO wrapper around the concept of a texture in openGL.

Texture()

Default constructor, initalizes internal state of Texture.

Throwable is the base exception class for Photon.

Throwable( const std:: string & description = std::string(),
const std:: string & file = std::string(),
uint line = 0 ) throw()

Constructor for a Throwable object, can specify as little or as much information as you’d like when throwing.

static void throwOpenALError( const std:: string & func )

Checks for OpenAL internal errors, throwing an APIError if the OpenAL error state is set and doing nothing if not.

Class capable of keeping track of time.

Timer( bool appTimeLinked = true )

Initializes timer, timer is running starting at it’s creation.

virtual ~Timer()

Virtual destructor, does nothing, exists only to make Timer inheritance safe.

Unsigned byte, alias for unsigned char.

Alias for unsigned integer.

void unpause()

Unpause timer if paused.

void unpauseTask( const std:: string & taskName )

Unpause a task in the TaskManager task list.

virtual void update( scalar timeDelta )

All of a state’s logic should go in update, it is called every frame before the rendering process begins.

virtual void update( scalar timeDelta )=0

Pure virtual, every child task must overload it’s own update(), when a task is active this is called every ‘frame.’

Represents a two-dimensional vector.

Vector2()

Initializes zero length vector.

std::ostream& verbose()

Accesses stream, any messages passed into verbose are given to associated LogSinks with a LogLevel of LOG_VERBOSE.

Class which stores version information, such as release numbers.

VersionInfo()

Default constructor.

These functions are called by the above Ortho/Perspective functions, very rarely do they need to be called directly.

std::ostream& warning()

Accesses stream, any messages passed into warning are given to associated LogSinks with a LogLevel of LOG_WARNING.

std::string virtual what( ) const throw()

Similar to the std::exception family, all photon exceptions (the Throwable family) define what() that returns a description of the exception.

virtual void writeMessage( LogLevel level,
const std:: string & msg )=0

Pure virtual function which derived classes must define to write the message.

scalar x

x component of vector

scalar y

y component of vector