maj/OpenArena
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added Doxygen comment stubs

Browse Source
This commit is contained in:
Tom Hicks
2006-07-04 02:41:31 -04:00
parent 8fb1a468ac
commit dc565ce1dc
28 changed files with 4500 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
src/Logger.h
View File

@@ -2,12 +2,88 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Logger here.
*
* Write detailed description for Logger here.
*
* \remarks
* Write remarks for Logger here.
*
* \see
* Separate items with the '|' character.
*/
class Logger
{
public:
/*!
* \brief
* Write brief comment for MESSAGETYPE_DEBUG here.
*/
enum MessageType{MESSAGETYPE_ALL, MESSAGETYPE_NONE, MESSAGETYPE_INFORMATION, MESSAGETYPE_ERROR, MESSAGETYPE_DEBUG};
/*!
* \brief
* Write brief comment for ~Logger here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~Logger here.
*
* \remarks
* Write remarks for ~Logger here.
*
* \see
* Separate items with the '|' character.
*/
virtual ~Logger(void){}
/*!
* \brief
* Write brief comment for Log here.
*
* \param message
* Description of parameter message.
*
* \param type
* Description of parameter type.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Log here.
*
* \remarks
* Write remarks for Log here.
*
* \see
* Separate items with the '|' character.
*/
virtual void Log(const char* message, MessageType type=MESSAGETYPE_INFORMATION) = 0;
/*!
* \brief
* Write brief comment for Log here.
*
* \param message
* Description of parameter message.
*
* \param classification
* Description of parameter classification.
*
* \param type
* Description of parameter type.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Log here.
*
* \remarks
* Write remarks for Log here.
*
* \see
* Separate items with the '|' character.
*/
virtual void Log(const char* message, const char* classification, MessageType type=MESSAGETYPE_INFORMATION) = 0;
};
};

75
src/NullVideoPlugin.h
View File

@@ -4,13 +4,88 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for NullVideoPlugin here.
*
* Write detailed description for NullVideoPlugin here.
*
* \remarks
* Write remarks for NullVideoPlugin here.
*
* \see
* Separate items with the '|' character.
*/
class NullVideoPlugin :
public OpenArena::VideoPlugin
{
public:
/*!
* \brief
* Write brief comment for NullVideoPlugin here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for NullVideoPlugin here.
*
* \remarks
* Write remarks for NullVideoPlugin here.
*
* \see
* Separate items with the '|' character.
*/
NullVideoPlugin(void);
public:
/*!
* \brief
* Write brief comment for ~NullVideoPlugin here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~NullVideoPlugin here.
*
* \remarks
* Write remarks for ~NullVideoPlugin here.
*
* \see
* Separate items with the '|' character.
*/
virtual ~NullVideoPlugin(void);
/*!
* \brief
* Write brief comment for CreateNewWindow here.
*
* \param width
* Description of parameter width.
*
* \param height
* Description of parameter height.
*
* \param bpp
* Description of parameter bpp.
*
* \param fullscreen
* Description of parameter fullscreen.
*
* \param title
* Description of parameter title.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for CreateNewWindow here.
*
* \remarks
* Write remarks for CreateNewWindow here.
*
* \see
* Separate items with the '|' character.
*/
virtual Window* CreateNewWindow(uint32 width, uint32 height, uint32 bpp = 32, bool fullscreen = false, const char* title = NULL);
};

31
src/Plugin.h
View File

@@ -2,10 +2,41 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Plugin here.
*
* Write detailed description for Plugin here.
*
* \remarks
* Write remarks for Plugin here.
*
* \see
* Separate items with the '|' character.
*/
class Plugin
{
public:
/*!
* \brief
* Write brief comment for ~Plugin here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~Plugin here.
*
* \remarks
* Write remarks for ~Plugin here.
*
* \see
* Separate items with the '|' character.
*/
virtual ~Plugin(void){}
/*!
* \brief
* Write brief comment for InputPlugin here.
*/
enum Type {VideoPlugin, AudioPlugin, InputPlugin};
};

81
src/PluginManager.h
View File

@@ -9,6 +9,18 @@ namespace OpenArena
/**
* Perhaps this class should be a singleton.
*/
/*!
* \brief
* Write brief comment for PluginManager here.
*
* Write detailed description for PluginManager here.
*
* \remarks
* Write remarks for PluginManager here.
*
* \see
* Separate items with the '|' character.
*/
class PluginManager
{
private:
@@ -17,10 +29,79 @@ namespace OpenArena
/**
* Creates a new PluginManager object
*/
/*!
* \brief
* Write brief comment for PluginManager here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for PluginManager here.
*
* \remarks
* Write remarks for PluginManager here.
*
* \see
* Separate items with the '|' character.
*/
PluginManager(void);
/*!
* \brief
* Write brief comment for ~PluginManager here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~PluginManager here.
*
* \remarks
* Write remarks for ~PluginManager here.
*
* \see
* Separate items with the '|' character.
*/
~PluginManager(void);
/*!
* \brief
* Write brief comment for GetPluginsOfType here.
*
* \param type
* Description of parameter type.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetPluginsOfType here.
*
* \remarks
* Write remarks for GetPluginsOfType here.
*
* \see
* Separate items with the '|' character.
*/
list<Plugin*> GetPluginsOfType(Plugin::Type type);
/*!
* \brief
* Write brief comment for GetDefaultVideoPlugin here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetDefaultVideoPlugin here.
*
* \remarks
* Write remarks for GetDefaultVideoPlugin here.
*
* \see
* Separate items with the '|' character.
*/
VideoPlugin* GetDefaultVideoPlugin(void);
};
};

60
src/VideoPlugin.h
View File

