bool scalarCompare( scalar  val1,    scalar  val2,    scalar  epsilon  =  0.000001 )

Check for equality, using an epsilon.

void seed( unsigned  long  seedVal )

Reseed random generator, a given seed will always turn out same string of random numbers.

void set( scalar  nx, scalar  ny )

Initialize vector given an x and y component.

void setAlpha( ubyte  alpha )

Sets alpha-component for Image to be used when surface is drawn.

void setColor( const  Color  & color )

Set draw color of the font.

void setColor( ubyte  r,    ubyte  g,    ubyte  b,    ubyte  a  =  255 )

Sets color to use for drawing.

void setDepthBufferParams( bool  enable,    scalar  depth  =  1 )

Toggle depth testing and clearing of depth buffer.

void setFixedUpdateStep( bool  enable,    scalar  fixedStep,    scalar  maxStep  =  )

Sets a fixed timestep to be used in calls to the current State’s update method.

void setFrameTimeSmoothing( int  numFrames )

Sets number of frames used to smooth the timeDelta so that minor jitters in frramerate do not cause severe stuttering.

void setLooping( bool  loop )

Sets if the source’s sound is looping or is played only once.

void setOrthoProjection( scalar  width, scalar  height )

Sets an orthographic projection matrix.

void setOrthoView( int  x, int  y, int  viewWidth, int  viewHeight, scalar  orthoWidth, scalar  orthoHeight )

Sets new ortho viewport within a rectangular portion of the screen.

void setPerspectiveProjection( scalar  fovy, scalar  zNear, scalar  zFar )

Sets a perspective projection matrix.

void setPerspectiveView( int  x, int  y, int  width, int  height, scalar  fovy, scalar  zNear, scalar  zFar )

Creates a viewport with a given 3D perspective inside of a rectangular portion of the screen.

template<class StateT> void setState()

Set the current Application State, removing all other States.

void setTitle( const std:: string  & title )

Sets title of application that shows up in title bar.

template<class varType> void setVariable( const std:: string  & sec, const std:: string  & var, varType  value )

Template function for setting variables in the config file.

void setViewport( int  x, int  y, int  width, int  height )

Set the current viewport rectangle within the screen.

void setWriteDir( const std:: string  & dir )

Sets the writing directory, used by mkdir and remove.

Source()

Default constructor, initalizes internal state of Source.

~Source()

Destructor for source, frees the OpenAL source resource.

State()

A State’s constructor is called whenever the state is made active via Application::setState.

virtual ~State()

A State’s destructor is called whenever the state is no longer the active state (the application ends, or a new state is made active).

void step( scalar  timeDelta )

Steps the task manager, calling each active task once.

void stop()

Stops the playback of the sound attached to the source.

void stretch( scalar  xFactor, scalar  yFactor )

Stretch image by a given factor.

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()

TaskManager constructor, initializes task manager

~TaskManager()

TaskManager destructor, destroys task manager

Texture()

Default constructor, initalizes internal state of Texture.

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.

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.

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.’

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.

VersionInfo()

Default constructor.

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.