Fgi
- Last UpdatedFeb 19, 2025
- 2 minute read
Use the Fgi node to load and save FGI files and to interact with their contents.
-
FGI nodes cannot be instantiated.
-
There is an unique predefined FGI node called FGI to interact with.
-
The presence of an HDR or an FGI node depends on the Gaphics.renderSetupFilePath option specified in the config.xml file.
-
Fgi cannot be loaded or modified at runtime for custom created Viewports . The Fgi node manages only the settings in DEFAULT_VIEWPORT.DEFAULT_SCENE_LAYER and (if in dualhead rendering) RIGHT_VIEWPORT.RIGHT_SCENE_LAYER.
Platform support
This node is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, and XR-Portable Android. It is partially supported on XR-P Hololens platform.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Full support |
Full support |
Full support |
Partial support |
|
|
|
|
|
|
FGI fields
The list of Fgi fields with their type and initial values is retrieved from the currently loaded FGI file. By default, the fgi_default.xml file is loaded.
Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > FGI
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
file |
sstring |
Optional |
Not set |
Name of the FGI file to load or save. |
|
load |
sevent |
Optional |
Not set |
Loads the file FGI content and displays it. |
|
regenerateFGIStates |
sfunction |
Optional |
Not set |
Regenerates the FGI states based on the current field values on the FGIState nodes |
|
save |
sevent |
Optional |
Not set |
Triggers the current FGI setting to save into defined file. |