@@ -5,11 +5,71 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for VideoPlugin here.
*
* Write detailed description for VideoPlugin here.
*
* \remarks
* Write remarks for VideoPlugin here.
*
* \see
* Separate items with the '|' character.
*/
class VideoPlugin :public Plugin
{
public:
public:
/*!
* \brief
* Write brief comment for ~VideoPlugin here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~VideoPlugin here.
*
* \remarks
* Write remarks for ~VideoPlugin here.
*
* \see
* Separate items with the '|' character.
*/
virtual ~VideoPlugin(){}
/*!
* \brief
* Write brief comment for CreateNewWindow here.
*
* \param width
* Description of parameter width.
*
* \param height
* Description of parameter height.
*
* \param bpp
* Description of parameter bpp.
*
* \param fullscreen
* Description of parameter fullscreen.
*
* \param title
* Description of parameter title.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for CreateNewWindow here.
*
* \remarks
* Write remarks for CreateNewWindow here.
*
* \see
* Separate items with the '|' character.
*/
virtual Window* CreateNewWindow(uint32 width,
uint32 height,
uint32 bpp = 32,

126
src/WindowsLogger.h
View File

@@ -4,17 +4,143 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for WindowsLogger here.
*
* Write detailed description for WindowsLogger here.
*
* \remarks
* Write remarks for WindowsLogger here.
*
* \see
* Separate items with the '|' character.
*/
class WindowsLogger :
public OpenArena::Logger
{
private:
/*!
* \brief
* Write brief comment for GetIconFromMessageType here.
*
* \param type
* Description of parameter type.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetIconFromMessageType here.
*
* \remarks
* Write remarks for GetIconFromMessageType here.
*
* \see
* Separate items with the '|' character.
*/
uint32 GetIconFromMessageType(MessageType type);
MessageType _type;
public:
/*!
* \brief
* Write brief comment for WindowsLogger here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for WindowsLogger here.
*
* \remarks
* Write remarks for WindowsLogger here.
*
* \see
* Separate items with the '|' character.
*/
WindowsLogger();
/*!
* \brief
* Write brief comment for WindowsLogger here.
*
* \param type
* Description of parameter type.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for WindowsLogger here.
*
* \remarks
* Write remarks for WindowsLogger here.
*
* \see
* Separate items with the '|' character.
*/
WindowsLogger(Logger::MessageType type);
/*!
* \brief
* Write brief comment for Log here.
*
* \param message
* Description of parameter message.
*
* \param type
* Description of parameter type.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Log here.
*
* \remarks
* Write remarks for Log here.
*
* \see
* Separate items with the '|' character.
*/
virtual void Log(const char* message, MessageType type=MESSAGETYPE_INFORMATION);
/*!
* \brief
* Write brief comment for Log here.
*
* \param message
* Description of parameter message.
*
* \param classification
* Description of parameter classification.
*
* \param type
* Description of parameter type.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Log here.
*
* \remarks
* Write remarks for Log here.
*
* \see
* Separate items with the '|' character.
*/
virtual void Log(const char* message, const char* classification, MessageType type=MESSAGETYPE_INFORMATION);
/*!
* \brief
* Write brief comment for ~WindowsLogger here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~WindowsLogger here.
*
* \remarks
* Write remarks for ~WindowsLogger here.
*
* \see
* Separate items with the '|' character.
*/
virtual ~WindowsLogger();
};
};

21
src/bmp.h
View File

@@ -4,6 +4,27 @@
#include "texture.h"
namespace OpenArena{
/*!
* \brief
* Write brief comment for LoadBMP here.
*
* \param Filename
* Description of parameter Filename.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadBMP here.
*
* \remarks
* Write remarks for LoadBMP here.
*
* \see
* Separate items with the '|' character.
*/
TextureImage* LoadBMP(const char* Filename);
};

297
src/camera.h
View File

@@ -1,3 +1,8 @@
/*!
* <File comment goes here!!>
*
* Copyright (c) 2005 by <your name/ organization here>
*/
#ifndef __camera_h__
#define __camera_h__
@@ -11,59 +16,265 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Camera here.
*
* Write detailed description for Camera here.
*
* \remarks
* Write remarks for Camera here.
*
* \see
* Separate items with the '|' character.
*/
class Camera
{
public:
//Constructors
/*!
* \brief
* Creates a new Camera object.
*
* Creates a new Camera object located at the origin, pointing at the negative z-axis with up being the positive y-axis.
*
*/
Camera(); //Default Constructor
//Purpose:
// Creates a new Camera object located at the origin, pointing at the negative z-axis with up being the positive y-axis
//Camera(const Camera&); //Copy Constructor
//Purpose:
//
//Observer Accessors
/*!
* \brief
* Returns this Camera's position.
*
* \returns
* This Camera's position as a Vec3d vector.
*
* Returns this Camera's position.
*
*/
Vec3f Position();
//Purpose:
// Returns the position vector of this camera.
// This vector is the location of the camera.
/*!
* \brief
* Write brief comment for View here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for View here.
*
* \remarks
* Write remarks for View here.
*
* \see
* Separate items with the '|' character.
*/
Vec3f View();
//Purpose:
// Returns the view vector of this camera.
// This vector is the direction the camera is pointing.
/*!
* \brief
* Write brief comment for UpVector here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for UpVector here.
*
* \remarks
* Write remarks for UpVector here.
*
* \see
* Separate items with the '|' character.
*/
Vec3f UpVector();
//Purpose:
// Returns the up vector of this camera.
// This vector points up in the rendered view.
/*!
* \brief
* Write brief comment for Strafe here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Strafe here.
*
* \remarks
* Write remarks for Strafe here.
*
* \see
* Separate items with the '|' character.
*/
Vec3f Strafe();
//Purpose:
// Returns the strafe vector fo this camera.
// This is the direction StrafeCamera will move
//Mutators
/*!
* \brief
* Write brief comment for PositionCamera here.
*
* \param xpos
* Description of parameter xpos.
*
* \param ypos
* Description of parameter ypos.
*
* \param zpos
* Description of parameter zpos.
*
* \param xview
* Description of parameter xview.
*
* \param yview
* Description of parameter yview.
*
* \param zview
* Description of parameter zview.
*
* \param xup
* Description of parameter xup.
*
* \param yup
* Description of parameter yup.
*
* \param zup
* Description of parameter zup.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for PositionCamera here.
*
* \remarks
* Write remarks for PositionCamera here.
*
* \see
* Separate items with the '|' character.
*/
void PositionCamera(double xpos, double ypos, double zpos,
double xview, double yview, double zview,
double xup, double yup, double zup);
//Purpose:
// Relocates and reorientates the camera as determined by the given vector components.
/*!
* \brief
* Write brief comment for PositionCamera here.
*
* \param pos
* Description of parameter pos.
*
* \param view
* Description of parameter view.
*
* \param up
* Description of parameter up.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for PositionCamera here.
*
* \remarks
* Write remarks for PositionCamera here.
*
* \see
* Separate items with the '|' character.
*/
void PositionCamera(Vec3f pos, Vec3f view, Vec3f up);
//Purpose:
// Relocates and reorientates the camera as determined by the given vectos.
/*!
* \brief
* Write brief comment for RotateView here.
*
* \param angle
* Description of parameter angle.
*
* \param axis
* Description of parameter axis.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for RotateView here.
*
* \remarks
* Write remarks for RotateView here.
*
* \see
* Separate items with the '|' character.
*/
void Camera::RotateView(double angle, Vec3d axis);
//Purpose:
// Rotates the camera by angle degrees about the axis specified by axis.
/*!
* \brief
* Write brief comment for RotateView here.
*
* \param angle
* Description of parameter angle.
*
* \param X
* Description of parameter X.
*
* \param Y
* Description of parameter Y.
*
* \param Z
* Description of parameter Z.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for RotateView here.
*
* \remarks
* Write remarks for RotateView here.
*
* \see
* Separate items with the '|' character.
*/
void RotateView(double angle, double X, double Y, double Z);
//Purpose:
// Rotates the camera by angle degrees about the axis specified by the given components.
// Works the same as glRotatef(angle, X, Y, Z).
/*!
* \brief
* Write brief comment for SetViewByMouse here.
*
* \param window
* Description of parameter window.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetViewByMouse here.
*
* \remarks
* Write remarks for SetViewByMouse here.
*
* \see
* Separate items with the '|' character.
*/
void SetViewByMouse(Window window);
//Purpose:
// Updates the view Vector based on the change in mouse position since the last time it was called.
@@ -73,18 +284,84 @@ namespace OpenArena
//Purpose:
// Rotates the camera arount the point vCenter X degrees around the x-axis, Y degrees around the y-axis, and Z degrees around the z-axis in that order
/*!
* \brief
* Write brief comment for StrafeCamera here.
*
* \param speed
* Description of parameter speed.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for StrafeCamera here.
*
* \remarks
* Write remarks for StrafeCamera here.
*
* \see
* Separate items with the '|' character.
*/
void StrafeCamera(double speed);
//Purpose:
// Moves the camera along it's strafe vector speed units.
/*!
* \brief
* Write brief comment for MoveCamera here.
*
* \param speed
* Description of parameter speed.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for MoveCamera here.
*
* \remarks
* Write remarks for MoveCamera here.
*
* \see
* Separate items with the '|' character.
*/
void MoveCamera(double speed);
//Purpose:
// Moves the camera along it's view vector speed units.
/*!
* \brief
* Write brief comment for Update here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Update here.
*
* \remarks
* Write remarks for Update here.
*
* \see
* Separate items with the '|' character.
*/
void Update();
//Purpose:
// Recalculates the strafe vector.
/*!
* \brief
* Write brief comment for Look here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Look here.
*
* \remarks
* Write remarks for Look here.
*
* \see
* Separate items with the '|' character.
*/
void Look();
//Purpose:
// Calls gluLookAt with stored values to set the scene to the camera.

84
src/ctrls.h
View File

@@ -4,6 +4,18 @@
#include "list.h"
namespace OpenArena{
/*!
* \brief
* Write brief comment for ControlScheme here.
*
* Write detailed description for ControlScheme here.
*
* \remarks
* Write remarks for ControlScheme here.
*
* \see
* Separate items with the '|' character.
*/
class ControlScheme
{
public:
@@ -12,9 +24,81 @@ namespace OpenArena{
ACTION_ROLLLEFT, ACTION_ROLLRIGHT, ACTION_FIREPRIMARY, ACTION_FIRESECONDARY,
ACTION_WEAPONNEXT, ACTION_WEAPONPREV, ACTION_TOGGLE_LIGHTS, ACTION_TOGGLE_FPS,
ACTION_TOGGLE_CONSOLE, ACTION_TOGGLE_MOUSELOOK, ACTION_QUICKMOUSELOOK};
/*!
* \brief
* Write brief comment for LoadDefaultControlScheme here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadDefaultControlScheme here.
*
* \remarks
* Write remarks for LoadDefaultControlScheme here.
*
* \see
* Separate items with the '|' character.
*/
void LoadDefaultControlScheme();
/*!
* \brief
* Write brief comment for ClearControlScheme here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ClearControlScheme here.
*
* \remarks
* Write remarks for ClearControlScheme here.
*
* \see
* Separate items with the '|' character.
*/
void ClearControlScheme();
/*!
* \brief
* Write brief comment for Unbind here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Unbind here.
*
* \remarks
* Write remarks for Unbind here.
*
* \see
* Separate items with the '|' character.
*/
void Unbind(uint8);
/*!
* \brief
* Write brief comment for Bind here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Bind here.
*
* \remarks
* Write remarks for Bind here.
*
* \see
* Separate items with the '|' character.
*/
bool Bind(uint32, uint8);
list<uint8> forward;

101
src/entities.h
View File

@@ -2,32 +2,104 @@
using namespace std;
using OpenArena::Vec3d;
/*!
* \brief
* Write brief comment for LIGHT here.
*
* Write detailed description for LIGHT here.
*
* \remarks
* Write remarks for LIGHT here.
*
* \see
* Separate items with the '|' character.
*/
struct LIGHT
{
GLfloat coords[4];
GLfloat color[4];
};
/*!
* \brief
* Write brief comment for PLAYER_START here.
*
* Write detailed description for PLAYER_START here.
*
* \remarks
* Write remarks for PLAYER_START here.
*
* \see
* Separate items with the '|' character.
*/
struct PLAYER_START
{
Vec3d coords;
Vec3d heading;
};
/*!
* \brief
* Write brief comment for PLAYER_DEATHMATCH_START here.
*
* Write detailed description for PLAYER_DEATHMATCH_START here.
*
* \remarks
* Write remarks for PLAYER_DEATHMATCH_START here.
*
* \see
* Separate items with the '|' character.
*/
struct PLAYER_DEATHMATCH_START
{
Vec3d coords;
Vec3d heading;
};
/*!
* \brief
* Write brief comment for BOT_START here.
*
* Write detailed description for BOT_START here.
*
* \remarks
* Write remarks for BOT_START here.
*
* \see
* Separate items with the '|' character.
*/
struct BOT_START
{
Vec3d coords;
Vec3d heading;
string name;
};
/*!
* \brief
* Write brief comment for GEOMETRY here.
*
* Write detailed description for GEOMETRY here.
*
* \remarks
* Write remarks for GEOMETRY here.
*
* \see
* Separate items with the '|' character.
*/
struct GEOMETRY
{
int x;
};
/*!
* \brief
* Write brief comment for PROJECTILE here.
*
* Write detailed description for PROJECTILE here.
*
* \remarks
* Write remarks for PROJECTILE here.
*
* \see
* Separate items with the '|' character.
*/
struct PROJECTILE
{
Vec3d heading;
@@ -40,6 +112,18 @@ struct PROJECTILE
//const PROJECTILE BULLET = {{0,0,0},{0,0,0},{0,0,0},5};
//const PROJECTILE SPIKE = {{0,0,0},{0,0,0},{0,0,0},10};
/*!
* \brief
* Write brief comment for ENTITY here.
*
* Write detailed description for ENTITY here.
*
* \remarks
* Write remarks for ENTITY here.
*
* \see
* Separate items with the '|' character.
*/
struct ENTITY
{
PLAYER_START* Player_Start;
@@ -53,7 +137,22 @@ struct ENTITY
PROJECTILE* Projectile;
int numProjectile;
ENTITY();
/*!
* \brief
* Write brief comment for ENTITY here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ENTITY here.
*
* \remarks
* Write remarks for ENTITY here.
*
* \see
* Separate items with the '|' character.
*/
ENTITY();
};

27
src/entity.h
View File

@@ -9,9 +9,36 @@ enum { //Begin entity declaration
ENTITY_PLAYER_MULTI_START //Player start position for multiplayer.
}; //End entity declaration
/*!
* \brief
* Write brief comment for ENTITY here.
*
* Write detailed description for ENTITY here.
*
* \remarks
* Write remarks for ENTITY here.
*
* \see
* Separate items with the '|' character.
*/
class ENTITY
{
public:
/*!
* \brief
* Write brief comment for ENTITY here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ENTITY here.
*
* \remarks
* Write remarks for ENTITY here.
*
* \see
* Separate items with the '|' character.
*/
ENTITY()
{
type = ENTITY_NONE;

12
src/geometry.h
View File

@@ -3,6 +3,18 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Triangle here.
*
* Write detailed description for Triangle here.
*
* \remarks
* Write remarks for Triangle here.
*
* \see
* Separate items with the '|' character.
*/
class Triangle
{
public:

135
src/image.h
View File

@@ -4,17 +4,152 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Image here.
*
* Write detailed description for Image here.
*
* \remarks
* Write remarks for Image here.
*
* \see
* Separate items with the '|' character.
*/
class Image
{
public:
//RGB should equal GL_RGB;
enum Type{Type_RGB};
/*!
* \brief
* Write brief comment for GetImageData here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetImageData here.
*
* \remarks
* Write remarks for GetImageData here.
*
* \see
* Separate items with the '|' character.
*/
virtual uint8 * GetImageData() const = 0;
/*!
* \brief
* Write brief comment for GetBitsPerPixel here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetBitsPerPixel here.
*
* \remarks
* Write remarks for GetBitsPerPixel here.
*
* \see
* Separate items with the '|' character.
*/
virtual uint32 GetBitsPerPixel() const = 0;
/*!
* \brief
* Write brief comment for GetBytesPerPixel here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetBytesPerPixel here.
*
* \remarks
* Write remarks for GetBytesPerPixel here.
*
* \see
* Separate items with the '|' character.
*/
virtual uint32 GetBytesPerPixel() const = 0;
/*!
* \brief
* Write brief comment for GetWidth here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetWidth here.
*
* \remarks
* Write remarks for GetWidth here.
*
* \see
* Separate items with the '|' character.
*/
virtual uint32 GetWidth() const = 0;
/*!
* \brief
* Write brief comment for GetHeight here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetHeight here.
*
* \remarks
* Write remarks for GetHeight here.
*
* \see
* Separate items with the '|' character.
*/
virtual uint32 GetHeight() const = 0;
/*!
* \brief
* Write brief comment for GetType here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetType here.
*
* \remarks
* Write remarks for GetType here.
*
* \see
* Separate items with the '|' character.
*/
virtual Image::Type GetType() const = 0;
/*!
* \brief
* Write brief comment for ~Image here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~Image here.
*
* \remarks
* Write remarks for ~Image here.
*
* \see
* Separate items with the '|' character.
*/
virtual ~Image(void){}
};
};

72
src/keys.h
View File

@@ -3,6 +3,18 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Keys here.
*
* Write detailed description for Keys here.
*
* \remarks
* Write remarks for Keys here.
*
* \see
* Separate items with the '|' character.
*/
enum Keys{
KEY_UNKNOWN = 0,
KEY_BUTTON0,
@@ -109,9 +121,69 @@ namespace OpenArena
KEY_Y,
KEY_Z
};
/*!
* \brief
* Write brief comment for KEY_LBUTTON here.
*
* Write detailed description for KEY_LBUTTON here.
*
* \remarks
* Write remarks for KEY_LBUTTON here.
*
* \see
* Separate items with the '|' character.
*/
const Keys KEY_LBUTTON = KEY_BUTTON0;
/*!
* \brief
* Write brief comment for KEY_RBUTTON here.
*
* Write detailed description for KEY_RBUTTON here.
*
* \remarks
* Write remarks for KEY_RBUTTON here.
*
* \see
* Separate items with the '|' character.
*/
const Keys KEY_RBUTTON = KEY_BUTTON1;
/*!
* \brief
* Write brief comment for KEY_MBUTTON here.
*
* Write detailed description for KEY_MBUTTON here.
*
* \remarks
* Write remarks for KEY_MBUTTON here.
*
* \see
* Separate items with the '|' character.
*/
const Keys KEY_MBUTTON = KEY_BUTTON2;
/*!
* \brief
* Write brief comment for KeyToASCII here.
*
* \param key
* Description of parameter key.
*
* \param shift
* Description of parameter shift.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for KeyToASCII here.
*
* \remarks
* Write remarks for KeyToASCII here.
*
* \see
* Separate items with the '|' character.
*/
char KeyToASCII(Keys key, bool shift);
};
#endif

370
src/level.h
View File

@@ -42,35 +42,387 @@ using OpenArena::Triangle;
namespace OpenArena
{
/*!
* \brief
* Write brief comment for piover180 here.
*
* Write detailed description for piover180 here.
*
* \remarks
* Write remarks for piover180 here.
*
* \see
* Separate items with the '|' character.
*/
const float piover180 = 0.0174532925f;
/*!
* \brief
* 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
* Separate items with the '|' character.
*/
const string DEFAULT_TEXTURE_NAME = "oa/textures/default.bmp";
/*!
* \brief
* 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
* Separate items with the '|' character.
*/
const unsigned int MAX_CONSOLE_LINES = 30; //The max number of lines to be displayed in the console
/*!
* \brief
* 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
* Separate items with the '|' character.
*/
const unsigned int MAX_CONSOLE_HISTORY_LINES = MAX_CONSOLE_LINES + 20; //The max number of console lines to store in the history
/*!
* \brief
* 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
* Separate items with the '|' character.
*/
const unsigned int MAX_CONSOLE_OUTPUT_LINES = MAX_CONSOLE_LINES;
/*!
* \brief
* 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
* Separate items with the '|' character.
*/
const unsigned int MAX_OUTPUT_TEXT_LINES = 4; //The max number of output lines to be displayed on the screen
/*!
* \brief
* Write brief comment for GL_MY_TEXTURE_CONSOLEBACKGROUND here.
*/
enum {GL_MY_TEXTURE_CONSOLEBACKGROUND=0, NUM_MENU_TEXTURES};
class Level
{
public:
/*!
* \brief
* Write brief comment for Level here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Level here.
*
* \remarks
* Write remarks for Level here.
*
* \see
* Separate items with the '|' character.
*/
Level();
/*!
* \brief
* Write brief comment for ~Level here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~Level here.
*
* \remarks
* Write remarks for ~Level here.
*
* \see
* Separate items with the '|' character.
*/
~Level();
/*!
* \brief
* Write brief comment for LoadMap here.
*
* \param mapname
* Description of parameter mapname.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadMap here.
*
* \remarks
* Write remarks for LoadMap here.
*
* \see
* Separate items with the '|' character.
*/
bool LoadMap(string mapname);
/*!
* \brief
* Write brief comment for LoadMap here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadMap here.
*
* \remarks
* Write remarks for LoadMap here.
*
* \see
* Separate items with the '|' character.
*/
bool LoadMap();
/*!
* \brief
* Write brief comment for SaveMap here.
*
* \param mapname
* Description of parameter mapname.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SaveMap here.
*
* \remarks
* Write remarks for SaveMap here.
*
* \see
* Separate items with the '|' character.
*/
void SaveMap(string mapname);
/*!
* \brief
* Write brief comment for LoadConfig here.
*
* \param cfgname
* Description of parameter cfgname.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadConfig here.
*
* \remarks
* Write remarks for LoadConfig here.
*
* \see
* Separate items with the '|' character.
*/
bool LoadConfig(string cfgname);
/*!
* \brief
* Write brief comment for LoadConfig here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadConfig here.
*
* \remarks
* Write remarks for LoadConfig here.
*
* \see
* Separate items with the '|' character.
*/
void LoadConfig();
void SaveConfig(string cfgname);
/*!
* \brief
* Write brief comment for Execute here.
*
* \param cmd
* Description of parameter cmd.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Execute here.
*
* \remarks
* Write remarks for Execute here.
*
* \see
* Separate items with the '|' character.
*/
void Execute(string cmd);
/*!
* \brief
* Write brief comment for LoadGLTextures here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadGLTextures here.
*
* \remarks
* Write remarks for LoadGLTextures here.
*
* \see
* Separate items with the '|' character.
*/
void LoadGLTextures();
/*!
* \brief
* Write brief comment for Render here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Render here.
*
* \remarks
* Write remarks for Render here.
*
* \see
* Separate items with the '|' character.
*/
void Render();
/*!
* \brief
* Write brief comment for UnloadMap here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for UnloadMap here.
*
* \remarks
* Write remarks for UnloadMap here.
*
* \see
* Separate items with the '|' character.
*/
void UnloadMap();
/*!
* \brief
* Write brief comment for UpdateConsole here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for UpdateConsole here.
*
* \remarks
* Write remarks for UpdateConsole here.
*
* \see
* Separate items with the '|' character.
*/
void UpdateConsole(char);
/*!
* \brief
* Write brief comment for FPS here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for FPS here.
*
* \remarks
* Write remarks for FPS here.
*
* \see
* Separate items with the '|' character.
*/
uint32 FPS();
/*!
* \brief
* Write brief comment for ParseCmds here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ParseCmds here.
*
* \remarks
* Write remarks for ParseCmds here.
*
* \see
* Separate items with the '|' character.
*/
void ParseCmds(const char*);
void Print(int x, int y, const char* string, unsigned int set);
/*!
* \brief
* Write brief comment for SetWindow here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetWindow here.
*
* \remarks
* Write remarks for SetWindow here.
*
* \see
* Separate items with the '|' character.
*/
void SetWindow(Window*);
/*!
* \brief
* Write brief comment for GetWindow here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetWindow here.
*
* \remarks
* Write remarks for GetWindow here.
*
* \see
* Separate items with the '|' character.
*/
Window* GetWindow();
/*Not Yet Implemented
@@ -110,6 +462,24 @@ namespace OpenArena
// private:
/*!
* \brief
* Write brief comment for ConsolePrint here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ConsolePrint here.
*
* \remarks
* Write remarks for ConsolePrint here.
*
* \see
* Separate items with the '|' character.
*/
void ConsolePrint(string);
private:
string consoleHistory[MAX_CONSOLE_HISTORY_LINES];

414
src/list.h
View File

@@ -8,40 +8,454 @@
namespace OpenArena{
typedef unsigned int LIST_ARRAY_INDEX_TYPE;
/*!
* \brief
* Write brief comment for listNode here.
*
* \param ItemType
* Description of parameter ItemType.
*
* Write detailed description for listNode here.
*
* \remarks
* Write remarks for listNode here.
*
* \see
* Separate items with the '|' character.
*/
template <class ItemType>
class listNode
{
public:
/*!
* \brief
* Write brief comment for listNode here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for listNode here.
*
* \remarks
* Write remarks for listNode here.
*
* \see
* Separate items with the '|' character.
*/
listNode();
ItemType data;
listNode<ItemType>* next;
};
/*!
* \brief
* Write brief comment for list here.
*
* \param ItemType
* Description of parameter ItemType.
*
* Write detailed description for list here.
*
* \remarks
* Write remarks for list here.
*
* \see
* Separate items with the '|' character.
*/
template <class ItemType>
class list
{
public:
/*!
* \brief
* Write brief comment for list here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for list here.
*
* \remarks
* Write remarks for list here.
*
* \see
* Separate items with the '|' character.
*/
list();
/*!
* \brief
* Write brief comment for ~list here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~list here.
*
* \remarks
* Write remarks for ~list here.
*
* \see
* Separate items with the '|' character.
*/
~list();
/*!
* \brief
* Write brief comment for list here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for list here.
*
* \remarks
* Write remarks for list here.
*
* \see
* Separate items with the '|' character.
*/
list(const list&);
/*!
* \brief
* Write brief comment for IsEmpty here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for IsEmpty here.
*
* \remarks
* Write remarks for IsEmpty here.
*
* \see
* Separate items with the '|' character.
*/
bool IsEmpty() const;
/*!
* \brief
* Write brief comment for IsFull here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for IsFull here.
*
* \remarks
* Write remarks for IsFull here.
*
* \see
* Separate items with the '|' character.
*/
bool IsFull() const;
/*!
* \brief
* Write brief comment for Insert here.
*
* \param newItem
* Description of parameter newItem.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Insert here.
*
* \remarks
* Write remarks for Insert here.
*
* \see
* Separate items with the '|' character.
*/
void Insert(ItemType newItem);
/*!
* \brief
* Write brief comment for Remove here.
*
* \param target
* Description of parameter target.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Remove here.
*
* \remarks
* Write remarks for Remove here.
*
* \see
* Separate items with the '|' character.
*/
void Remove(ItemType target);
/*!
* \brief
* Write brief comment for Remove here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Remove here.
*
* \remarks
* Write remarks for Remove here.
*
* \see
* Separate items with the '|' character.
*/
void Remove();
/*!
* \brief
* Write brief comment for Retrieve here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Retrieve here.
*
* \remarks
* Write remarks for Retrieve here.
*
* \see
* Separate items with the '|' character.
*/
ItemType Retrieve() const;
/*!
* \brief
* Write brief comment for PrevPosition here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for PrevPosition here.
*
* \remarks
* Write remarks for PrevPosition here.
*
* \see
* Separate items with the '|' character.
*/
bool PrevPosition();
/*!
* \brief
* Write brief comment for NextPosition here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for NextPosition here.
*
* \remarks
* Write remarks for NextPosition here.
*
* \see
* Separate items with the '|' character.
*/
bool NextPosition();
/*!
* \brief
* Write brief comment for IsFirstPosition here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for IsFirstPosition here.
*
* \remarks
* Write remarks for IsFirstPosition here.
*
* \see
* Separate items with the '|' character.
*/
bool IsFirstPosition() const;
/*!
* \brief
* Write brief comment for IsLastPosition here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for IsLastPosition here.
*
* \remarks
* Write remarks for IsLastPosition here.
*
* \see
* Separate items with the '|' character.
*/
bool IsLastPosition() const;
/*!
* \brief
* Write brief comment for FirstPosition here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for FirstPosition here.
*
* \remarks
* Write remarks for FirstPosition here.
*
* \see
* Separate items with the '|' character.
*/
void FirstPosition();
/*!
* \brief
* Write brief comment for LastPosition here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LastPosition here.
*
* \remarks
* Write remarks for LastPosition here.
*
* \see
* Separate items with the '|' character.
*/
void LastPosition();
/*!
* \brief
* Write brief comment for Clear here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Clear here.
*
* \remarks
* Write remarks for Clear here.
*
* \see
* Separate items with the '|' character.
*/
void Clear();
/*!
* \brief
* Write brief comment for Contains here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Contains here.
*
* \remarks
* Write remarks for Contains here.
*
* \see
* Separate items with the '|' character.
*/
bool Contains(ItemType) const;
/*!
* \brief
* Write brief comment for Length here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Length here.
*
* \remarks
* Write remarks for Length here.
*
* \see
* Separate items with the '|' character.
*/
unsigned int Length();
/*!
* \brief
* Write brief comment for operator = here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator = here.
*
* \remarks
* Write remarks for operator = here.
*
* \see
* Separate items with the '|' character.
*/
void operator=(const list<ItemType>&);
/*!
* \brief
* Write brief comment for operator [] here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator [] here.
*
* \remarks
* Write remarks for operator [] here.
*
* \see
* Separate items with the '|' character.
*/
ItemType operator[](LIST_ARRAY_INDEX_TYPE) const;
/*!
* \brief
* Write brief comment for operator [] here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator [] here.
*
* \remarks
* Write remarks for operator [] here.
*
* \see
* Separate items with the '|' character.
*/
ItemType& operator[](LIST_ARRAY_INDEX_TYPE);
private:

56
src/main.h
View File

@@ -53,10 +53,62 @@ static float currentTime;
//This shouldn't need to be here
//LRESULT CALLBACK WndProc(HWND, UINT, WPARAM, LPARAM); // Declaration for WndProc
/*!
* \brief
* Write brief comment for InitControls here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for InitControls here.
*
* \remarks
* Write remarks for InitControls here.
*
* \see
* Separate items with the '|' character.
*/
void InitControls(); // Sets up player controls
/*!
* \brief
* Write brief comment for InitGL here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for InitGL here.
*
* \remarks
* Write remarks for InitGL here.
*
* \see
* Separate items with the '|' character.
*/
int InitGL(); // All setup for OpenGL goes here
/*!
* \brief
* Write brief comment for ReSizeGLScene here.
*
* \param width
* Description of parameter width.
*
* \param height
* Description of parameter height.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ReSizeGLScene here.
*
* \remarks
* Write remarks for ReSizeGLScene here.
*
* \see
* Separate items with the '|' character.
*/
void ReSizeGLScene(GLsizei width, GLsizei height); // Resize and initialize the GL window
#endif

48
src/mygl.h
View File

@@ -34,7 +34,55 @@ extern OpenArena::Window g_Screen;
//int InitGL(GLvoid);
namespace OpenArena
{
/*!
* \brief
* Write brief comment for LoadGLTexture here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadGLTexture here.
*
* \remarks
* Write remarks for LoadGLTexture here.
*
* \see
* Separate items with the '|' character.
*/
bool LoadGLTexture(string , GLuint&, GLuint = GL_LINEAR, GLuint = GL_LINEAR);
/*!
* \brief
* Write brief comment for FreeGLTexture here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for FreeGLTexture here.
*
* \remarks
* Write remarks for FreeGLTexture here.
*
* \see
* Separate items with the '|' character.
*/
void FreeGLTexture(GLuint&);
};
#endif

219
src/myglFont.h
View File

@@ -5,6 +5,18 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Font here.
*
* Write detailed description for Font here.
*
* \remarks
* Write remarks for Font here.
*
* \see
* Separate items with the '|' character.
*/
class Font
{
private:
@@ -15,16 +27,223 @@ namespace OpenArena
bool status;
public:
/*!
* \brief
* Write brief comment for Font here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Font here.
*
* \remarks
* Write remarks for Font here.
*
* \see
* Separate items with the '|' character.
*/
Font();
/*!
* \brief
* Write brief comment for ~Font here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~Font here.
*
* \remarks
* Write remarks for ~Font here.
*
* \see
* Separate items with the '|' character.
*/
~Font();
/*!
* \brief
* Write brief comment for BuildFont here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for BuildFont here.
*
* \remarks
* Write remarks for BuildFont here.
*
* \see
* Separate items with the '|' character.
*/
bool BuildFont(const char*);
/*!
* \brief
* Write brief comment for FreeFont here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for FreeFont here.
*
* \remarks
* Write remarks for FreeFont here.
*
* \see
* Separate items with the '|' character.
*/
bool FreeFont();
/*!
* \brief
* Write brief comment for Print here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Print here.
*
* \remarks
* Write remarks for Print here.
*
* \see
* Separate items with the '|' character.
*/
void Print(int, int, const char*, unsigned int = 0);
/*!
* \brief
* Write brief comment for Loaded here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Loaded here.
*
* \remarks
* Write remarks for Loaded here.
*
* \see
* Separate items with the '|' character.
*/
bool Loaded();
/*!
* \brief
* Write brief comment for SetScreenDimensions here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetScreenDimensions here.
*
* \remarks
* Write remarks for SetScreenDimensions here.
*
* \see
* Separate items with the '|' character.
*/
void SetScreenDimensions(short, short);
/*!
* \brief
* Write brief comment for SetScreenWidth here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetScreenWidth here.
*
* \remarks
* Write remarks for SetScreenWidth here.
*
* \see
* Separate items with the '|' character.
*/
void SetScreenWidth(short);
/*!
* \brief
* Write brief comment for SetScreenHeight here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetScreenHeight here.
*
* \remarks
* Write remarks for SetScreenHeight here.
*
* \see
* Separate items with the '|' character.
*/
void SetScreenHeight(short);
/*!
* \brief
* Write brief comment for ScreenWidth here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ScreenWidth here.
*
* \remarks
* Write remarks for ScreenWidth here.
*
* \see
* Separate items with the '|' character.
*/
short ScreenWidth();
/*!
* \brief
* Write brief comment for ScreenHeight here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ScreenHeight here.
*
* \remarks
* Write remarks for ScreenHeight here.
*
* \see
* Separate items with the '|' character.
*/
short ScreenHeight();
};
};

285
src/myglTexture.h
View File

@@ -9,22 +9,307 @@ using namespace std;
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Texture here.
*
* Write detailed description for Texture here.
*
* \remarks
* Write remarks for Texture here.
*
* \see
* Separate items with the '|' character.
*/
class Texture
{
public:
/*!
* \brief
* Write brief comment for Texture here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Texture here.
*
* \remarks
* Write remarks for Texture here.
*
* \see
* Separate items with the '|' character.
*/
Texture();
/*!
* \brief
* Write brief comment for ~Texture here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~Texture here.
*
* \remarks
* Write remarks for ~Texture here.
*
* \see
* Separate items with the '|' character.
*/
~Texture();
/*!
* \brief
* Write brief comment for Filename here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Filename here.
*
* \remarks
* Write remarks for Filename here.
*
* \see
* Separate items with the '|' character.
*/
string Filename();
/*!
* \brief
* Write brief comment for ID here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ID here.
*
* \remarks
* Write remarks for ID here.
*
* \see
* Separate items with the '|' character.
*/
GLuint ID();
/*!
* \brief
* Write brief comment for Load here.
*
* \param filename
* Description of parameter filename.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Load here.
*
* \remarks
* Write remarks for Load here.
*
* \see
* Separate items with the '|' character.
*/
bool Load(string filename);
/*!
* \brief
* Write brief comment for Load here.
*
* \param filename
* Description of parameter filename.
*
* \param min
* Description of parameter min.
*
* \param mag
* Description of parameter mag.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Load here.
*
* \remarks
* Write remarks for Load here.
*
* \see
* Separate items with the '|' character.
*/
bool Load(string filename, GLuint min, GLuint mag);
/*!
* \brief
* Write brief comment for Free here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Free here.
*
* \remarks
* Write remarks for Free here.
*
* \see
* Separate items with the '|' character.
*/
void Free();
/*!
* \brief
* Write brief comment for Loaded here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Loaded here.
*
* \remarks
* Write remarks for Loaded here.
*
* \see
* Separate items with the '|' character.
*/
bool Loaded();
/*!
* \brief
* Write brief comment for operator < here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator < here.
*
* \remarks
* Write remarks for operator < here.
*
* \see
* Separate items with the '|' character.
*/
bool operator<(const Texture&);
/*!
* \brief
* Write brief comment for operator <= here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator <= here.
*
* \remarks
* Write remarks for operator <= here.
*
* \see
* Separate items with the '|' character.
*/
bool operator<=(const Texture&);
/*!
* \brief
* Write brief comment for operator == here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator == here.
*
* \remarks
* Write remarks for operator == here.
*
* \see
* Separate items with the '|' character.
*/
bool operator==(const Texture&);
/*!
* \brief
* Write brief comment for operator != here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator != here.
*
* \remarks
* Write remarks for operator != here.
*
* \see
* Separate items with the '|' character.
*/
bool operator!=(const Texture&);
/*!
* \brief
* Write brief comment for operator >= here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator >= here.
*
* \remarks
* Write remarks for operator >= here.
*
* \see
* Separate items with the '|' character.
*/
bool operator>=(const Texture&);
/*!
* \brief
* Write brief comment for operator > here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for operator > here.
*
* \remarks
* Write remarks for operator > here.
*
* \see
* Separate items with the '|' character.
*/
bool operator>(const Texture&);
private:

12
src/physics.h
View File

@@ -1,4 +1,16 @@
//Rename/Move
/*!
* \brief
* Write brief comment for WORLD_PHYSICS here.
*
* Write detailed description for WORLD_PHYSICS here.
*
* \remarks
* Write remarks for WORLD_PHYSICS here.
*
* \see
* Separate items with the '|' character.
*/
class WORLD_PHYSICS
{
public:

93
src/player.h
View File

@@ -6,15 +6,108 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Player here.
*
* Write detailed description for Player here.
*
* \remarks
* Write remarks for Player here.
*
* \see
* Separate items with the '|' character.
*/
class Player
{
public:
/*!
* \brief
* Write brief comment for Load here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Load here.
*
* \remarks
* Write remarks for Load here.
*
* \see
* Separate items with the '|' character.
*/
void Load();
/*!
* \brief
* Write brief comment for Save here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Save here.
*
* \remarks
* Write remarks for Save here.
*
* \see
* Separate items with the '|' character.
*/
void Save();
/*!
* \brief
* Write brief comment for CreateCharacter here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for CreateCharacter here.
*
* \remarks
* Write remarks for CreateCharacter here.
*
* \see
* Separate items with the '|' character.
*/
void CreateCharacter();
//void FirePrimary(ENTITY& ent);
//void FireSecondary();
/*!
* \brief
* Write brief comment for AddItem here.
*
* \param item
* Description of parameter item.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for AddItem here.
*
* \remarks
* Write remarks for AddItem here.
*
* \see
* Separate items with the '|' character.
*/
void AddItem(unsigned int item);
/*!
* \brief
* Write brief comment for RemoveItem here.
*
* \param item
* Description of parameter item.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for RemoveItem here.
*
* \remarks
* Write remarks for RemoveItem here.
*
* \see
* Separate items with the '|' character.
*/
void RemoveItem(unsigned int item);
ControlScheme controls;

261
src/screen.h
View File

@@ -5,22 +5,283 @@
using namespace std;
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Screen here.
*
* Write detailed description for Screen here.
*
* \remarks
* Write remarks for Screen here.
*
* \see
* Separate items with the '|' character.
*/
class Screen
{
public:
/*!
* \brief
* Write brief comment for Screen here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Screen here.
*
* \remarks
* Write remarks for Screen here.
*
* \see
* Separate items with the '|' character.
*/
Screen();
/*!
* \brief
* Write brief comment for GetWidth here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetWidth here.
*
* \remarks
* Write remarks for GetWidth here.
*
* \see
* Separate items with the '|' character.
*/
int GetWidth();
/*!
* \brief
* Write brief comment for GetHeight here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetHeight here.
*
* \remarks
* Write remarks for GetHeight here.
*
* \see
* Separate items with the '|' character.
*/
int GetHeight();
/*!
* \brief
* Write brief comment for GetColorDepth here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetColorDepth here.
*
* \remarks
* Write remarks for GetColorDepth here.
*
* \see
* Separate items with the '|' character.
*/
int GetColorDepth();
/*!
* \brief
* Write brief comment for GetFullscreen here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetFullscreen here.
*
* \remarks
* Write remarks for GetFullscreen here.
*
* \see
* Separate items with the '|' character.
*/
bool GetFullscreen();
/*!
* \brief
* Write brief comment for GetName here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetName here.
*
* \remarks
* Write remarks for GetName here.
*
* \see
* Separate items with the '|' character.
*/
const char* GetName();
/*!
* \brief
* Write brief comment for SetWidth here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetWidth here.
*
* \remarks
* Write remarks for SetWidth here.
*
* \see
* Separate items with the '|' character.
*/
void SetWidth(int);
/*!
* \brief
* Write brief comment for SetHeight here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetHeight here.
*
* \remarks
* Write remarks for SetHeight here.
*
* \see
* Separate items with the '|' character.
*/
void SetHeight(int);
/*!
* \brief
* Write brief comment for Resize here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Resize here.
*
* \remarks
* Write remarks for Resize here.
*
* \see
* Separate items with the '|' character.
*/
void Resize(int, int);
/*!
* \brief
* Write brief comment for SetColorDepth here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetColorDepth here.
*
* \remarks
* Write remarks for SetColorDepth here.
*
* \see
* Separate items with the '|' character.
*/
void SetColorDepth(int);
/*!
* \brief
* Write brief comment for SetFullscreen here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetFullscreen here.
*
* \remarks
* Write remarks for SetFullscreen here.
*
* \see
* Separate items with the '|' character.
*/
void SetFullscreen(bool);
/*!
* \brief
* Write brief comment for ToggleFullscreen here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ToggleFullscreen here.
*
* \remarks
* Write remarks for ToggleFullscreen here.
*
* \see
* Separate items with the '|' character.
*/
void ToggleFullscreen();
/*!
* \brief
* Write brief comment for SetName here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetName here.
*
* \remarks
* Write remarks for SetName here.
*
* \see
* Separate items with the '|' character.
*/
void SetName(const char*);
/*!
* \brief
* Write brief comment for SetName here.
*
* \param
* Description of parameter .
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetName here.
*
* \remarks
* Write remarks for SetName here.
*
* \see
* Separate items with the '|' character.
*/
void SetName(string);
protected:
short _width;

219
src/strmanip.h
View File

@@ -8,15 +8,234 @@
using namespace std;
/*!
* \brief
* Write brief comment for Truth here.
*
* \param str
* Description of parameter str.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Truth here.
*
* \remarks
* Write remarks for Truth here.
*
* \see
* Separate items with the '|' character.
*/
bool Truth(string str);
/*!
* \brief
* Write brief comment for Integer here.
*
* \param str
* Description of parameter str.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Integer here.
*
* \remarks
* Write remarks for Integer here.
*
* \see
* Separate items with the '|' character.
*/
int Integer(string str);
/*!
* \brief
* Write brief comment for Floating here.
*
* \param str
* Description of parameter str.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Floating here.
*
* \remarks
* Write remarks for Floating here.
*
* \see
* Separate items with the '|' character.
*/
float Floating(string str);
/*!
* \brief
* Write brief comment for KeyName here.
*
* \param str
* Description of parameter str.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for KeyName here.
*
* \remarks
* Write remarks for KeyName here.
*
* \see
* Separate items with the '|' character.
*/
uint8 KeyName(string str);
/*!
* \brief
* Write brief comment for KeyString here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for KeyString here.
*
* \remarks
* Write remarks for KeyString here.
*
* \see
* Separate items with the '|' character.
*/
string KeyString(uint8);
/*!
* \brief
* Write brief comment for Right here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Right here.
*
* \remarks
* Write remarks for Right here.
*
* \see
* Separate items with the '|' character.
*/
string Right(string, uint32);
/*!
* \brief
* Write brief comment for Left here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Left here.
*
* \remarks
* Write remarks for Left here.
*
* \see
* Separate items with the '|' character.
*/
string Left(string, uint32);
/*!
* \brief
* Write brief comment for tolower here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for tolower here.
*
* \remarks
* Write remarks for tolower here.
*
* \see
* Separate items with the '|' character.
*/
string tolower(string);
/*!
* \brief
* Write brief comment for toupper here.
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for toupper here.
*
* \remarks
* Write remarks for toupper here.
*
* \see
* Separate items with the '|' character.
*/
string toupper(string);
/*!
* \brief
* Write brief comment for word here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for word here.
*
* \remarks
* Write remarks for word here.
*
* \see
* Separate items with the '|' character.
*/
string word(string, uint32);
#endif

12
src/texture.h
View File

@@ -1,6 +1,18 @@
#ifndef __texture_h__
#define __texture_h__
/*!
* \brief
* Write brief comment for TextureImage here.
*
* Write detailed description for TextureImage here.
*
* \remarks
* Write remarks for TextureImage here.
*
* \see
* Separate items with the '|' character.
*/
class TextureImage
{
public:

45
src/tga.h
View File

@@ -11,11 +11,35 @@
#include "texture.h"
namespace OpenArena{
/*!
* \brief
* Write brief comment for TGAHeader here.
*
* Write detailed description for TGAHeader here.
*
* \remarks
* Write remarks for TGAHeader here.
*
* \see
* Separate items with the '|' character.
*/
struct TGAHeader
{
GLubyte Header[12]; // File Header To Determine File Type
};
/*!
* \brief
* Write brief comment for TGA here.
*
* Write detailed description for TGA here.
*
* \remarks
* Write remarks for TGA here.
*
* \see
* Separate items with the '|' character.
*/
struct TGA
{
GLubyte header[6]; // Holds The First 6 Useful Bytes Of The File
@@ -27,6 +51,27 @@ namespace OpenArena{
GLuint Bpp; // Number Of BITS Per Pixel (24 Or 32)
};
/*!
* \brief
* Write brief comment for LoadTGA here.
*
* \param filename
* Description of parameter filename.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for LoadTGA here.
*
* \remarks
* Write remarks for LoadTGA here.
*
* \see
* Separate items with the '|' character.
*/
TextureImage* LoadTGA(const char *filename);
const GLubyte uTGAcompare[12] = {0,0,2, 0,0,0,0,0,0,0,0,0}; // Uncompressed TGA Header

954
src/vector.h
View File

File diff suppressed because it is too large Load Diff

327
src/window.h
View File

@@ -28,32 +28,329 @@
namespace OpenArena
{
/*!
* \brief
* Write brief comment for Window here.
*
* Write detailed description for Window here.
*
* \remarks
* Write remarks for Window here.
*
* \see
* Separate items with the '|' character.
*/
class Window: public Screen
{
public:
/*!
* \brief
* Write brief comment for Resizer here.
*
* Write detailed description for Resizer here.
*
* \remarks
* Write remarks for Resizer here.
*
* \see
* Separate items with the '|' character.
*/
class Resizer
{
public:
/*!
* \brief
* Write brief comment for Resize here.
*
* \param width
* Description of parameter width.
*
* \param height
* Description of parameter height.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Resize here.
*
* \remarks
* Write remarks for Resize here.
*
* \see
* Separate items with the '|' character.
*/
void Resize(GLsizei width, GLsizei height);
};
/*!
* \brief
* Write brief comment for Initializer here.
*
* Write detailed description for Initializer here.
*
* \remarks
* Write remarks for Initializer here.
*
* \see
* Separate items with the '|' character.
*/
class Initializer
{
public:
/*!
* \brief
* Write brief comment for Initialize here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Initialize here.
*
* \remarks
* Write remarks for Initialize here.
*
* \see
* Separate items with the '|' character.
*/
int Initialize();
};
public:
/*!
* \brief
* Write brief comment for Window here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Window here.
*
* \remarks
* Write remarks for Window here.
*
* \see
* Separate items with the '|' character.
*/
Window();
/*!
* \brief
* Write brief comment for ~Window here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for ~Window here.
*
* \remarks
* Write remarks for ~Window here.
*
* \see
* Separate items with the '|' character.
*/
~Window();
/*!
* \brief
* Write brief comment for Close here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Close here.
*
* \remarks
* Write remarks for Close here.
*
* \see
* Separate items with the '|' character.
*/
void Close();
/*!
* \brief
* Write brief comment for Open here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Open here.
*
* \remarks
* Write remarks for Open here.
*
* \see
* Separate items with the '|' character.
*/
bool Open();
/*!
* \brief
* Write brief comment for Open here.
*
* \param title
* Description of parameter title.
*
* \param width
* Description of parameter width.
*
* \param height
* Description of parameter height.
*
* \param bits
* Description of parameter bits.
*
* \param fullscreenflag
* Description of parameter fullscreenflag.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Open here.
*
* \remarks
* Write remarks for Open here.
*
* \see
* Separate items with the '|' character.
*/
bool Open(string title, int width, int height, int bits, bool fullscreenflag); //make that string a const char* after this works
/*!
* \brief
* Write brief comment for SetInitializer here.
*
* \param initializer
* Description of parameter initializer.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetInitializer here.
*
* \remarks
* Write remarks for SetInitializer here.
*
* \see
* Separate items with the '|' character.
*/
void SetInitializer(Initializer* initializer);
/*!
* \brief
* Write brief comment for SetResizer here.
*
* \param resizer
* Description of parameter resizer.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetResizer here.
*
* \remarks
* Write remarks for SetResizer here.
*
* \see
* Separate items with the '|' character.
*/
/*!
* \brief
* Write brief comment for SetResizer here.
*
* \param resizer
* Description of parameter resizer.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetResizer here.
*
* \remarks
* Write remarks for SetResizer here.
*
* \see
* Separate items with the '|' character.
*/
void SetResizer(Resizer* resizer);
/*!
* \brief
* Write brief comment for SwapBuffers here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SwapBuffers here.
*
* \remarks
* Write remarks for SwapBuffers here.
*
* \see
* Separate items with the '|' character.
*/
void SwapBuffers();
/*!
* \brief
* Write brief comment for Resize here.
*
* \param width
* Description of parameter width.
*
* \param height
* Description of parameter height.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for Resize here.
*
* \remarks
* Write remarks for Resize here.
*
* \see
* Separate items with the '|' character.
*/
void Resize(GLsizei width, GLsizei height);
/*!
* \brief
* Write brief comment for GetMousePosition here.
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for GetMousePosition here.
*
* \remarks
* Write remarks for GetMousePosition here.
*
* \see
* Separate items with the '|' character.
*/
Vec2i GetMousePosition();
/*!
* \brief
* Write brief comment for SetMousePosition here.
*
* \param pos
* Description of parameter pos.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for SetMousePosition here.
*
* \remarks
* Write remarks for SetMousePosition here.
*
* \see
* Separate items with the '|' character.
*/
void SetMousePosition(Vec2i pos);
#ifdef __linux
@@ -99,6 +396,36 @@ namespace OpenArena
};
#ifdef WIN32
/*!
* \brief
* Write brief comment for WndProc here.
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \param
* Description of parameter .
*
* \returns
* Write description of return value here.
*
* \throws <exception class>
* Description of criteria for throwing this exception.
*
* Write detailed description for WndProc here.
*
* \remarks
* Write remarks for WndProc here.
*
* \see
* Separate items with the '|' character.
*/
LRESULT CALLBACK WndProc(HWND, UINT, WPARAM, LPARAM);
#endif
#ifdef __linux