API > ReflectionProbe

ReflectionProbe⚓︎

ReflectionProbe inherits from Behaviour

The reflection probe is used to capture the surroundings into a texture which is passed to the shaders and used for reflections. Unity Reference

Members⚓︎

Properties⚓︎

Name	Description
`ReflectionProbe`.`backgroundColor`	The color with which the texture of reflection probe will be cleared.
`ReflectionProbe`.`bakedTexture`	Reference to the baked texture of the reflection probe's surrounding.
`ReflectionProbe`.`blendDistance`	Distance around probe used for blending (used in deferred probes).
`ReflectionProbe`.`bounds`	The probe's world space axis-aligned bounding box in which the probe can contribute to reflections (Read Only).
`ReflectionProbe`.`boxProjection`	Should this reflection probe use box projection?
`ReflectionProbe`.`center`	The center of the probe's bounding box in which the probe can contribute to reflections. The center is relative to the position of the probe.
`ReflectionProbe`.`clearFlags`	How the reflection probe clears the background.
`ReflectionProbe`.`cullingMask`	This is used to render parts of the reflecion probe's surrounding selectively.
`ReflectionProbe`.`customBakedTexture`	Reference to the baked texture of the reflection probe's surrounding. Use this to assign custom reflection texture.
`ReflectionProbe`.`farClipPlane`	The far clipping plane distance when rendering the probe.
`ReflectionProbe`.`hdr`	Should this reflection probe use HDR rendering?
`ReflectionProbe`.`importance`	Reflection probe importance.
`ReflectionProbe`.`intensity`	The intensity modifier that is applied to the texture of reflection probe in the shader.
`ReflectionProbe`.`mode`	Should reflection probe texture be generated in the Editor (ReflectionProbeMode.Baked) or should probe use custom specified texure (ReflectionProbeMode.Custom)?
`ReflectionProbe`.`nearClipPlane`	The near clipping plane distance when rendering the probe.
`ReflectionProbe`.`realtimeTexture`	Reference to the realtime texture of the reflection probe's surroundings. Use this to assign a RenderTexture to use for realtime reflection.
`ReflectionProbe`.`refreshMode`	Sets the way the probe will refresh.
`ReflectionProbe`.`renderDynamicObjects`	Specifies whether Unity should render non-static GameObjects into the Reflection Probe. If you set this to true, Unity renders non-static GameObjects into the Reflection Probe. If you set this to false, Unity does not render non-static GameObjects into the Reflection Probe. Unity only takes this property into account if the Reflection Probe's Type is Custom.
`ReflectionProbe`.`resolution`	Resolution of the underlying reflection texture in pixels.
`ReflectionProbe`.`shadowDistance`	Shadow drawing distance when rendering the probe.
`ReflectionProbe`.`size`	The size of the probe's bounding box in which the probe can contribute to reflections. The size is in world space.
`ReflectionProbe`.`texture`	Texture which is passed to the shader of the objects in the vicinity of the reflection probe (Read Only). This texture is meant to represent reflection in a particular direction.
`ReflectionProbe`.`textureHDRDecodeValues`	HDR decode values of the reflection probe texture.
`ReflectionProbe`.`timeSlicingMode`	Sets this probe time-slicing mode

Static Properties⚓︎

Name	Description
`ReflectionProbe`.`defaultTexture`	Texture which is used outside of all reflection probes (Read Only).
`ReflectionProbe`.`defaultTextureHDRDecodeValues`	HDR decode values of the default reflection probe texture.

Methods⚓︎

Name	Description
`ReflectionProbe`.`IsFinishedRendering(renderId)`	Checks if a probe has finished a time-sliced render.
`ReflectionProbe`.`RenderProbe(targetTexture=nil)`	Refreshes the probe's cubemap.
`ReflectionProbe`.`Reset()`	Revert all ReflectionProbe parameters to default.

Static Methods⚓︎

Name	Description
`ReflectionProbe`.`BlendCubemap(src, dst, blend, target)`	Utility method to blend 2 cubemaps into a target render texture.

Inherited Members⚓︎

Inherited Properties⚓︎

Name	Description
`ReflectionProbe`.`enabled`	Enabled Behaviours are Updated, disabled Behaviours are not.
`ReflectionProbe`.`isActiveAndEnabled`	Has the Behaviour had active and enabled called?
`ReflectionProbe`.`gameObject`	The game object this component is attached to. A component is always attached to a game object.
`ReflectionProbe`.`tag`	The tag of this game object.
`ReflectionProbe`.`transform`	The Transform attached to this GameObject.
`ReflectionProbe`.`hideFlags`	Should the object be hidden, saved with the Scene or modifiable by the user?
`ReflectionProbe`.`name`	The name of the object.

Inherited Methods⚓︎

Name	Description
`ReflectionProbe`.`BroadcastMessage(methodName, parameter=nil)`	Calls the method named methodName on every Lua Script in this game object or any of its children.
`ReflectionProbe`.`CompareTag(tag)`	Is this game object tagged with tag ?
`ReflectionProbe`.`GetAllLuaScripts()`	Returns an array of all Lua scripts that attached to the game object.
`ReflectionProbe`.`GetComponent(type)`	Returns the component of Type type if the game object has one attached, nil if it doesn't.
`ReflectionProbe`.`GetComponentInChildren(t)`	Returns the component of Type type in the GameObject or any of its children using depth first search.
`ReflectionProbe`.`GetComponentInParent(t)`	Returns the component of Type type in the GameObject or any of its parents.
`ReflectionProbe`.`GetComponents(type)`	Returns all components of Type type in the GameObject.
`ReflectionProbe`.`GetComponentsInChildren(t)`	Returns all components of Type type in the GameObject or any of its children.
`ReflectionProbe`.`GetComponentsInParent(t)`	Returns all components of Type type in the GameObject or any of its parents.
`ReflectionProbe`.`SendMessage(methodName, value=nil)`	Calls the method named methodName on every Lua Script in this game object.
`ReflectionProbe`.`SendMessageUpwards(methodName, value=nil)`	Calls the method named methodName on every LuaScript in this game object and on every ancestor of the behaviour.
`ReflectionProbe`.`TryGetComponent(type)`	Gets the component of the specified type, if it exists.
`ReflectionProbe`.`GetInstanceID()`	Returns the instance id of the object.