ReflectionProbe

Inherits: VisualInstance < Spatial < Node < Object

Category: Core

Brief Description

Captures its surroundings to create reflections.

Enumerations

enum UpdateMode:

  • UPDATE_ONCE = 0
  • UPDATE_ALWAYS = 1

Description

Capture its surroundings as a dual parabolid image, and stores versions of it with increasing levels of blur to simulate different material roughnesses.

Property Descriptions

  • bool box_projection
Default false
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 1048575
Setter set_cull_mask(value)
Getter get_cull_mask()
  • bool enable_shadows
Default false
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.

Default Vector3( 1, 1, 1 )
Setter set_extents(value)
Getter get_extents()
Default 1.0
Setter set_intensity(value)
Getter get_intensity()

Defines the reflection intensity.

  • Color interior_ambient_color
Default Color( 0, 0, 0, 1 )
Setter set_interior_ambient(value)
Getter get_interior_ambient()
  • float interior_ambient_contrib
Default 0.0
Setter set_interior_ambient_probe_contribution(value)
Getter get_interior_ambient_probe_contribution()
  • float interior_ambient_energy
Default 1.0
Setter set_interior_ambient_energy(value)
Getter get_interior_ambient_energy()
  • bool interior_enable
Default false
Setter set_as_interior(value)
Getter is_set_as_interior()
Default 0.0
Setter set_max_distance(value)
Getter get_max_distance()
Default Vector3( 0, 0, 0 )
Setter set_origin_offset(value)
Getter get_origin_offset()
Default 0
Setter set_update_mode(value)
Getter get_update_mode()