Ginger88895
/
warzone2100
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygenize the parameterlist of frameInitialise 

git-svn-id: svn+ssh://svn.gna.org/svn/warzone/trunk@4943 4a71c877-e1ca-e34f-864e-861f7616d084
master
Giel van Schijndel 2008-05-05 23:17:35 +00:00
parent 19b062a52a
commit b58d508ce6
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
lib/framework/frame.h
View File

@ -47,14 +47,17 @@
extern UDWORD selectedPlayer;
#define MAX_PLAYERS 8 /**< Maximum number of players in the game. */
/** Initialise the frame work library */
extern BOOL frameInitialise(
const char *pWindowName,// The text to appear in the window title bar
UDWORD width, // The display width
UDWORD height, // The display height
UDWORD bitDepth, // The display bit depth
BOOL fullScreen // Whether to start full screen or windowed
);
/** Initialise the framework library
* @param pWindowName the text to appear in the window title bar
* @param width the display widget
* @param height the display height
* @param bitDepth the display bit depth
* @param fullScreen whether to start full screen or windowed
*
* @return true when the framework library is successfully initialised, false
* when a part of the initialisation failed.
*/
extern BOOL frameInitialise(const char* pWindowName, UDWORD width, UDWORD height, UDWORD bitDepth, BOOL fullScreen);
extern bool selfTest;