Struct ReflectionProbe
Captures its surroundings to create reflections.
struct ReflectionProbe
;
Capture its surroundings as a dual parabolid image, 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 GIProbes and Screen Space Reflections to achieve high quality reflections. ReflectionProbes render all objects within their cullMask, so updating them can be quite expensive. It is best to update them once with the important static objects and then leave them.
Properties
| Name | Type | Description |
|---|---|---|
boxProjection[get, set]
|
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.
|
cullMask[get, set]
|
long | Sets the cull mask which determines what objects are drawn by this probe. Every VisualInstance 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.
|
enableShadows[get, set]
|
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 constant UPDATE_ALWAYS updateMode.
|
extents[get, set]
|
Vector3 | 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. |
intensity[get, set]
|
double | Defines the reflection intensity. Intensity modulates the strength of the reflection. |
interiorAmbientColor[get, set]
|
Color | Sets the ambient light color to be used when this probe is set to interiorEnable.
|
interiorAmbientContrib[get, set]
|
double | Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to interiorEnable. Useful so that ambient light matches the color of the room.
|
interiorAmbientEnergy[get, set]
|
double | Sets the energy multiplier for this reflection probe's ambient light contribution when set to interiorEnable.
|
interiorEnable[get, set]
|
bool | If true, reflections will ignore sky contribution. Ambient lighting is then controlled by the interior_ambient_* properties.
|
maxDistance[get, set]
|
double | Sets the max distance away from the probe an object can be before it is culled. |
originOffset[get, set]
|
Vector3 | Sets the origin offset to be used when this reflection probe is in box project mode. |
updateMode[get, set]
|
ReflectionProbe | Sets how frequently the probe is updated. Can be constant UPDATE_ONCE or constant UPDATE_ALWAYS.
|
Methods
Enums
| Name | Description |
|---|---|
Constants
|
|
UpdateMode
|