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

Description: The Configuration API is responsible for setting a default configuration for certain scene conditions in order to:
- provide a fixed environment with predefined settings
- minimize code
Special notes: This API should be called before XE_engine_initialize

Function List

Name XE_configuration_create_default_light_rig
Arguments bool follow_active_camera
Return Type void
Description Default light rig 1:
Ambient color: 0.15, 0.15, 0.15
Background color: 0.1, 0.1, 0.1
This is a three point light configuration:
- A key light is positioned 20 degrees on the left of the camera (based on the up vector)
- A fill light is positioned 60 degrees on the right and 30 degrees up from the camera position (based on the up and right vectors)
- A back light is positioned opposite the camera and 40 degrees up (based on the right vector)
All lights point to the center of the scene's bounding box
All lights can be set to constantly update their location based on the position of the current camera
The light's position (in the specified direction) and near-far ranges are being updated in order to provide the best coverage between the scene and the shadow maps.

Parameters:
- follow_active_camera, a flag indicating whether the lights' directions will be updated as the camera is moving
Notes: This function should be called before XE_engine_initialize

Name XE_configuration_create_default_sun_light_rig
Arguments bool follow_active_camera
Return Type void
Description Default light rig 2:
Ambient color: 0.15, 0.15, 0.15
Background color: 0.2, 0.2, 0.2
This is a four point light outdoor configuration:
- A sun light is positioned 50 degrees above the camera (an explicit sun light position can also be set)
- Two ovehead lights are positioned 120 degrees and 240 degrees from the current sun light position
- A bottom low intensity fill light is positioned 50 degrees below the camera
All lights point to the center of the scene's bounding box
All lights can be set to constantly update their location based on the position of the current camera
The light's position (in the specified direction) and near-far ranges are being updated in order to provide the best coverage between the scene and the shadow maps.

Parameters:
- follow_active_camera, a flag indicating whether the lights' directions will be updated as the camera is moving
Notes: This function should be called before XE_engine_initialize

Name XE_configuration_default_sun_light_rig_set_sun_position
Arguments float x, float y, float z
Return Type void
Description Sets the explicit sun light position for the outdoor lighting configuration

Parameters:
- x, the sun light's x value in world coordinates
- y, the sun light's y value in world coordinates
- z, the sun light's z value in world coordinates
Notes:  

Name XE_configuration_create_default_camera
Arguments none
Return Type void
Description A default camera configuration is also provided:
This configuration creates a default camera, user and input node with the following settings:
User Name: default_user
User Position: 0,0,10
User Target: 0,0,-1
User Linear Speed: 3
User Angular Speed: 1
Camera Name: default_camera
Camera aperture: 60 degrees
Camera Near Range: 1
Camera Far Range: 500
Input Name: default_input
The camera near and far range are being updated per frame in order to fit the current viewing frustum
Notes: This function should be called before XE_engine_initialize

Last updated 3 Jun. 2013