OpenArena Namespace Reference

Classes
struct	BITMAP_HEADER
struct	BITMAP_INFO
struct	BITMAP_QUAD
class	Camera
	Write brief comment for Camera here. More...
class	ControlScheme
	Write brief comment for ControlScheme here. More...
class	Triangle
	Write brief comment for Triangle here. More...
class	Image
	Write brief comment for Image here. More...
class	Level
class	listNode
	Write brief comment for listNode here. More...
class	list
	Write brief comment for list here. More...
class	Logger
	Write brief comment for Logger here. More...
class	Font
	Write brief comment for Font here. More...
class	Texture
	Write brief comment for Texture here. More...
class	NullVideoPlugin
	Write brief comment for NullVideoPlugin here. More...
class	Player
	Write brief comment for Player here. More...
class	Plugin
	Write brief comment for Plugin here. More...
class	PluginManager
	Write brief comment for PluginManager here. More...
class	Screen
	Write brief comment for Screen here. More...
struct	TGAHeader
	Write brief comment for TGAHeader here. More...
struct	TGA
	Write brief comment for TGA here. More...
class	Vec3d
	Write brief comment for Vec3d here. More...
class	Vec2f
	Write brief comment for Vec2f here. More...
class	Vec2i
	Write brief comment for Vec2i here. More...
class	VideoPlugin
	Write brief comment for VideoPlugin here. More...
class	Window
	Write brief comment for Window here. More...
class	WindowsLogger
	Write brief comment for WindowsLogger here. More...
Typedefs
typedef unsigned int	LIST_ARRAY_INDEX_TYPE
typedef Vec3d	Vec3f
Enumerations
enum	Keys {   KEY_UNKNOWN = 0, KEY_BUTTON0, KEY_BUTTON1, KEY_BUTTON2,   KEY_BUTTON3, KEY_BUTTON4, KEY_LEFT, KEY_RIGHT,   KEY_UP, KEY_DOWN, KEY_SPACE, KEY_RETURN,   KEY_SHIFT, KEY_PAUSE, KEY_CONTROL, KEY_CAPITAL,   KEY_ESCAPE, KEY_PRIOR, KEY_NEXT, KEY_END,   KEY_HOME, KEY_INSERT, KEY_DELETE, KEY_LWIN,   KEY_RWIN, KEY_APPS, KEY_NUMPAD0, KEY_NUMPAD1,   KEY_NUMPAD2, KEY_NUMPAD3, KEY_NUMPAD4, KEY_NUMPAD5,   KEY_NUMPAD6, KEY_NUMPAD7, KEY_NUMPAD8, KEY_NUMPAD9,   KEY_MULTIPLY, KEY_ADD, KEY_SUBTRACT, KEY_DIVIDE,   KEY_F1, KEY_F2, KEY_F3, KEY_F4,   KEY_F5, KEY_F6, KEY_F7, KEY_F8,   KEY_F9, KEY_F10, KEY_F11, KEY_F12,   KEY_NUMLOCK, KEY_SCROLL, KEY_SEPARATOR, KEY_OEM_1,   KEY_OEM_2, KEY_OEM_3, KEY_OEM_4, KEY_OEM_5,   KEY_OEM_6, KEY_OEM_7, KEY_OEM_PERIOD, KEY_OEM_PLUS,   KEY_OEM_MINUS, KEY_OEM_COMMA, KEY_BACK, KEY_TAB,   KEY_0, KEY_1, KEY_2, KEY_3,   KEY_4, KEY_5, KEY_6, KEY_7,   KEY_8, KEY_9, KEY_A, KEY_B,   KEY_C, KEY_D, KEY_E, KEY_F,   KEY_G, KEY_H, KEY_I, KEY_J,   KEY_K, KEY_L, KEY_M, KEY_N,   KEY_O, KEY_P, KEY_Q, KEY_R,   KEY_S, KEY_T, KEY_U, KEY_V,   KEY_W, KEY_X, KEY_Y, KEY_Z }
	Write brief comment for Keys here. More...
enum	{ GL_MY_TEXTURE_CONSOLEBACKGROUND = 0, NUM_MENU_TEXTURES }
	Write brief comment for GL_MY_TEXTURE_CONSOLEBACKGROUND here. More...
Functions
void	PrintBMPHeader (BITMAP_HEADER header)
void	PrintBMPInfo (BITMAP_INFO info)
TextureImage *	LoadBMP (const char *Filename)
	Write brief comment for LoadBMP here.
char	KeyToASCII (Keys key, bool shift)
	Write brief comment for KeyToASCII here.
void	FreeGLTexture (GLuint &)
	Write brief comment for FreeGLTexture here.
bool	LoadGLTexture (string, GLuint &, GLuint=GL_LINEAR, GLuint=GL_LINEAR)
	Write brief comment for LoadGLTexture here.
TextureImage *	LoadTGA (const char *filename)
	Write brief comment for LoadTGA here.
