Main Page
From eng
ENG (Eng is Not a Game) Documentation
ENG is a cross-platform event/object based C and SDL engine designed to manage many common application subsystems.
Features
- Initialisation, management and reconfiguration of an application's operating environment
- Command line option management
- Configuration file(s) data storage and retrieval
- Plain text file object definitions and image declarations
- Loading, the creation and freeing of objects and attached images
- Objects represented as linkable rectangles with some inheritable properties
- Object colour filling, image attaching and opacity for different events
- Effects that can be paused, unpaused, finalised and terminated
- A virtual mouse pointer with several operational modes
- Standard object events such as over, out, press, release, click and drag
- Engine events such as cycle, post load objects, post effect, quitting and shutdown
- Wrapped/unwrapped proportional/fixed width text writing to object images
- Extensive error checking and reporting with progress reports via standard out
Requirements
Licence
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007
ENG Application Structure
The developer creates an ENG_OpEnv structure that defines an application's operating environment, such as an objects file and image directory, canvas, screen and viewport dimensions and importantly a function that will receive events. The address of this structure is then passed to ENG_Init.
ENG_Init makes a copy of the ENG_OpEnv structure and initialises the engine. At this point the command line and configuration file subsystems become accessible to facilitate the modification of the operating environment before starting the engine with ENG_Start.
ENG_Start starts SDL, loads the objects file and places the engine into a loop which is responsible for generating events, timing, applying effects, rendering objects and updating the screen and is ultimately stopped by calling ENG_Quit.
Whilst the engine is running, communication with ENG is achieved via events sent to the application's event processor function. Objects are referenced with ENG_GetObject, configuration file options read with ENG_GetConfigOption, individual objects created with ENG_CreateObject, effects created with ENG_CreateEffect and the operating environment modified using the appropriate ENG_SetOpEnv* function.
ENG_Quit saves any currently declared configuration file to disk and then initiates a clean-up operation to free resources allocated to the various subsystems.
ENG API Reference
- ENG_OpEnv - Operating environment structure
- ENG_Init - Initialises ENG and its subsystems
- ENG_Start - Starts ENG and places the engine into a loop
- ENG_Quit - Quits ENG and frees allocated resources
- ENG_LoadObjects - Loads the objects file and creates the objects listed within it
- ENG_SetOpEnvImageDir - Sets the image directory used by ENG_LoadObjects
- ENG_SetOpEnvObjectsFile - Sets the objects file used by ENG_LoadObjects
- ENG_SetOpEnvConfigFile - Sets the configuration file used by the configuration file susbsystem
- ENG_SetOpEnvScreen - Sets the screen dimensions / video mode
- ENG_SetOpEnvCanvas - Sets the dimensions of the canvas
- ENG_SetOpEnvViewport - Sets the dimensions and position of the viewport
- ENG_SetOpEnvTitle - Sets the window manager title
- ENG_SetOpEnvFullScreen - Sets the fullscreen state
- ENG_SetOpEnvSystemPointer - Sets the system pointer visibility
MediaWiki Stuff
MediaWiki has been successfully installed.
Consult the User's Guide for information on using the wiki software.
Getting started
Project Logo
Click on the following image to upload a new version of the PNG logo image for your project:
