Inherits: VisualInstance < Spatial < Node < Object
Real-time global illumination (GI) probe.
GIProbe
s are used to provide high-quality real-time indirect light to scenes. They precompute the effect of objects that emit light and the effect of static geometry to simulate the behavior of complex light in real-time. GIProbe
s need to be baked before using, however, once baked, dynamic objects will receive light from them. Further, lights can be fully dynamic or baked.
Having GIProbe
s in a scene can be expensive, the quality of the probe can be turned down in exchange for better performance in the ProjectSettings using ProjectSettings.rendering/quality/voxel_cone_tracing/high_quality.
float | bias | 1.5 |
bool | compress | false |
GIProbeData | data | |
int | dynamic_range | 4 |
float | energy | 1.0 |
Vector3 | extents | Vector3( 10, 10, 10 ) |
bool | interior | false |
float | normal_bias | 0.0 |
float | propagation | 0.7 |
Subdiv | subdiv | 1 |
void | bake ( Node from_node=null, bool create_visual_debug=false ) |
void | debug_bake ( ) |
enum Subdiv:
Default | 1.5 |
Setter | set_bias(value) |
Getter | get_bias() |
Offsets the lookup of the light contribution from the GIProbe
. This can be used to avoid self-shadowing, but may introduce light leaking at higher values. This and normal_bias should be played around with to minimize self-shadowing and light leaking.
Note: bias
should usually be above 1.0 as that is the size of the voxels.
Default | false |
Setter | set_compress(value) |
Getter | is_compressed() |
If true
, the data for this GIProbe
will be compressed. Compression saves space, but results in far worse visual quality.
Setter | set_probe_data(value) |
Getter | get_probe_data() |
The GIProbeData resource that holds the data for this GIProbe
.
Default | 4 |
Setter | set_dynamic_range(value) |
Getter | get_dynamic_range() |
The maximum brightness that the GIProbe
will recognize. Brightness will be scaled within this range.
Default | 1.0 |
Setter | set_energy(value) |
Getter | get_energy() |
Energy multiplier. Makes the lighting contribution from the GIProbe
brighter.
Default | Vector3( 10, 10, 10 ) |
Setter | set_extents(value) |
Getter | get_extents() |
The size of the area covered by the GIProbe
. If you make the extents larger without increasing the subdivisions with subdiv, the size of each cell will increase and result in lower detailed lighting.
Default | false |
Setter | set_interior(value) |
Getter | is_interior() |
If true
, ignores the sky contribution when calculating lighting.
Default | 0.0 |
Setter | set_normal_bias(value) |
Getter | get_normal_bias() |
Offsets the lookup into the GIProbe
based on the object's normal direction. Can be used to reduce some self-shadowing artifacts.
Default | 0.7 |
Setter | set_propagation(value) |
Getter | get_propagation() |
How much light propagates through the probe internally. A higher value allows light to spread further.
Default | 1 |
Setter | set_subdiv(value) |
Getter | get_subdiv() |
Number of times to subdivide the grid that the GIProbe
operates on. A higher number results in finer detail and thus higher visual quality, while lower numbers result in better performance.
Bakes the effect from all GeometryInstances marked with GeometryInstance.use_in_baked_light and Lights marked with either Light.BAKE_INDIRECT or Light.BAKE_ALL. If create_visual_debug
is true
, after baking the light, this will generate a MultiMesh that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the GIProbe
's data and debug any issues that may be occurring.
Calls bake with create_visual_debug
enabled.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_giprobe.html