Skip to main content

ReflectionProbe

info

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

NameDescription
ReflectionProbe.backgroundColorThe color with which the texture of reflection probe will be cleared.
ReflectionProbe.bakedTextureReference to the baked texture of the reflection probe's surrounding.
ReflectionProbe.blendDistanceDistance around probe used for blending (used in deferred probes).
ReflectionProbe.boundsThe probe's world space axis-aligned bounding box in which the probe can contribute to reflections (Read Only).
ReflectionProbe.boxProjectionShould this reflection probe use box projection?
ReflectionProbe.centerThe 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.clearFlagsHow the reflection probe clears the background.
ReflectionProbe.cullingMaskThis is used to render parts of the reflecion probe's surrounding selectively.
ReflectionProbe.customBakedTextureReference to the baked texture of the reflection probe's surrounding. Use this to assign custom reflection texture.
ReflectionProbe.farClipPlaneThe far clipping plane distance when rendering the probe.
ReflectionProbe.hdrShould this reflection probe use HDR rendering?
ReflectionProbe.importanceReflection probe importance.
ReflectionProbe.intensityThe intensity modifier that is applied to the texture of reflection probe in the shader.
ReflectionProbe.modeShould reflection probe texture be generated in the Editor (ReflectionProbeMode.Baked) or should probe use custom specified texure (ReflectionProbeMode.Custom)?
ReflectionProbe.nearClipPlaneThe near clipping plane distance when rendering the probe.
ReflectionProbe.realtimeTextureReference to the realtime texture of the reflection probe's surroundings. Use this to assign a RenderTexture to use for realtime reflection.
ReflectionProbe.refreshModeSets the way the probe will refresh.
ReflectionProbe.renderDynamicObjectsSpecifies 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.resolutionResolution of the underlying reflection texture in pixels.
ReflectionProbe.shadowDistanceShadow drawing distance when rendering the probe.
ReflectionProbe.sizeThe size of the probe's bounding box in which the probe can contribute to reflections. The size is in world space.
ReflectionProbe.textureTexture 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.textureHDRDecodeValuesHDR decode values of the reflection probe texture.
ReflectionProbe.timeSlicingModeSets this probe time-slicing mode

Static Properties

NameDescription
ReflectionProbe.defaultTextureTexture which is used outside of all reflection probes (Read Only).
ReflectionProbe.defaultTextureHDRDecodeValuesHDR decode values of the default reflection probe texture.

Methods

NameDescription
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

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

Inherited Members

Inherited Properties

NameDescription
ReflectionProbe.enabledEnabled Behaviours are Updated, disabled Behaviours are not.
ReflectionProbe.isActiveAndEnabledHas the Behaviour had active and enabled called?
ReflectionProbe.gameObjectThe game object this component is attached to. A component is always attached to a game object.
ReflectionProbe.tagThe tag of this game object.
ReflectionProbe.transformThe Transform attached to this GameObject.
ReflectionProbe.hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
ReflectionProbe.nameThe name of the object.

Inherited Methods

NameDescription
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.