TextureImage *	LoadUncompressedTGA (FILE *fTGA)
TextureImage *	LoadCompressedTGA (FILE *fTGA)
Vec3d	Vector (double, double)
	Write brief comment for Vector here.
Variables
const Keys	KEY_LBUTTON = KEY_BUTTON0
	Write brief comment for KEY_LBUTTON here.
const Keys	KEY_RBUTTON = KEY_BUTTON1
	Write brief comment for KEY_RBUTTON here.
const Keys	KEY_MBUTTON = KEY_BUTTON2
	Write brief comment for KEY_MBUTTON here.
const float	piover180 = 0.0174532925f
	Write brief comment for piover180 here.
const string	DEFAULT_TEXTURE_NAME = "oa/textures/default.bmp"
	Write brief comment for DEFAULT_TEXTURE_NAME here.
const unsigned int	MAX_CONSOLE_LINES = 30
	Write brief comment for MAX_CONSOLE_LINES here.
const unsigned int	MAX_CONSOLE_HISTORY_LINES = MAX_CONSOLE_LINES + 20
	Write brief comment for MAX_CONSOLE_HISTORY_LINES here.
const unsigned int	MAX_CONSOLE_OUTPUT_LINES = MAX_CONSOLE_LINES
	Write brief comment for MAX_CONSOLE_OUTPUT_LINES here.
const unsigned int	MAX_OUTPUT_TEXT_LINES = 4
	Write brief comment for MAX_OUTPUT_TEXT_LINES here.
const GLubyte	uTGAcompare [12] = {0,0,2, 0,0,0,0,0,0,0,0,0}
const GLubyte	cTGAcompare [12] = {0,0,10,0,0,0,0,0,0,0,0,0}

---

Detailed Description

<File comment goes here!!>

Copyright (c) 2005 by <your name/ organization here>

---

Typedef Documentation

typedef unsigned int OpenArena::LIST_ARRAY_INDEX_TYPE

typedef Vec3d OpenArena::Vec3f

---

Enumeration Type Documentation

enum OpenArena::Keys

Write brief comment for Keys here.

Write detailed description for Keys here.

Remarks:

Write remarks for Keys here.

See also:

Separate items with the '|' character.

Enumerator:

KEY_UNKNOWN
KEY_BUTTON0
KEY_BUTTON1
KEY_BUTTON2
KEY_BUTTON3
KEY_BUTTON4
KEY_LEFT
KEY_RIGHT
KEY_UP
KEY_DOWN
KEY_SPACE
KEY_RETURN
KEY_SHIFT
KEY_PAUSE
KEY_CONTROL
KEY_CAPITAL
KEY_ESCAPE
KEY_PRIOR
KEY_NEXT
KEY_END
KEY_HOME
KEY_INSERT
KEY_DELETE
KEY_LWIN
KEY_RWIN
KEY_APPS
KEY_NUMPAD0
KEY_NUMPAD1
KEY_NUMPAD2
KEY_NUMPAD3
KEY_NUMPAD4
KEY_NUMPAD5
KEY_NUMPAD6
KEY_NUMPAD7
KEY_NUMPAD8
KEY_NUMPAD9
KEY_MULTIPLY
KEY_ADD
KEY_SUBTRACT
KEY_DIVIDE
KEY_F1
KEY_F2
KEY_F3
KEY_F4
KEY_F5
KEY_F6
KEY_F7
KEY_F8
KEY_F9
KEY_F10
KEY_F11
KEY_F12
KEY_NUMLOCK
KEY_SCROLL
KEY_SEPARATOR
KEY_OEM_1
KEY_OEM_2
KEY_OEM_3
KEY_OEM_4
KEY_OEM_5
KEY_OEM_6
KEY_OEM_7
KEY_OEM_PERIOD
KEY_OEM_PLUS
KEY_OEM_MINUS
KEY_OEM_COMMA
KEY_BACK
KEY_TAB
KEY_0
KEY_1
KEY_2
KEY_3
KEY_4
KEY_5
KEY_6
KEY_7
KEY_8
KEY_9
KEY_A
KEY_B
KEY_C
KEY_D
KEY_E
KEY_F
KEY_G
KEY_H
KEY_I
KEY_J
KEY_K
KEY_L
KEY_M
KEY_N
KEY_O
KEY_P
KEY_Q
KEY_R
KEY_S
KEY_T
KEY_U
KEY_V
KEY_W
KEY_X
KEY_Y
KEY_Z

anonymous enum

Write brief comment for GL_MY_TEXTURE_CONSOLEBACKGROUND here.

Enumerator:

GL_MY_TEXTURE_CONSOLEBACKGROUND
NUM_MENU_TEXTURES

---

Function Documentation

void OpenArena::PrintBMPHeader

(

BITMAP_HEADER

header

)

void OpenArena::PrintBMPInfo

(

BITMAP_INFO

info

)

TextureImage * OpenArena::LoadBMP

(

const char *

Filename

)

Write brief comment for LoadBMP here.

Parameters:

Filename

Description of parameter Filename.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for LoadBMP here.

Remarks:

Write remarks for LoadBMP here.

See also:

Separate items with the '|' character.

char OpenArena::KeyToASCII	(	Keys	key,
		bool	shift
	)

Write brief comment for KeyToASCII here.

Parameters:

	key	Description of parameter key.
	shift	Description of parameter shift.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for KeyToASCII here.

Remarks:

Write remarks for KeyToASCII here.

See also:

Separate items with the '|' character.

void OpenArena::FreeGLTexture

(

GLuint &

)

Write brief comment for FreeGLTexture here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for FreeGLTexture here.

Remarks:

Write remarks for FreeGLTexture here.

See also:

Separate items with the '|' character.

bool OpenArena::LoadGLTexture	(	string	,
		GLuint &	,
		GLuint	= GL_LINEAR,
		GLuint	= GL_LINEAR
	)

Write brief comment for LoadGLTexture here.

Parameters:

	Description	of parameter .
	Description	of parameter .
	Description	of parameter .
	Description	of parameter .

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for LoadGLTexture here.

Remarks:

Write remarks for LoadGLTexture here.

See also:

Separate items with the '|' character.

TextureImage * OpenArena::LoadTGA

(

const char *

filename

)

Write brief comment for LoadTGA here.

Parameters:

filename

Description of parameter filename.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for LoadTGA here.

Remarks:

Write remarks for LoadTGA here.

See also:

Separate items with the '|' character.

TextureImage * OpenArena::LoadUncompressedTGA

(

FILE *

fTGA

)

TextureImage * OpenArena::LoadCompressedTGA

(

FILE *

fTGA

)

Vec3d OpenArena::Vector	(	double	,
		double
	)

Write brief comment for Vector here.

Parameters:

	Description	of parameter .
	Description	of parameter .

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Vector here.

Remarks:

Write remarks for Vector here.

See also:

Separate items with the '|' character.

---

Variable Documentation

const Keys OpenArena::KEY_LBUTTON = KEY_BUTTON0

Write brief comment for KEY_LBUTTON here.

Write detailed description for KEY_LBUTTON here.

Remarks:

Write remarks for KEY_LBUTTON here.

See also:

Separate items with the '|' character.

const Keys OpenArena::KEY_RBUTTON = KEY_BUTTON1

Write brief comment for KEY_RBUTTON here.

Write detailed description for KEY_RBUTTON here.

Remarks:

Write remarks for KEY_RBUTTON here.

See also:

Separate items with the '|' character.

const Keys OpenArena::KEY_MBUTTON = KEY_BUTTON2

Write brief comment for KEY_MBUTTON here.

Write detailed description for KEY_MBUTTON here.

Remarks:

Write remarks for KEY_MBUTTON here.

See also:

Separate items with the '|' character.

const float OpenArena::piover180 = 0.0174532925f

Write brief comment for piover180 here.

Write detailed description for piover180 here.

Remarks:

Write remarks for piover180 here.

See also:

Separate items with the '|' character.

const string OpenArena::DEFAULT_TEXTURE_NAME = "oa/textures/default.bmp"

Write brief comment for DEFAULT_TEXTURE_NAME here.

Write detailed description for DEFAULT_TEXTURE_NAME here.

Remarks:

Write remarks for DEFAULT_TEXTURE_NAME here.

See also:

Separate items with the '|' character.

const unsigned int OpenArena::MAX_CONSOLE_LINES = 30

Write brief comment for MAX_CONSOLE_LINES here.

Write detailed description for MAX_CONSOLE_LINES here.

Remarks:

Write remarks for MAX_CONSOLE_LINES here.

See also:

Separate items with the '|' character.

const unsigned int OpenArena::MAX_CONSOLE_HISTORY_LINES = MAX_CONSOLE_LINES + 20

Write brief comment for MAX_CONSOLE_HISTORY_LINES here.

Write detailed description for MAX_CONSOLE_HISTORY_LINES here.

Remarks:

Write remarks for MAX_CONSOLE_HISTORY_LINES here.

See also:

Separate items with the '|' character.

const unsigned int OpenArena::MAX_CONSOLE_OUTPUT_LINES = MAX_CONSOLE_LINES

Write brief comment for MAX_CONSOLE_OUTPUT_LINES here.

Write detailed description for MAX_CONSOLE_OUTPUT_LINES here.

Remarks:

Write remarks for MAX_CONSOLE_OUTPUT_LINES here.

See also:

Separate items with the '|' character.

const unsigned int OpenArena::MAX_OUTPUT_TEXT_LINES = 4

Write brief comment for MAX_OUTPUT_TEXT_LINES here.

Write detailed description for MAX_OUTPUT_TEXT_LINES here.

Remarks:

Write remarks for MAX_OUTPUT_TEXT_LINES here.

See also:

Separate items with the '|' character.

const GLubyte OpenArena::uTGAcompare[12] = {0,0,2, 0,0,0,0,0,0,0,0,0}

const GLubyte OpenArena::cTGAcompare[12] = {0,0,10,0,0,0,0,0,0,0,0,0}

---