Engine API

Home About XEngine Engine API SceneGraph Changelog Programming Guide

Index

| Configuration API | Device API | Engine Initialization API | Engine Management API | Settings API | Timer API | Utilities API |

Engine Management API

Description: The Engine Management API defines the entry points for the engine's core functions such as creation, initialization, render, idle, resize and destruction.
Special notes:

Function List

Name XE_engine_create
Arguments none
Return Type bool
Description This function is responsible for initializing all internal engine pointers, memory allocations and log files
It also initializes the engine's scene graph which contains only a root node.
An external configuration scene file can also be set, for minimizing code and increasing portability.

glewInit is also called here.

Returns true if create was successful.
Notes: The logging parameters and the application paths should be set before calling XE_engine_create. This is because the logger is disabled by default and the paths are used for locating shader data paths.

Name XE_engine_initialize
Arguments int width, int height
Return Type bool
Description This function is called after create and after the initial graph nodes have been provided.
The devices, shaders and internal engine configuration is initialized here.

Parameters:
- width, the initial glViewport width
- height, the initial glViewport height

Returns true if initialize was successful.
Notes:

Name XE_engine_render
Arguments none
Return Type bool
Description This function initiates the XEngine rendering pipeline. All the elements that have been provided are being rendered.

Returns true if render was successful.
Notes:

Name XE_engine_update
Arguments none
Return Type bool
Description Update is being called after render in order to uptdfirst the internal engine configuration (scenegraph nodes, matrices, animations, etc).

Returns true if update was successful.
Notes:

Name XE_engine_resize
Arguments int width, int height
Return Type bool
Description Resize updates the viewport and the associated buffers to the new dimensions

Parameters:
- width, the updated glViewport width
- height, the updated glViewport height

Return true if resize was successful.
Notes:

Name XE_engine_destroy
Arguments none
Return Type bool
Description This function is called upon destruction in order to deallocate all allocated memory. Avoiding this results in numerous memory leaks.

Return true if destroy was successful.
Notes:

Last updated 27 May. 2013