OpenArena::Screen Class Reference

Write brief comment for Screen here. More...

#include <screen.h>

Inheritance diagram for OpenArena::Screen:

List of all members.

Public Member Functions
	Screen ()
	Write brief comment for Screen here.
int	GetWidth ()
	Write brief comment for GetWidth here.
int	GetHeight ()
	Write brief comment for GetHeight here.
int	GetColorDepth ()
	Write brief comment for GetColorDepth here.
bool	GetFullscreen ()
	Write brief comment for GetFullscreen here.
const char *	GetName ()
	Write brief comment for GetName here.
void	SetWidth (int)
	Write brief comment for SetWidth here.
void	SetHeight (int)
	Write brief comment for SetHeight here.
void	Resize (int, int)
	Write brief comment for Resize here.
void	SetColorDepth (int)
	Write brief comment for SetColorDepth here.
void	SetFullscreen (bool)
	Write brief comment for SetFullscreen here.
void	ToggleFullscreen ()
	Write brief comment for ToggleFullscreen here.
void	SetName (const char *)
	Write brief comment for SetName here.
void	SetName (string)
	Write brief comment for SetName here.
Protected Attributes
short	_width
short	_height
char	_colorDepth
bool	_fullscreen
string	_name

---

Detailed Description

Write brief comment for Screen here.

Write detailed description for Screen here.

Remarks:

Write remarks for Screen here.

See also:

Separate items with the '|' character.

---

Constructor & Destructor Documentation

OpenArena::Screen::Screen

(

)

Write brief comment for Screen here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Screen here.

Remarks:

Write remarks for Screen here.

See also:

Separate items with the '|' character.

---

Member Function Documentation

int OpenArena::Screen::GetColorDepth

(

)

Write brief comment for GetColorDepth here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetColorDepth here.

Remarks:

Write remarks for GetColorDepth here.

See also:

Separate items with the '|' character.

bool OpenArena::Screen::GetFullscreen

(

)

Write brief comment for GetFullscreen here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetFullscreen here.

Remarks:

Write remarks for GetFullscreen here.

See also:

Separate items with the '|' character.

int OpenArena::Screen::GetHeight

(

)

Write brief comment for GetHeight here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetHeight here.

Remarks:

Write remarks for GetHeight here.

See also:

Separate items with the '|' character.

const char * OpenArena::Screen::GetName

(

)

Write brief comment for GetName here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetName here.

Remarks:

Write remarks for GetName here.

See also:

Separate items with the '|' character.

int OpenArena::Screen::GetWidth

(

)

Write brief comment for GetWidth here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetWidth here.

Remarks:

Write remarks for GetWidth here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::Resize	(	int	,
		int
	)

Write brief comment for Resize here.

Parameters:

	Description	of parameter .
	Description	of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Resize here.

Remarks:

Write remarks for Resize here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::SetColorDepth

(

int

)

Write brief comment for SetColorDepth here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for SetColorDepth here.

Remarks:

Write remarks for SetColorDepth here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::SetFullscreen

(

bool

)

Write brief comment for SetFullscreen here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for SetFullscreen here.

Remarks:

Write remarks for SetFullscreen here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::SetHeight

(

int

)

Write brief comment for SetHeight here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for SetHeight here.

Remarks:

Write remarks for SetHeight here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::SetName

(

string

)

Write brief comment for SetName here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for SetName here.

Remarks:

Write remarks for SetName here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::SetName

(

const char *

)

Write brief comment for SetName here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for SetName here.

Remarks:

Write remarks for SetName here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::SetWidth

(

int

)

Write brief comment for SetWidth here.

Parameters:

Description

of parameter .

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for SetWidth here.

Remarks:

Write remarks for SetWidth here.

See also:

Separate items with the '|' character.

void OpenArena::Screen::ToggleFullscreen

(

)

Write brief comment for ToggleFullscreen here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for ToggleFullscreen here.

Remarks:

Write remarks for ToggleFullscreen here.

See also:

Separate items with the '|' character.

---

Member Data Documentation

char OpenArena::Screen::_colorDepth [protected]

bool OpenArena::Screen::_fullscreen [protected]

short OpenArena::Screen::_height [protected]

string OpenArena::Screen::_name [protected]

short OpenArena::Screen::_width [protected]

---

The documentation for this class was generated from the following files:

• src/screen.h
• src/screen.cpp

---