@@ -374,7 +383,7 @@ Sets display parameters to specified parameters. (called before CreateDisplay)
width | Desired width of screen or window. |
height | Desired height of screen or window. |
- bpp | Desired BPP for screen (generally use 32). |
+ bpp | Desired BPP for screen, generally use 8,16 or 32, pass -1 if you want ZEngine to guess the best choice. |
fullscreen | A bool for fullscreen setting. |
@@ -462,7 +471,7 @@ Set sound settings to specified parameters. (called before CreateDisplay)
|
-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 error if false is returned (returns bool in versions >= 0.8.2).
+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 error if false is returned (Trys not to fail + returns bool in versions >= 0.8.2).
- Parameters:
-
@@ -502,7 +511,66 @@ SetupDisplay and SetupSound should be called prior to this to change settings, s
Shut down SDL (and SDL_ttf,SDL_mixer if necessary) You shouldn't ever have to call this, ReleaseInstance calls this for you.
-
+
+
+
+
+
+
+ void ZE::ZEngine::ToggleFullscreen |
+ ( |
+ |
+ ) |
+ |
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+
+Safely toggles fullscreen/windowed mode, generally toggling modes will bring the need to reload images so it will set the ImagesNeedReload state to true. - Since:
- 0.8.2
+ |
+
+
+
+
+
+
+
+
+ bool ZE::ZEngine::Initialized |
+ ( |
+ |
+ ) |
+ |
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+
+Checks if ZEngine display has been properly setup. - Since:
- 0.8.2
+- Returns:
- Boolean status of ZEngine, true if CreateDisplay has been successfully called, false if ZEngine has no display.
+ |
+
+
+
@@ -531,7 +599,7 @@ Get pointer to screen SDL_Surface, allowing direct screen manipulation using SDL
|
-
+
@@ -559,7 +627,7 @@ Get pointer to screen SDL_Surface, allowing direct screen manipulation using SDL
Swap OpenGL buffers, and update screen, if a desired framerate is set it will delay to stay under that rate. Must be called every frame. |
-
+
@@ -617,7 +685,7 @@ Clears a rectangle on screen to a color, defaults to solid black.
|
-
+
@@ -645,7 +713,7 @@ Clears a rectangle on screen to a color, defaults to solid black.
|
-
+
@@ -679,7 +747,7 @@ Freeze everything for given number of milliseconds. - Parameter
|
-
+
@@ -708,7 +776,7 @@ Get active time since ZEngine i
|
-
+
-
+
-
+
@@ -793,7 +861,7 @@ Get double that describes the time passed between screen updates. (should be use
|
-
+
@@ -823,7 +891,7 @@ Get double representing current (approximate) FPS. This value is always the same
|
-
+
@@ -858,7 +926,7 @@ Sets desired framerate, if engine gets ahead of desired rate during a frame it w
|
-
+
@@ -888,7 +956,7 @@ Get desired framerate set by SetDesiredFramerate. - Since:<
|
-
+
@@ -917,7 +985,7 @@ Find out if engine timer is paused. - Returns:
- Paus
|
-
+
@@ -946,7 +1014,7 @@ Function to find out if application currently has focus. - Retu
|
-
+
@@ -974,7 +1042,7 @@ Function to find out if application currently has focus. - Retu
Tell the engine that it should behave as if a Quit was requested, does not call any shutdown functions.
|
-
+
@@ -999,11 +1067,11 @@ Tell the engine that it should behave as if a Quit was requested, does not call
|
-Function to find out if user or operating system has requested program cease execution, can be set by Alt-F4, SDL_Quit event or ZEngine::RequestQuit(). - Returns:
- bool telling if quit has been requested.
+Function to find out if user or operating system has requested program cease execution, can be set by Alt-F4, SDL_Quit event or ZEngine::RequestQuit(). - Returns:
- bool telling if quit has been requested.
|
-
+
@@ -1037,7 +1105,7 @@ Function to find out if user or operating system has requested program cease exe
|
-
+
@@ -1066,7 +1134,7 @@ Function that is good to call every frame to check if images should be reloaded,
|
-
+
@@ -1102,7 +1170,7 @@ Calls SDL_EnableKeyRepeat(rate,rate) because usually this is the desired movemen
|
-
+
@@ -1137,7 +1205,7 @@ Function returns true/false based on if key is currently pressed or not.
|
-
+
@@ -1172,7 +1240,7 @@ Function returns true/false based on if key has been pressed since last check. <
|
-
+
@@ -1200,7 +1268,7 @@ Function returns true/false based on if key has been pressed since last check. <
Hide the system mouse cursor. |
-
+
@@ -1228,7 +1296,7 @@ Hide the system mouse cursor. |
Show the system mouse cursor.
-
+
@@ -1257,7 +1325,7 @@ Find X Position of Mouse on screen. - Returns:
- X Po
|
-
+
@@ -1286,7 +1354,7 @@ Find Y Position of Mouse on screen. - Returns:
- Y Po
|
-
+
@@ -1315,7 +1383,7 @@ Get pressed status of left button of mouse. - Returns:
|
-
+
@@ -1344,7 +1412,7 @@ Get pressed status of right button of mouse. - Returns:
|
-
+
@@ -1379,7 +1447,7 @@ Return status of mouse in current rectangle (used for buttons) - <
|
-
+
@@ -1407,6 +1475,41 @@ Return status of mouse in current rectangle (used for buttons) - <
Cycle through event queue, processing events, updating all Event Related variables, should be called once per frame.
|
+
+
+
+
+
+
+ void ZE::ZEngine::SetEventFilter |
+ ( |
+ SDL_EventFilter |
+ filter |
+ ) |
+ |
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+
+This is only needed when you need tight control with ZEngine. The parameter is simply passed to SDL_SetEventFilter, generally only those with a good amount of SDL experience should use this function or ZEngine's internal message state could be corrupted. For more information on SDL_SetEventFilter see http://sdldoc.csn.ul.ie/sdlseteventfilter.php. - Since:
- 0.8.2
+- Parameters:
-
+
+ filter | An SDL_EventFilter (A function that takes a const SDL_Event* and returns 0 if the event should be removed from the event queue and 1 otherwise.) |
+
+
+ |
+
+
@@ -1442,7 +1545,7 @@ Writes error to current error file. - Since:
- 0.8.2
-
+
@@ -1487,7 +1590,7 @@ Change the way errors are logged and the file they are logged to, before calling
|
-
+
@@ -1546,7 +1649,7 @@ Adds the error to the the error queue, and sets the current error to this error.
|
-
+
@@ -1576,7 +1679,7 @@ Get the last error reported. - Since:
- 0.8.2
|
-
+
@@ -1611,7 +1714,7 @@ Write a string to the log, allowing special usage of the error log.
|
-
+
@@ -1640,7 +1743,7 @@ Write the error stack to the error log. - Since:
- 0.
|
-
+
@@ -1675,7 +1778,7 @@ Loads an Image to an ImageData class which keeps vital information on the Image.
|
-
+
@@ -1710,7 +1813,7 @@ Loads a Sound to a SoundData class which keeps vital information on the Sound
|
-
+
@@ -1745,7 +1848,7 @@ Loads a Music Clip to a MusicData class which keeps vital information on the Mus
|
-
+
@@ -1790,7 +1893,7 @@ Loads a Font to a FontData class which keeps vital information on the Font
|
-
+
@@ -1819,7 +1922,7 @@ Get Width of Window or Fullscreen mode. - Returns:
-
|
-
+
@@ -1848,7 +1951,7 @@ Get Height of Window or Fullscreen mode. - Returns:
-
|
-
+
@@ -1877,7 +1980,7 @@ Get BPP of Window or Fullscreen mode. - Returns:
- BP
|
-
+
@@ -1908,7 +2011,7 @@ Get Fullscreen setting of Display. - Returns:
- True
|
The documentation for this class was generated from the following files:
- Generated on Sun Jan 19 01:04:50 2003 for ZEngine by
+ Generated on Tue Jan 28 16:31:29 2003 for ZEngine by
1.3-rc2
diff --git a/doc/html/classZE_1_1ZError-members.html b/doc/html/classZE_1_1ZError-members.html
index c285ffa..c0cea45 100755
--- a/doc/html/classZE_1_1ZError-members.html
+++ b/doc/html/classZE_1_1ZError-members.html
@@ -9,6 +9,8 @@
ZE::ZError Member ListThis is the complete list of members for ZE::ZError, including all inherited members. Generated on Sun Jan 19 01:04:50 2003 for ZEngine by
+ Generated on Tue Jan 28 16:31:29 2003 for ZEngine by
1.3-rc2
diff --git a/doc/html/classZE_1_1ZError.html b/doc/html/classZE_1_1ZError.html
index b9b916e..cf6be8c 100755
--- a/doc/html/classZE_1_1ZError.html
+++ b/doc/html/classZE_1_1ZError.html
@@ -23,6 +23,11 @@
| Get ZErrorCode of error.
|
string | LogString () const |
| Get formatted string for log file.
|
+
Static Public Methods |
+void | CreateStringTable () |
+ | Construct string table for error strings.
|
+void | DestroyStringTable () |
+ | Destroy string table of error strings.
|
Protected Attributes |
ZErrorCode | rCode |
@@ -37,8 +42,9 @@ string
| rLine |