FgiProbe
- Last UpdatedFeb 19, 2025
- 2 minute read
An FgiProbe is used to calculate lighting in the FGI rendering pipeline.
-
A scene can have 1 to n probes.
-
A scene must have one and one only probe signed as main.
Platform support
This node is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-Portable WASM platforms.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Full support |
Full support |
Full support |
Full support |
|
|
|
|
|
|
Code example
This is a code example for the FgiProbe node.
<FgiProbe name="main" templateInfo="FgiProbe|main" position="0 6.580003 0" radius="300" mainProbe="true"/>
FgiProbe fields
These are the fields for FgiProbe node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > FgiProbe
|
Parameter |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
_debug |
sbool |
Optional |
false |
Enables probe visualization in 3D debug mode. |
|
farPlane |
sfloat |
Optional |
1.5 |
Objects below this distance are excluded in the probe data calculation. This does not mean they do not receive contributions from this probe. |
|
mainProbe |
sbool |
Optional |
false |
Must be set to true to one and only one probe in the scene. |
|
nearPlane |
sfloat |
Optional |
300 |
Objects above this distance are excluded in the probe data calculation. This does not mean they do not receive contributions from this probe. |
|
radius |
sfloat |
Optional |
10 |
Probe influence radius. Only objects falling inside the radius are influenced by the probe. |