---

ZE Namespace Reference

---

Detailed Description

Namespace for ZEngine classes and utility functions.

Compounds
class	ZClient
	ZEngine class for a simplified TCP client. More...
class	ZConfigFile
	ZConfigFile Class for use in ZEngine. More...
class	ZCF_Variable
	ZConfigFile Variable class. More...
class	ZCF_Section
	ZConfigFile Section class. More...
class	ZEngine
	Main ZEngine Singleton Class. More...
class	ZError
	ZError class for describing errors. More...
class	ZFont
	ZFont class for basic Font use. More...
class	ZImage
	ZImage class for basic Image use. More...
class	ZMusic
	ZMusic class for playing full length music (eg. ogg or wav). More...
class	ZRect
	ZEngine class for simplified rectangle use. More...
class	ZServer
	ZEngine class for simplified TCP server. More...
class	ZSound
	ZSound class for playing sound effects. (WAV). More...
class	ZTimer
	ZTimer class for Timer use. More...
Enumerations
enum	ZErrorCode {   ZERR_NONE, ZERR_SDL_INTERNAL, ZERR_SDL_INIT, ZERR_MIX_INIT,   ZERR_TTF_INIT, ZERR_NET_INIT, ZERR_VIDMODE, ZERR_LOAD_IMAGE,   ZERR_LOAD_SOUND, ZERR_LOAD_MUSIC, ZERR_LOAD_FONT, ZERR_NOIMAGE,   ZERR_NOSOUND, ZERR_NOMUSIC, ZERR_NOFONT, ZERR_NOSOCKET,   ZERR_NET_CLIENT, ZERR_NET_SERVER, ZERR_LAST }
	Enumeration of ZEngine error codes. More...
Functions
string	FormatStr (const char *fmtstr,...)
	Parses a string and interprets variable arguments, similar to sprintf.
void	FreeImage (SDL_Surface *&image)
	Properly free SDL_Surface.
void	FreeSound (Mix_Chunk *&chunk)
	Properly free Mix_Chunk.
void	FreeMusic (Mix_Music *&music)
	Properly free Mix_Music.
void	FreeFont (TTF_Font *&font)
	Properly free TTF_Font.

---

Enumeration Type Documentation

enum ZE::ZErrorCode

All the error codes currently possibly by ZEngine, note that ZERR_LAST is not used as an error code, but instead as a range check on the others. Enumeration values: ZERR_NONE  No error has occured. ZERR_SDL_INTERNAL  Error internal to SDL has occured, usually more detail is given by SDL. ZERR_SDL_INIT  Error Initializing SDL. ZERR_MIX_INIT  Error Initializing SDL_mixer. ZERR_TTF_INIT  Error Initializing SDL_ttf. ZERR_NET_INIT  Error Initializing SDL_net. ZERR_VIDMODE  Error setting up the display. ZERR_LOAD_IMAGE  Error loading an image. ZERR_LOAD_SOUND  Error loading a sound sample. ZERR_LOAD_MUSIC  Error loading music. ZERR_LOAD_FONT  Error loading a font. ZERR_NOIMAGE  Error trying to use a ZImage without properly loading an image. ZERR_NOSOUND  Error trying to use a ZSound without properly loading a sound. ZERR_NOMUSIC  Error trying to use a ZMusic without properly loading music. ZERR_NOFONT  Error trying to use a ZFont without properly loading a font. ZERR_NOSOCKET  Error trying to use a ZClient without having an open socket. ZERR_NET_CLIENT  Error using SDL_net in ZClient. ZERR_NET_SERVER  Error using SDL_net in ZClient. ZERR_LAST  Value used as range index, not a valid error code.

---

Function Documentation

string ZE::FormatStr (  const char *    fmtstr, ...    )

Takes identifiers out of fmtstr and parses them, replacing them with cooresponding values in the variable arguments list. For more detail view stdarg documentation. Parameters: fmtstr  defines format of resulting string ...  variable number of arguments after fmtstr Returns: string of parsed and combined string

void ZE::FreeImage (  SDL_Surface *&    image )

Safely free an SDL_Surface* and set it to NULL. Parameters: image  Image to free and set to NULL.

void FreeSound (  Mix_Chunk *&    chunk )

Safely free a Mix_Chunk* and set it to NULL. Parameters: chunk  Chunk to free and set to NULL.

void FreeMusic (  Mix_Music *&    music )

Safely free a Mix_Music* and set it to NULL. Parameters: music  Music to free and set to NULL.

void FreeFont (  TTF_Font *&    font )

Safely free a TTF_Font* and set it to NULL. Parameters: font  Font to free and set to NULL.

---