ReflectionProbe¶
Inherits: VisualInstance3D < Node3D < Node < Object
Captures its surroundings to create reflections.
Description¶
Captures its surroundings as a cubemap, and stores versions of it with increasing levels of blur to simulate different material roughnesses.
The ReflectionProbe is used to create high-quality reflections at the cost of performance. It can be combined with VoxelGIs and Screen Space Reflections to achieve high quality reflections. ReflectionProbes render all objects within their cull_mask, so updating them can be quite expensive. It is best to update them once with the important static objects and then leave them.
Tutorials¶
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Enumerations¶
enum UpdateMode:
UPDATE_ONCE = 0 --- Update the probe once on the next frame. The corresponding radiance map will be generated over the following six frames. This is slower to update than UPDATE_ALWAYS but can result in higher quality reflections.
UPDATE_ALWAYS = 1 --- Update the probe every frame. This is needed when you want to capture dynamic objects. However, it results in an increased render time. Use UPDATE_ONCE whenever possible.
enum AmbientMode:
AMBIENT_DISABLED = 0
AMBIENT_ENVIRONMENT = 1
AMBIENT_COLOR = 2
Property Descriptions¶
Color ambient_color
Default |
|
Setter |
set_ambient_color(value) |
Getter |
get_ambient_color() |
float ambient_color_energy
Default |
|
Setter |
set_ambient_color_energy(value) |
Getter |
get_ambient_color_energy() |
AmbientMode ambient_mode
Default |
|
Setter |
set_ambient_mode(value) |
Getter |
get_ambient_mode() |
bool box_projection
Default |
|
Setter |
set_enable_box_projection(value) |
Getter |
is_box_projection_enabled() |
If true, enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera's location.
int cull_mask
Default |
|
Setter |
set_cull_mask(value) |
Getter |
get_cull_mask() |
Sets the cull mask which determines what objects are drawn by this probe. Every VisualInstance3D with a layer included in this cull mask will be rendered by the probe. It is best to only include large objects which are likely to take up a lot of space in the reflection in order to save on rendering cost.
bool enable_shadows
Default |
|
Setter |
set_enable_shadows(value) |
Getter |
are_shadows_enabled() |
If true, computes shadows in the reflection probe. This makes the reflection probe slower to render; you may want to disable this if using the UPDATE_ALWAYS update_mode.
Vector3 extents
Default |
|
Setter |
set_extents(value) |
Getter |
get_extents() |
The size of the reflection probe. The larger the extents, the more space covered by the probe, which will lower the perceived resolution. It is best to keep the extents only as large as you need them.
float intensity
Default |
|
Setter |
set_intensity(value) |
Getter |
get_intensity() |
Defines the reflection intensity. Intensity modulates the strength of the reflection.
bool interior
Default |
|
Setter |
set_as_interior(value) |
Getter |
is_set_as_interior() |
If true, reflections will ignore sky contribution.
float lod_threshold
Default |
|
Setter |
set_lod_threshold(value) |
Getter |
get_lod_threshold() |
float max_distance
Default |
|
Setter |
set_max_distance(value) |
Getter |
get_max_distance() |
Sets the max distance away from the probe an object can be before it is culled.
Vector3 origin_offset
Default |
|
Setter |
set_origin_offset(value) |
Getter |
get_origin_offset() |
Sets the origin offset to be used when this reflection probe is in box project mode.
UpdateMode update_mode
Default |
|
Setter |
set_update_mode(value) |
Getter |
get_update_mode() |
Sets how frequently the probe is updated. Can be UPDATE_ONCE or UPDATE_ALWAYS.