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

Description: The Settings API handles engine settings such as scene ambient color, background color, ambient occlusion status and parameters, global illumination settings, etc.
Special notes:  

Function List

Name XE_settings_set_ambient_color
Arguments float r, float g, float b
Return Type void
Description Sets the global ambient color

Parameters:
- r, the Red value
- g, the Green value
- b, the Blue value
Notes:  

Name XE_settings_get_ambient_color
Arguments float& r, float& g, float& b
Return Type void
Description Retrieves the global ambient color

Parameters:
- r, the Red value
- g, the Green value
- b, the Blue value
Notes:  

Name XE_settings_set_background_color
Arguments float r, float g, float b
Return Type void
Description Sets the background color

Parameters:
- r, the Red value
- g, the Green value
- b, the Blue value
Notes:  

Name XE_settings_get_background_color
Arguments float& r, float& g, float& b
Return Type void
Description Retrieves the background color

Parameters:
- r, the Red value
- g, the Green value
- b, the Blue value
Notes:  

Name XE_settings_set_AO_status
Arguments bool status
Return Type void
Description Sets whether AO is enabled/disabled

Parameters:
- status, a flag indicating whether AO is enabled (Default is enabled)
Notes:  

Name XE_settings_get_AO_status
Arguments bool& status
Return Type void
Description Retrieves the AO status

Parameters:
- status, a flag indicating whether AO is enabled
Notes:  

Name XE_settings_set_AO_method
Arguments XE_AO_TYPE ao_type
Return Type void
Description Sets the AO method (as provided in the XE_AO_TYPE enum)

Parameters:
- ao_type, the AO method (Default is Alchemy AO)
Notes: enum XE_AO_TYPE
{
AT_SSAO = 0,
AT_SSAO_HORIZON_SPLIT,
AT_SSAO_ALCHEMY,
AT_SSAO_VOLUMETRIC_OBSCURANCE,
AT_NONE
};

Name XE_settings_get_AO_method
Arguments XE_AO_TYPE& ao_type
Return Type void
Description Retrieves the AO method (as provided in the XE_AO_TYPE enum)

Parameters:
- ao_type, the AO method
Notes: enum XE_AO_TYPE
{
AT_SSAO = 0,
AT_SSAO_HORIZON_SPLIT,
AT_SSAO_ALCHEMY,
AT_SSAO_VOLUMETRIC_OBSCURANCE,
AT_NONE
};

Name XE_settings_set_AO_blur_status
Arguments bool status
Return Type void
Description Sets whether AO blur is enabled/disabled

Parameters:
- status, a flag indicating whether AO blurring is enabled (Default is enabled)
Notes:  

Name XE_settings_get_AO_blur_status
Arguments bool& status
Return Type void
Description Retrieves the AO blur status

Parameters:
- status, a flag indicating whether AO blurring is enabled
Notes:  

Name XE_settings_set_HBAO_num_samples
Arguments int num_samples
Return Type void
Description Sets the Horizon Based Ambient Occlusion method's (HBAO) number of samples

Parameters:
- num_samples, the number of HBAO samples (Default is 4)
Notes:  

Name XE_settings_get_HBAO_num_samples
Arguments int& num_samples
Return Type void
Description Retrieves the Horizon Based Ambient Occlusion method's (HBAO) number of samples

Parameters:
- num_samples, the number of HBAO samples
Notes:  

Name XE_settings_set_HBAO_num_slices
Arguments int num_slices
Return Type void
Description Sets the Horizon Based Ambient Occlusion method's (HBAO) number of slices

Parameters:
- num_slices, the number of HBAO slices (Default is 4)
Notes:  

Name XE_settings_get_HBAO_num_slices
Arguments int& num_slices
Return Type void
Description Retrieves the Horizon Based Ambient Occlusion method's (HBAO) number of slices

Parameters:
- num_slices, the number of HBAO samples
Notes:  

Name XE_settings_set_AO_range
Arguments float range
Return Type void
Description Sets the AO range

Parameters:
- range, the AO range (Default is 0.5)
Notes:  

Name XE_settings_get_AO_range
Arguments float& range
Return Type void
Description Retrieves the AO range

Parameters:
- range, the AO range
Notes:  

Name XE_settings_set_AO_range_inc
Arguments float range_inc
Return Type void
Description Sets the AO range increment

Parameters:
- range_inc, the AO range increment (Default is 0.1)
Notes:  

Name XE_settings_get_AO_range_inc
Arguments float& range_inc
Return Type void
Description Retrieves the AO range increment

Parameters:
- range_inc, the AO range increment
Notes:  

Name XE_settings_set_AO_multiview_status
Arguments bool multiview_status
Return Type void
Description Sets whether AO multiview is enabled/disabled

Parameters:
- multiview_status, the AO multiview status (Default is disabled)
Notes: The Multiview-AO type is the same as the AO type. Note: HBAO and VO are available in Multiview-AO

Name XE_settings_get_AO_multiview_status
Arguments bool& multiview_status
Return Type void
Description Retrieves the AO multiview is enabled/disabled

Parameters:
- multiview_status, the AO multiview status
Notes:  

Name XE_settings_AO_multiview_register_view
Arguments int light_node_id
Return Type void
Description Registers a view for Multiview AO (e.g. a light source)

Parameters:
- light_node_id, the node_id of the light to add to the multiview AO calculations
Notes:  

Name XE_settings_zoom_to_extents
Arguments int node_id
Return Type void
Description Zooms the current camera to the extents of the specified node_id (-1 is considered the whole scene)

Parameters:
- node_id, the node_id of the node's bounding box the zoom will occur (-1 is the whole scene)
Notes:  

Last updated 27 May. 2013