Fixed documentation in ZEngine.
This commit is contained in:
parent
c9da45f407
commit
3d6077a474
@ -13,7 +13,7 @@
|
|||||||
File: ZE_ZEngine.h <br>
|
File: ZE_ZEngine.h <br>
|
||||||
Description: Header file for ZEngine class, the core of the ZEngine. <br>
|
Description: Header file for ZEngine class, the core of the ZEngine. <br>
|
||||||
Author(s): James Turk <br>
|
Author(s): James Turk <br>
|
||||||
$Id: ZE_ZEngine.h,v 1.18 2003/01/27 04:33:34 cozman Exp $<br>
|
$Id: ZE_ZEngine.h,v 1.19 2003/02/02 23:30:15 cozman Exp $<br>
|
||||||
|
|
||||||
\file ZE_ZEngine.h
|
\file ZE_ZEngine.h
|
||||||
\brief Definition file for core ZEngine class.
|
\brief Definition file for core ZEngine class.
|
||||||
@ -128,7 +128,7 @@ class ZEngine
|
|||||||
/*!
|
/*!
|
||||||
\brief Initialize Sound for SDL.
|
\brief Initialize Sound for SDL.
|
||||||
|
|
||||||
Set sound settings to specified parameters. (called before CreateDisplay)
|
Set sound settings to specified parameters. (If not called before CreateDisplay rate will default to 22050+mono)
|
||||||
|
|
||||||
\param rate Desired sound bitrate.
|
\param rate Desired sound bitrate.
|
||||||
\param stereo A bool for stereo setting.
|
\param stereo A bool for stereo setting.
|
||||||
@ -140,7 +140,7 @@ class ZEngine
|
|||||||
\brief Create Display with predefined settings.
|
\brief Create Display with predefined settings.
|
||||||
|
|
||||||
SetupDisplay and SetupSound should be called prior to this to change settings, settings from those do not go into effect
|
SetupDisplay and SetupSound should be called prior to this to change settings, settings from those do not go into effect
|
||||||
until this function is called. Specify no icon file to use default icon. Returns result of setting up ZEngine, and logs
|
until this function is called. Specify no icon file to use default icon for OS. Returns result of setting up ZEngine, and logs
|
||||||
error if false is returned (Trys not to fail + returns bool in versions >= 0.8.2).
|
error if false is returned (Trys not to fail + returns bool in versions >= 0.8.2).
|
||||||
|
|
||||||
\param title Window Title.
|
\param title Window Title.
|
||||||
|
@ -13,7 +13,7 @@
|
|||||||
File: ZE_ZEngine.cpp <br>
|
File: ZE_ZEngine.cpp <br>
|
||||||
Description: Implementation source file for ZEngine library main singleton class. <br>
|
Description: Implementation source file for ZEngine library main singleton class. <br>
|
||||||
Author(s): James Turk <br>
|
Author(s): James Turk <br>
|
||||||
$Id: ZE_ZEngine.cpp,v 1.26 2003/01/30 04:02:01 cozman Exp $<br>
|
$Id: ZE_ZEngine.cpp,v 1.27 2003/02/02 23:30:15 cozman Exp $<br>
|
||||||
|
|
||||||
\file ZE_ZEngine.cpp
|
\file ZE_ZEngine.cpp
|
||||||
\brief Central source file for ZEngine.
|
\brief Central source file for ZEngine.
|
||||||
@ -31,9 +31,9 @@ ZEngine *ZEngine::sInstance=NULL;
|
|||||||
ZEngine::ZEngine()
|
ZEngine::ZEngine()
|
||||||
{
|
{
|
||||||
mInitialized = false;
|
mInitialized = false;
|
||||||
mWidth = 640;
|
mWidth = 800;
|
||||||
mHeight = 480;
|
mHeight = 600;
|
||||||
mBPP = 16;
|
mBPP = -1;
|
||||||
mFullscreen = true;
|
mFullscreen = true;
|
||||||
|
|
||||||
#ifdef USE_SDL_MIXER
|
#ifdef USE_SDL_MIXER
|
||||||
@ -193,7 +193,6 @@ bool ZEngine::CreateDisplay(string title, string icon)
|
|||||||
if(!mInitialized) //only set these settings the first time
|
if(!mInitialized) //only set these settings the first time
|
||||||
{
|
{
|
||||||
//Default window manager settings//
|
//Default window manager settings//
|
||||||
SDL_EnableKeyRepeat(30,30);
|
|
||||||
if(!icon.length())
|
if(!icon.length())
|
||||||
SDL_WM_SetCaption(title.c_str(),NULL);
|
SDL_WM_SetCaption(title.c_str(),NULL);
|
||||||
else
|
else
|
||||||
|
Loading…
Reference in New Issue
Block a user