Yagl Namespace Reference

Classes
struct	Channel
class	SfxDevice
class	SoundSource
class	SoundStream
class	BmpDecoder
struct	SourceInfo
class	Decoder
class	OggDecoder
class	PngDecoder
class	SampleDecoder
class	ScreenModeInfo
class	GfxDevice
class	GfxSurface
class	GlGfxGlyph
class	GlGfxFont
class	GlGfxSurface
struct	GlGfxKey
class	GlGfxKeyboard
class	GlGfxMouse
class	Joystick
class	Keyboard
class	Mouse
class	BiDirectionalConnection
class	BiDirectionalConnectionReceiver
class	ListeningConnection
class	Message
class	MessageReceiver
class	NetDevice
class	String
class	Mutex
class	Thread
class	Timer
Enumerations
enum	YAGL_GFX_CAPS
enum	GLGFXDEVICE_COMMAND
enum	THREAD_STATUS
Functions
void	setDriver (YAGL_DRIVER driver)
	sets the used gfx module and keyboard/mouse module driver
GfxDevice &	getGfxDevice ()
	returns the gfx device currently in use
NetDevice &	getNetDevice ()
	returns the net device currently in use
SfxDevice &	getSfxDevice ()
	returns the sfx device currently in use
Keyboard &	getKeyboard ()
	returns the keyboard currently in use
Mouse &	getMouse ()
	returns the mouse currently in use
Variables
GfxDevice &	current_gfx_device
	gfx device currently in use
NetDevice &	current_net_device
	net device currently in use
SfxDevice &	current_sfx_device
	sfx device currently in use
Keyboard &	current_keyboard
	current keyboard in use
Mouse &	current_mouse
	current mouse in use
YAGL_DRIVER	current_driver
	the driver currently used ( GFXLIB or GLFW )

---

Detailed Description

namespace Yagl

this namespace provides you with a couple of nice shortcut methods to retrieve references to the devices currently in use, query input device stati, and so on.

---

Enumeration Type Documentation

enum Yagl::GLGFXDEVICE_COMMAND

struct GlGfxDeviceCommand this structure represents a command issued with the GlGfxDevice. this structure can represent any of the drawing operations the GlGfxDevice offers. the GlGfxDevice has an array of 100000 of these commands that will get filled up during one frame. when swapBuffers is called all the elements within the array are drawn. this way the GlGfxDevice can optimize the executed glCommands a little bit by passing a couple of Commands to the hardware at once.

enum Yagl::THREAD_STATUS

enumeration of thread states NOT_STARTED denotes that the thread has not been started RUNNING denotes that the thread is currently running STOPPED denotes that the thread is currently stopping

enum Yagl::YAGL_GFX_CAPS

enum YAGL_SURFACE_CAPS this enum describes all methods a backend can chose to implement or not. it is used in conjunction with GfxSurface::isMethodImplemented() and GfxDevice::isMethodImplemented() so that the user can enumerate what capabilities a certain backend/driver has

---

Function Documentation

GfxDevice& Yagl::getGfxDevice (   )

returns the gfx device currently in use this method returns a reference to the GfxDevice currently in use. you should always use this method to obtain the reference to the device instead of using the GfxDevice::getInstance() method, as the backend could change and be selectable in the next release. Returns: a reference to the GfxDevice currently in use

Keyboard& Yagl::getKeyboard (   )

returns the keyboard currently in use this method returns a reference to the keyboard currently in use. you should always use this method to obtain the reference to the device instead of using the Keyboard::getInstance() method, as the backend could change and be selectable in the next release. Returns: a reference to the Keyboard currently in use

Mouse& Yagl::getMouse (   )

returns the mouse currently in use this method returns a reference to the mouse currently in use. you should always use this method to obtain the reference to the device instead of using the Mouse::getInstance() method, as the backend could change and be selectable in the next release. Returns: a reference to the Mouse currently in use

NetDevice& Yagl::getNetDevice (   )

returns the net device currently in use this method returns a reference to the NetDevice currently in use. you should always use this method to obtain the reference to the device instead of using the NetDevice::getInstance() method, as the backend could change and be selectable in the next release. Returns: a reference to the NetDevice currently in use

SfxDevice& Yagl::getSfxDevice (   )

returns the sfx device currently in use this method returns a reference to the SfxDevice currently in use you should always use this method to obtain the reference to the device instead of using the SfxDevice::getInstance() method, as the backend could change and be selectable in the next release. Returns: a reference to the SfxDevice currently in use

void Yagl::setDriver (  YAGL_DRIVER  driver  )

sets the used gfx module and keyboard/mouse module driver a call to this function will set the used driver for the gfx module and the keyboard and mouse module. currently two drivers are supported, one being the GFXLIB driver, that is a software 2d library that is pretty flexible, and the GLFW driver, that's an opengl GLFW based driver that's offering less functionality but a huge speed increase. as the keyboard and mouse are handled by the drivers there are different backends not only for GfxSource and GfxDevice but also for Keyboard and Mouse. Joysticks however are implemented with an own backend and driver independant. Parameters: driver  the driver to be used ( GFXLIB or GLFW )

---