reflection_probe
A box the room around it was captured inside. A reflective surface within it mirrors that capture, aimed at the box, instead of the distant sky.
On this page
3d · render · 9 properties · 3D
A box the room around it was captured inside. A reflective surface within it mirrors that capture, aimed at the box, instead of the distant sky.
In a scene, reflection_probe is the node key that applies it. A script reaches each property below as a field on node.reflection_probe: reading one asks the running component, and assigning one leaves the rest alone. The whole table is node.reflection_probe.get() and node.reflection_probe.set(table).
Properties
| property | type | default | description |
|---|---|---|---|
capture_far |
float | 0 |
The farthest distance a capture draws, in world units; zero takes the camera's At least 0. |
capture_layers |
int | -1 |
Layer bitmask: a capture draws the nodes whose render_layers share a bit with it. Leave moving nodes off it and let ssr reflect them; -1 is every layer |
capture_near |
float | 0 |
The nearest distance a capture draws, in world units; with capture_far both above zero, else the camera's own planes At least 0. |
falloff |
float | 0.5 |
How wide the soft edge at the box's face is; a surface crossing it fades back to the sky At least 0. |
image |
string | — | Baked equirectangular image, project-relative. Empty captures the scene from the node's own position |
image_rotation_degrees |
float | 0 |
Turn of the captured map about y, in degrees |
intensity |
float | 1 |
Brightness of what the probe reflects At least 0. |
size |
vec3 | [10,10,10] |
The box this probe speaks for, in world units, centred on the node and turned with it. A node with a shader material still reads the box unturned At least 0. |
update_mode |
enum | once |
When a probe with no image captures the scene: once when placed or moved, or every frame. One capture draws the scene six times, at environment.probe_capture_size_pixels square One of once, always. |