- areShadowsEnabled
bool areShadowsEnabled()
- getCullMask
long getCullMask()
- getExtents
Vector3 getExtents()
- getIntensity
double getIntensity()
- getInteriorAmbient
Color getInteriorAmbient()
- getInteriorAmbientEnergy
double getInteriorAmbientEnergy()
- getInteriorAmbientProbeContribution
double getInteriorAmbientProbeContribution()
- getMaxDistance
double getMaxDistance()
- getOriginOffset
Vector3 getOriginOffset()
- getUpdateMode
ReflectionProbe.UpdateMode getUpdateMode()
- isBoxProjectionEnabled
bool isBoxProjectionEnabled()
- isSetAsInterior
bool isSetAsInterior()
- opAssign
typeof(null) opAssign(typeof(null) n)
- opEquals
bool opEquals(ReflectionProbe other)
- opEquals
bool opEquals(typeof(null) n)
- setAsInterior
void setAsInterior(bool enable)
- setCullMask
void setCullMask(long layers)
- setEnableBoxProjection
void setEnableBoxProjection(bool enable)
- setEnableShadows
void setEnableShadows(bool enable)
- setExtents
void setExtents(Vector3 extents)
- setIntensity
void setIntensity(double intensity)
- setInteriorAmbient
void setInteriorAmbient(Color ambient)
- setInteriorAmbientEnergy
void setInteriorAmbientEnergy(double ambient_energy)
- setInteriorAmbientProbeContribution
void setInteriorAmbientProbeContribution(double ambient_probe_contribution)
- setMaxDistance
void setMaxDistance(double max_distance)
- setOriginOffset
void setOriginOffset(Vector3 origin_offset)
- setUpdateMode
void setUpdateMode(long mode)
- toHash
size_t toHash()
- boxProjection
bool boxProjection [@property getter]
bool boxProjection [@property setter]
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
long cullMask [@property getter]
long cullMask [@property setter]
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
bool enableShadows [@property getter]
bool enableShadows [@property setter]
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
Vector3 extents [@property getter]
Vector3 extents [@property setter]
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
double intensity [@property getter]
double intensity [@property setter]
Defines the reflection intensity. Intensity modulates the strength of the reflection.
- interiorAmbientColor
Color interiorAmbientColor [@property getter]
Color interiorAmbientColor [@property setter]
Sets the ambient light color to be used when this probe is set to interiorEnable.
- interiorAmbientContrib
double interiorAmbientContrib [@property getter]
double interiorAmbientContrib [@property setter]
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
double interiorAmbientEnergy [@property getter]
double interiorAmbientEnergy [@property setter]
Sets the energy multiplier for this reflection probe's ambient light contribution when set to interiorEnable.
- interiorEnable
bool interiorEnable [@property getter]
bool interiorEnable [@property setter]
If true, reflections will ignore sky contribution. Ambient lighting is then controlled by the interior_ambient_* properties.
- maxDistance
double maxDistance [@property getter]
double maxDistance [@property setter]
Sets the max distance away from the probe an object can be before it is culled.
- originOffset
Vector3 originOffset [@property getter]
Vector3 originOffset [@property setter]
Sets the origin offset to be used when this reflection probe is in box project mode.
- updateMode
ReflectionProbe.UpdateMode updateMode [@property getter]
long updateMode [@property setter]
Sets how frequently the probe is updated. Can be constant UPDATE_ONCE or constant UPDATE_ALWAYS.
Captures its surroundings to create reflections.
Capture its surroundings as a dual paraboloid 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. Note: By default Godot will only render 16 reflection probes. If you need more, increase the number of atlas subdivisions. This setting can be found in ProjectSettings.rendering/quality/reflections/atlasSubdiv.