Main Page | Namespace List | Class List | File List | Class Members | File Members

NGT_Engine Class Reference

NGT Engine main class. More...

#include <engine_base.h>

List of all members.

Public Member Functions

void initialize (SDL_Surface *&surf)
 Initialize the Engine.
void finalize ()
 Finalize the Engine.

Public Attributes

int video_res_h
 Horizontal resolution.
int video_res_w
 Vertical resolution.
int video_bpp
 Screen depth (bits per pixel).
int input_joy_enabled
 Enable or disable joysticks.
int input_show_cursor
 Show or hide the mouse cursor.
int audio_frequency
 Sound frequency.
int audio_buffer
 Sound buffer.
int audio_mode
 Sound playback mode.
int machine_target
 Target hardware.


Detailed Description

NGT Engine main class.

This class provides the methodes and attributes to initialize the engine and work with its components.

Definition at line 43 of file engine_base.h.


Member Function Documentation

void NGT_Engine::finalize  ) 
 

Finalize the Engine.

This must be done before closing the app or the game to finalize all the susystems of the toolkit.

Definition at line 77 of file engine_base.cpp.

References machine_target, NGT_MACHINE_GENERIC, and NGT_MACHINE_GP2X.

void NGT_Engine::initialize SDL_Surface *&  surf  ) 
 

Initialize the Engine.

This must be done before using any other function of the engine.

Definition at line 11 of file engine_base.cpp.

References audio_buffer, audio_frequency, audio_mode, machine_target, NGT_MACHINE_GENERIC, NGT_MACHINE_GP2X, video_bpp, video_res_h, and video_res_w.


Member Data Documentation

int NGT_Engine::audio_buffer
 

Sound buffer.

Sets the size of the buffer used by SDL_Mixer.
Refer to SDL_Mixer documentation for accepted values.

Definition at line 85 of file engine_base.h.

Referenced by initialize().

int NGT_Engine::audio_frequency
 

Sound frequency.

Sets the frequency for the sound system (SDL_Mixer).
Refer to SDL_Mixer documentation for accepted values.

Definition at line 79 of file engine_base.h.

Referenced by initialize().

int NGT_Engine::audio_mode
 

Sound playback mode.

Sets the playback mode used by SDL_Mixer.
Refer to SDL_Mixer documentation for accepted values.

Definition at line 91 of file engine_base.h.

Referenced by initialize().

int NGT_Engine::input_joy_enabled
 

Enable or disable joysticks.

Enables or disables the joystick support.

POSSIBLE VALUES:
  1. 0: Disable using joysticks.
  2. 1: Enable using joysticks.

Definition at line 63 of file engine_base.h.

int NGT_Engine::input_show_cursor
 

Show or hide the mouse cursor.

Show or hide the mouse cursor in the screen.

  • POSSIBLE VALUES:
  1. 0: Hide the mouse cursor.
  2. 1: Show the mouse cursor..

Definition at line 71 of file engine_base.h.

int NGT_Engine::machine_target
 

Target hardware.

Specify the machine (hardware) in which the application/game is designed for.

  • POSSIBLE VALUES:
  1. NGT_MACHINE_GENERIC : Standard. Ideal for over 99% machines.
  2. NGT_MACHINE_GP2X : Specific for the GamePark Holdgings GP2X Portable Media Player.

Definition at line 102 of file engine_base.h.

Referenced by finalize(), and initialize().

int NGT_Engine::video_bpp
 

Screen depth (bits per pixel).

Definition at line 51 of file engine_base.h.

Referenced by initialize().

int NGT_Engine::video_res_h
 

Horizontal resolution.

Definition at line 47 of file engine_base.h.

Referenced by initialize().

int NGT_Engine::video_res_w
 

Vertical resolution.

Definition at line 49 of file engine_base.h.

Referenced by initialize().


The documentation for this class was generated from the following files:
Generated on Wed Feb 1 00:07:08 2006 for Neopntec Gaming Toolkit - API reference by  doxygen 1.4.4