Function 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
G
 genRand, RandGen
 genRand01, RandGen
 genRandSign, RandGen
 getAlpha, Image
 getAngleDeg, Vector2
 getAngleRad, Vector2
 getAudioCore, Application
 getAudioDeviceName, AudioCore
 getBaseDir
 getBottom, Rect
 getBottomLeft, Rect
 getBottomRight, Rect
 getCDDirs
 getCenter, Circle
 getColor, Font
 getData, FileBuffer
 getDesc, Throwable
 getDirSeparator
 getDisplayHeight, Application
 getDisplayWidth, Application
 getElapsedTime, Application
 getFramerate, Application
 getHeight
 getInstance, Singleton
 getLeft, Rect
 getMagnitude, Vector2
 getModTime
 getMouseWheelPos, Application
 getMouseX, Application
 getMouseY, Application
 getName
 getPosition, FileBuffer
 getPressedKeys, Application
 getPriority, Task
 getRadius, Circle
 getRenderTaskManager, Application
 getRight, Rect
 getSearchPath
 getSize, FileBuffer
 getTime
 getTop, Rect
 getTopLeft, Rect
 getTopRight, Rect
 getUpdateTaskManager, Application
 getUserDir
 getVariable, ConfigFile
 getWidth
 getWriteDir
 getX, Rect
 getY, Rect
I
 Image, Image
 initAudioCore, Application
 initialize, Singleton
 intersects
 isActive, Application
 isAlive, Task
 isDir
 isEOF, FileBuffer
 isLooping, Source
 isOpen, FileBuffer
 isPaused
 isPlaying, Source
 isSymbolicLink
 isValid
K
 keyPressed, Application
 kill, Task
 killAllTasks, TaskManager
 killTask, TaskManager
L
 listDir
 Log, Log
~Log, Log
 LogSink, LogSink
~LogSink, LogSink
unsigned long genRand(unsigned long max)
Obtain random number in range [0,max).
double genRand01()
Obtain random double in range [0,1).
double genRandSign()
Obtain random sign, positive or negative.
ubyte getAlpha() const
Get current surface-wide alpha value for image.
scalar getAngleDeg() const
Angle of vector in degrees, angle is calculated with respect to positive X axis.
scalar getAngleRad() const
Angle of vector in radians, angle is calculated with respect to positive X axis.
audio::AudioCore& getAudioCore()
Get the Application’s AudioCore, should only be called after initAudioCore.
std::string getAudioDeviceName() const
Get name of active audio device.
std::string getBaseDir()
Get the path to the directory that the application is running in.
scalar getBottom() const
Get y coord of bottom side of rectangle.
Point2 getBottomLeft() const
Get bottom left corner of rectangle.
Point2 getBottomRight() const
Get bottom right corner of rectangle.
std::vector<std::string> getCDDirs()
Gets a listing of the CD directories on a system (not supported on all systems)
Point2 getCenter() const
Get center Point2.
Color getColor() const
Get draw color of the font.
std::vector<ubyte> getData(int amount = )
Loads an amount of data, returns a pointer to the loaded data.
std::string virtual getDesc() const throw()
Get just the description portion of an exception, used for chaining exceptions.
std::string getDirSeparator()
Gets the system standard directory separator.
uint getDisplayHeight()
Get the height of the display.
uint getDisplayWidth()
Get the width of the display.
double getElapsedTime()
Finds the amount of time passed between frames, or average of a number of frames if setFrameTimeSmoothing has been called.
double getFramerate()
Gets number of frames per second the application is currently processing subject to smoothing by setFrameTimeSmoothing.
scalar getHeight() const
Get height of rectangle.
scalar getHeight() const
Gets height of texture.
static T& getInstance()
Get a reference to the instance of the derived class.
scalar getLeft() const
Get x coord of left side of rectangle.
scalar getMagnitude() const
Get length of vector.
PHYSFS_sint64 getModTime(const std::string &item)
Gets last modification time for a file.
int getMouseWheelPos()
Gets current location of mouse wheel, treated as if wheel describes a third axis of movement for the mouse.
int getMouseX()
Gets current x location of mouse with respect to screen coordinates.
int getMouseY()
Gets current y location of mouse with respect to screen coordinates.
std::string getName() const
Gets name of the sink.
std::string getName() const
Get the name associated with the resource.
std::string getName() const
Get the name of the task.
uint getPosition() const
Gets position of internal cursor inside data.
std::vector<KeyCode> getPressedKeys()
Obtain a list of all keys which are currently pressed.
uint getPriority() const
Get the priority of the task.
scalar getRadius() const
Get radius of Circle.
util::TaskManager& getRenderTaskManager()
Access the application’s render TaskManager, Tasks registered with this TaskManager are executed after the current State::render.
scalar getRight() const
Get x coord of right side of rectangle.
std::vector<std::string> getSearchPath()
Obtain the currently configured search path.
uint getSize() const
Gets size of data.
scalar getTime()
Get time, in seconds, that application has been running.
double getTime() const
Get time in seconds.
scalar getTop() const
Get y coord of top side of rectangle.
Point2 getTopLeft() const
Get top left corner of rectangle.
Point2 getTopRight() const
Get top right corner of rectangle.
util::TaskManager& getUpdateTaskManager()
Access the application’s update TaskManager, Tasks registered with this TaskManager are executed after the current State::update.
std::string getUserDir()
Get the path to the directory that the OS specifies for the user’s home.
template<class varType> varType getVariable(const std::string &sec,
const std::string &var,
varType defVal) const
Template function for getting values from the config file.
scalar getWidth() const
Get width of rectangle.
scalar getWidth() const
Gets width of texture.
std::string getWriteDir()
Gets the writing directory.
scalar getX() const
Get x coord of rectangle.
scalar getY() const
Get y coord of rectangle.
Image()
Default constructor, initalizes internal state of Image.
void initAudioCore(const std::string &deviceName = "")
Initialize the AudioCore, should be done before attempting to access it via getAudioCore.
static void initialize()
Initialize the instance of the singleton, can be done explicitly if order of construction matters.
bool intersects(const Circle &circle) const
Check if circle intersects another.
bool intersects(const Rect &rect) const
Check for intersection between two Rects.
bool isActive()
Checks if application is active, which on most systems simply means it has focus.
bool isAlive() const
Check if task is alive or not.
bool isDir(const std::string &item)
Checks if a name refers to a directory.
bool isEOF() const
Checks if internal cursor is at end of file.
bool isLooping() const
Determine if source is looping.
bool isOpen() const
Checks if file is open.
bool isPaused() const
Check if task is paused or not.
bool isPaused() const
Check paused/unpaused status of timer.
bool isPlaying() const
Determine if source is playing.
bool isSymbolicLink(const std::string &item)
Checks if a name refers to a symbolic link.
bool isValid() const
Determine status of Font.
bool isValid() const
Determine status of Source.
bool keyPressed(KeyCode key)
Check if a given key is currently pressed.
void kill()
Sets state of task to dead, dead tasks remove themselves from the TaskManager’s task pool.
void killAllTasks()
Kills all tasks.
void killTask(const std::string &taskName)
Kill a task in the TaskManager task list.
std::vector<std::string> listDir(const std::string &dir)
Lists the contents of a directory.
Log()
Log constructor, initializes log singleton.
~Log()
Log destructor, destroys log singleton.
LogSink(const std::string &name)
LogSink constructor, requires a name.
virtual ~LogSink()
Virtual destructor, available to make inheritance safe.