Version: 2017.3

ReflectionProbe

class in UnityEngine

/

Inherits from:Behaviour

Switch to Manual

Description

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

The properties are an exact match for the values shown in the Inspector.

This class is a script interface for a reflection probe component.

Reflection probes are usually just created in the Editor, but sometimes you might want to create a reflection probe from a script:

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Start() { GameObject probeGameObject = new GameObject("The Reflection Probe"); ReflectionProbe probeComponent = probeGameObject.AddComponent<ReflectionProbe>() as ReflectionProbe; probeComponent.resolution = 256; probeComponent.size = new Vector3(10, 10, 10); probeGameObject.transform.position = new Vector3(0, 5, 0); } }

Static Variables

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

Variables

backgroundColorThe color with which the texture of reflection probe will be cleared.
bakedTextureReference to the baked texture of the reflection probe's surrounding.
blendDistanceDistance around probe used for blending (used in deferred probes).
boundsThe bounding volume of the reflection probe (Read Only).
boxProjectionShould this reflection probe use box projection?
centerThe center of the box area in which reflections will be applied to the objects. Measured in the probes's local space.
clearFlagsHow the reflection probe clears the background.
cullingMaskThis is used to render parts of the reflecion probe's surrounding selectively.
customBakedTextureReference to the baked texture of the reflection probe's surrounding. Use this to assign custom reflection texture.
farClipPlaneThe far clipping plane distance when rendering the probe.
hdrShould this reflection probe use HDR rendering?
importanceReflection probe importance.
intensityThe intensity modifier that is applied to the texture of reflection probe in the shader.
modeShould reflection probe texture be generated in the Editor (ReflectionProbeMode.Baked) or should probe use custom specified texure (ReflectionProbeMode.Custom)?
nearClipPlaneThe near clipping plane distance when rendering the probe.
refreshModeSets the way the probe will refresh.See Also: ReflectionProbeRefreshMode.
resolutionResolution of the underlying reflection texture in pixels.
shadowDistanceShadow drawing distance when rendering the probe.
sizeThe size of the box area in which reflections will be applied to the objects. Measured in the probes's local space.
textureTexture which is passed to the shader of the objects in the vicinity of the reflection probe (Read Only).
textureHDRDecodeValuesHDR decode values of the reflection probe texture.
timeSlicingModeSets this probe time-slicing modeSee Also: ReflectionProbeTimeSlicingMode.

Public Functions

IsFinishedRenderingChecks if a probe has finished a time-sliced render.
RenderProbeRefreshes the probe's cubemap.

Static Functions

BlendCubemapUtility method to blend 2 cubemaps into a target render texture.

Inherited members

Variables

enabledВключенное Поведение обновляется, выключенное Поведение не обновляется.
isActiveAndEnabledHas the Behaviour had enabled called.
gameObjectИгровой объект к которому прикреплён данный компонент. Компонент всегда прикреплён к игровому объекту.
tagТег данного игрового объекта.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

BroadcastMessageВызывает метод названный methodName на каждом MonoBehaviour этого game object-а или любого из его потомков.
CompareTagПомечен ли данный игровой объект тегом tag?
GetComponentВозвращает компонент типа type, если он прикреплен к игровому объекту и null, если не прикреплен.
GetComponentInChildrenВозвращает компонент типа type в GameObject или некоторого его потомка через поиск в глубину.
GetComponentInParentВозвращает все компоненты типа type из GameObject'а или из любого его родителя.
GetComponentsВозвращает все компоненты типа type в GameObject.
GetComponentsInChildrenВозвращает все компоненты типа type в GameObject или любому из его потомков.
GetComponentsInParentВозвращает все компоненты типа type в GameObject или любому из его родителей.
SendMessageВызывает метод с названием methodName в каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwardsВызывает метод с именем methodName в каждом MonoBehaviour в этом игровом объекте и в каждом предке поведения.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Functions

DestroyУдаляет GameObject, Component или Asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.