Scene parameters
- Last UpdatedMar 12, 2025
- 4 minute read
This topic describes Scene parameters for the config.xml application configuration file.
Scene
The Scene section contains all the configuration parameters used to configure the logic layer of the AVEVA™ XR engine.
Language selection
The AVEVA™ XR Framework supports localized contents. When using the localization system, developers can define from one to any number of supported languages. Each language option will host the translation for each entry in the localized contents dictionary.
The Scene.lang parameter enables you to select the language. By default, the available selection options are English and Italian.
The configuration tool uses a combo-box selector. Therefore, to use an alternative language, you must provide the combo constraint with the list of all the languages that need to be supported. Do this by manually editing the configuration file. The selected languages must also be defined into the localization system of the corresponding project.
Example: constraints="combo:English=en,Italian=it" -> constraints="combo:English=en,French=fr"
Managing FPS targets
The sub-section scene.fps enables you to modify the rendering behavior of the AVEVA™ XR engine and effects performance. Managing these parameters requires an advanced knowledge of the engine behavior and providing unreachable targets may decrease the overall performance.
For more information, see Supported render paths.
Scene parameters
This is a list of Scene parameters for the config.xml application configuration file.
|
Parameter |
Type |
Support for Windows platform |
Support for Portable platforms |
Description |
|---|---|---|---|---|
|
logic |
sstring |
Yes |
Yes |
This is the path of the first logic file to load. By default, this is set to ./GameData/Logic/main.xml. All other logic files are loaded according to the 'include' statements found in the scripts code. |
|
debug |
sbool |
Yes |
No |
Enables/disables access to Debug and Log panels in realtime. The panels display when starting the application. If closed, they can be reopened by pressing F10. Scene.debug configuration is used only when the application starts in windowed mode with a development license. The Log and Debug panels are not accessible from applications that start in fullscreen. |
|
lang |
sstring |
Yes |
Yes |
Specifies the language used by the application. All text defined in the localization will change accordingly. |
|
pak |
sstring |
Yes |
Yes |
The name of the application data PAK to load. The application data PAK is created when packing the application to deliver. |
|
additionalConf |
sstring |
Yes |
Yes |
Additional product configuration files. Lists other configuration type files that the AVEVA™ XR engine has to load in addition to config.xml and custom.xml. |
|
maxVisiblePopupTrends |
sint |
Yes |
No |
Maximum number of visible trend pop-ups. |
|
profiling |
sbool |
Yes |
No |
Enables/disables Realtime Scene Profiling functionalities that can be accessed from Debug panel. |
|
quitWithESC |
Yes |
No |
Enables/disables application exiting triggered by the ESC key on the keyboard. |
|
|
renderTexturesOnRenderDisabled |
sbool |
Yes |
Yes |
If enabled and render is disabled, textures will keep being updated. If disabled, textures updates are put on hold until render is enabled. |
|
fps |
Yes |
This section is important as it enables you to customize the rendering loop behavior and performances. These settings require knowledge about engine rendering behavior and should be managed with care. |
||
|
game |
sint |
Yes |
No |
Target FPS for (game) logic. |
|
render |
sint |
Yes |
No |
Target FPS of render. |
|
type |
sstring |
Yes |
No |
Framerate type can be specified as static or adaptive. With static (game) logic and render are executed in sequence targeting fps.render value. With adaptive (game) logic and render are executed in parallel with each one targeting its own FPS. Adaptive rendering requires more data synchronization and this can impact performance. A special cloud case is also accepted and it is designed for SDK users. It's not exposed through combobox constraints in config.xml, but can be manually set on the XML file. This configuration is a special case of static configuration with additional disabling of VR stereo modes, overriding of Scene.fps.useTimers to false, overriding of Scene.capture.enable to false and overriding of Scene.fps.threadPriority to normal. |
|
useTimers |
sbool |
Yes |
No |
Enables/disables use of Windows timers for rendering and game loops. |
|
threadPriority |
sstring |
Yes |
No |
This configuration is usually not shown on config.xml files because it’s an advanced feature designed mainly for SDK users. The default value is Highest and it should be the most suitable one for on-premises usage. On Virtual Machines with limited CPU resources, it’s possible to override this value with any entry corresponding to the enum of .NET API System.Thread.ThreadPriority:
|
|
capture |
Yes |
Yes |
Enables you to customize the screen capturing functionalities that can be managed from the Debug panel. The capturing system will save a sequence of screen images to be used later by a video editing software and compiled as a movie. Audio is not recorded. |
|
|
enable |
sbool |
Yes |
Yes |
Enables/disables capturing of video. |
|
fps |
sint |
Yes |
No |
Capture framerate. If the framerate is Static, the system will capture the specified number of screens in a second. |
|
path |
sstring |
Yes |
No |
The path to store the captured images. |
|
preventDefaultAppClosing |
Yes |
No |
If enabled, the app will not be closed when triggering a close intent by clicking the window bar close button, the windows start bar close button, or the Alt+F4 keyboard shortcut. Instead, the global.userAppCloseInvoked event is raised. The app logic will be responsible for providing a closing mechanism to close the app by using the script exit command. |