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

Description: The Utilities API handles generic utility functions such executable file path, configuration file parsings, generic window settings, etc.
Special notes:  

Function List

Name XE_util_get_executable_file_path
Arguments char* file_path, int size
Return Type bool
Description Returns the application's executable file path

Parameters:
- file_path, the file path of the application
- size, the size of the destination buffer

Returns true if the destination buffer has been written successfully
Notes:  

Name XE_util_read_configuration_file
Arguments none
Return Type void
Description If called, it reads an XML configuration file (as shown in the GLUT example) to provide information such as application paths, external scene file (if any) and window dimensions.
The file is located in the Config folder with filename Config.xml.
Notes: This function should be called before XE_engine_create

Name XE_util_read_window_settings
Arguments bool& fullscreen, int& f_width, int& f_height, int& w_width, int& w_height
Return Type void
Description If a configuration file has been provided, this reads back the window information

Parameters:
- fullscreen, a flag indicating whether fullscreen is enabled
- f_width,the fullscreen viewport width
- f_height, the fullscreen viewport height
- w_width, the window width
- w_height, the window height
Notes: This function should be called before XE_engine_create

Name XE_util_read_scene_name
Arguments char* scene_name, int size
Return Type void
Description If a configuration file with a scene name has been provided, this reads back the file's name

Parameters:
- scene_name, a pointer to the scene name (if any)
- size, the size of the destination buffer

Returns true if a scene file name has been provided and the destination buffer has been written successfully
Notes:  


Last updated 27 May. 2013