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 Initialization API

Description: The Engine Initialization API is responsible for initializing important parameters for the engine's functionality (application, data and shader paths, configuration files, logging system, etc.)
Special notes: This API should be called before XE_engine_create

Function List

Name XE_init_add_application_path
Arguments char* path
Return Type void
Description Adds a path which points to the main folder of the application (a root folder or the .exe file).
More than one application paths can be set but it is not required
The relative data paths and shader paths will be set relative to this.

All internal file lookup functions are dependent on this information.

Parameters:
- path, a pointer to the path
Notes: This configuration can be set externally with the use of the configuration file

Name XE_init_add_data_path
Arguments char* path, bool is_relative_path
Return Type void
Description Adds a path which points to the location of the data
More than one data paths can be set since data can be stored in different locations

Parameters:
- path, a pointer to the path
- is_relative_path, a flag indicating whether this is a relative path (to the application path)
Notes: This configuration can be set externally with the use of the configuration file

Name XE_init_add_shader_path
Arguments char* path
Return Type void
Description Adds a path which points to the location of the shader files
More than one shader paths can be set since shader files can be stored in different locations

Parameters:
- path, a pointer to the path
Notes: This configuration can be set externally with the use of the configuration file

Name XE_init_set_logging_status
Arguments bool status
Return Type void
Description Sets whether engine events will be stored in the log file. The log file is stored under Log/XEngine_Log.txt in the main application folder

Parameters:
- status, whether logging is enabled (Default value is false)
Notes: This function should be called before XE_engine_create

Name XE_init_set_logging_filter
Arguments bool comments, bool warnings, bool events, bool errors
Return Type void
Description Sets the type of events that the log file will store
By default, only events are disabled

Parameters:
- comments, indicate simple notification messages (e.g. mesh loaded)
- warnings, indicate simple warning messages (e.g. texture not found)
- events, indicate event messages (e.g. button0down)
- errors, indicate serious error messages (e.g. could not load mesh file)
Notes: Unless explicitly needed, the default values should not be modified. Event messages are generated constantly per frame.

Last updated 27 May. 2013