UpdateMode

Types

• enum AmbientMode

Type members

• class var godotClassName: StringName

Instance members

• var ambientColor: Color

  The custom ambient color to use within the ReflectionProbe’s box defined by its size. Only effective if ambientMode is .ambientColor.

• var ambientColorEnergy: Double

  The custom ambient color energy to use within the ReflectionProbe’s box defined by its size. Only effective if ambientMode is .ambientColor.

• var ambientMode: ReflectionProbe.AmbientMode

  The ambient color to use within the ReflectionProbe’s box defined by its size. The ambient color will smoothly blend with other ReflectionProbes and the rest of the scene (outside the ReflectionProbe’s box defined by its size).

• var boxProjection: Bool

  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.

• var cullMask: UInt32

  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. To improve performance, it is best to only include large objects which are likely to take up a lot of space in the reflection.

• var enableShadows: Bool

  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 .updateAlways updateMode.

• var intensity: Double

  Defines the reflection intensity. Intensity modulates the strength of the reflection.

• var interior: Bool

  If true, reflections will ignore sky contribution.

• var maxDistance: Double

  The maximum distance away from the ReflectionProbe an object can be before it is culled. Decrease this to improve performance, especially when using the .updateAlways updateMode.

• var meshLodThreshold: Double

  The automatic LOD bias to use for meshes rendered within the ReflectionProbe (this is analog to meshLodThreshold). Higher values will use less detailed versions of meshes that have LOD variations generated. If set to 0.0, automatic LOD is disabled. Increase meshLodThreshold to improve performance at the cost of geometry detail, especially when using the .updateAlways updateMode.

• var originOffset: Vector3

  Sets the origin offset to be used when this ReflectionProbe is in boxProjection mode. This can be set to a non-zero value to ensure a reflection fits a rectangle-shaped room, while reducing the number of objects that “get in the way” of the reflection.

• var size: Vector3

  The size of the reflection probe. The larger the size, the more space covered by the probe, which will lower the perceived resolution. It is best to keep the size only as large as you need it.

• var updateMode: ReflectionProbe.UpdateMode

  Sets how frequently the ReflectionProbe is updated. Can be .updateOnce or .updateAlways.