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
R
 radToDeg
 RandGen
 RangeException
 Rect
~Rect, Rect
 red, Color
 release, ResourceManaged
 remove
 removeFromSearchPath
 removeSink, Log
 removeSinks, Log
 render, State
 reset, Timer
 resize
 resizeRel
 resolveDeg, Vector2
 resolveRad, Vector2
 Resource Creation
 Resource Manager Access, ResourceManaged
 ResourceException
 ResourceManaged
~ResourceManaged, ResourceManaged
 ResourceManager
 rewind, Source
 run, Application
 Running, TaskManager
S
 scalar
 scalarCompare
 SCROLL_DOWN
 SCROLL_UP
 ScrollDir
 Search Path
 Searching
 seed, RandGen
 set, Vector2
 setAlpha, Image
 setColor
 setDepthBufferParams, Application
 setFixedUpdateStep, Application
 setFrameTimeSmoothing, Application
 setLooping, Source
 setOrthoProjection, Application
 setOrthoView, Application
 setPerspectiveProjection, Application
 setPerspectiveView, Application
 setState, Application
 setTitle, Application
 setVariable, ConfigFile
 setViewport, Application
 setWriteDir
 shared_ptr
 Singleton
 Sink Maintenance, Log
 Source
~Source, Source
 Source Control, Source
 Special Accessors, Vector2
 State
~State, State
 State Functions, State
 State Management, Application
 step, TaskManager
 STL/ Boost Types
 stop, Source
 Stream Access, Log
 stretch, Image
 StrVec
 System Directories
scalar radToDeg(scalar radians)
Convert radians to degrees.
Psuedorandom number generator class which uses Mersenne Twister.
RandGen()
Constructor for random generator, using time as seed.
RangeException should be thrown if something (such as an array bound) is out of bounds.
Defines geometric entity known as a rectangle.
Rect()
Initializes rectangle at (0,0) with size of 0.
virtual ~Rect()
Default destructor, exists to make Rect inheritance safe.
ubyte red
Red component of color.
virtual void release()
Removes a reference to the resource, releasing if needed.
bool remove(const std::string &item)
Attempts to remove a file or directory.
void removeFromSearchPath(const std::string &dir)
Removes a directory from the search path, if it exists on the path.
void removeSink(const std::string &sinkName)
Remove a sink from the log by name.
void removeSinks()
Remove all sinks from log.
virtual void render()=0
The only required member of State, anything that should be drawn to the screen while the State is active should be drawn in render.
void reset()
Reset timer to 0, will unpause timer if paused.
void resize(scalar radius)
Change the size of the Circle.
void resize(scalar width,
scalar height)
Resize the image to a specific size.
void resize(scalar width,
scalar height)
set new size for rectangle.
void resizeRel(scalar radiusChange)
Change the size of the Circle in relation to the current size.
void resizeRel(scalar widthDelta,
scalar heightDelta)
set new size for rectangle, relative to current size.
void resolveDeg(scalar magnitude,
scalar angle)
resolve vector, given a magnitude & angle in degrees.
void resolveRad(scalar magnitude,
scalar angle)
resolve vector, given a magnitude & angle in radians.
ResourceException should be thrown if there is a problem accessing a resource.
Base template class, to be used as a base from which classes which have resources that can be controlled, such as textures and music, can be derived.
ResourceManaged()
Default constructor.
virtual ~ResourceManaged()
Destructor, calls release.
Templated base class for managing resources like textures and music.
void rewind()
Rewinds the position of the sound attached to the source.
void run()
Runs application until a quit is requested either via the operating system (ex.
Scalar value, used throughout photon in place of double or float
bool scalarCompare(scalar val1,  
scalar val2,  
scalar epsilon = 0.000001)
Check for equality, using an epsilon.
Wheel was scrolled down.
Wheel was scrolled up.
Enumeration defining scroll direction of mouse wheel.
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.
Creates color, component by component.
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.
Shared pointer type.
Template class for singleton pattern.
Simple OO wrapper around an OpenAL source, defines the interface used for Sample and Music.
Source()
Default constructor, initalizes internal state of Source.
~Source()
Destructor for source, frees the OpenAL source resource.
Pure virtual State class, used as base class for Photon’s state system.
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.
Typedef for vector of strings, which is used all throughout photon.