Class HDProbe
Base class for reflection like probes.
Implements
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[ExecuteAlways]
public abstract class HDProbe : MonoBehaviour, IVersionable<HDProbe.Version>Fields
| Name | Description |
|---|---|
| k_Migration | The migration steps for HDProbes |
| m_ObsoleteInfiniteProjection | Obsolete field |
| m_ObsoleteInfluenceVolume | Obsolete field |
| m_ObsoleteMode | Obsolete field |
| m_ObsoleteMultiplier | Obsolete field |
| m_ObsoleteWeight | Obsolete field |
| m_ProbeSettings | Backed values of the probe settings. Don't use directly this except for migration code. |
Properties
| Name | Description |
|---|---|
| ExposureControlEnabled | Set and used by the pipeline, depending on the resolved configuration of a probe. |
| bakedRenderData | The render data of the last bake |
| bakedTexture | The baked texture. Can be null if the probe was never baked. Most of the time, you do not need to set this value yourself. You can set this property in situations where you want to manually assign data that differs from what Unity generates. |
| boundingSphere | The bounding sphere of the influence |
| bounds | The bounding box of the influence |
| cubeResolution | Resolution of the cube probe. |
| customRenderData | The render data of the custom mode |
| customTexture | Texture used in custom mode. |
| fadeDistance | The distance at which reflections smoothly fade out before HDRP cut them completely. |
| frameSettings | Frame settings in use with this probe. |
| frameSettingsOverrideMask | Specify the settings overriden for the frame settins |
| influenceVolume | InfluenceVolume of the probe. |
| isProjectionInfinite | Is the projection at infinite? Value could be changed by Proxy mode. |
| lightLayers | Light layer to use by this probe. |
| lightLayersAsUInt | This function return a mask of light layers as uint and handle the case of Everything as being 0xFF and not -1 |
| mode | The capture mode. |
| multiplier | Multiplier factor of reflection (non PBR parameter). |
| proxyExtents | The extents of the proxy volume |
| proxyVolume | ProxyVolume currently used by this probe. |
| rangeCompressionFactor | The result of the rendering of the probe will be divided by this factor. When the probe is read, this factor is undone as the probe data is read. This is to simply avoid issues with values clamping due to precision of the storing format. |
| realtimeDepthTexture | The allocated realtime depth texture. Can be null if the probe never rendered with the realtime mode. Most of the time, you do not need to set this value yourself. You can set this property in situations where you want to manually assign data that differs from what Unity generates. |
| realtimeDepthTextureRTH | Returns an RThandle reference to the realtime texture where the depth result of the probe is stored. |
| realtimeMode | The realtime mode of the probe |
| realtimeRenderData | The render data of the last realtime rendering |
| realtimeTexture | The allocated realtime texture. Can be null if the probe never rendered with the realtime mode. Most of the time, you do not need to set this value yourself. You can set this property in situations where you want to manually assign data that differs from what Unity generates. |
| realtimeTextureRTH | Returns an RThandle reference to the realtime texture where the color result of the probe is stored. |
| renderData | The currently used render data. |
| resolution | Resolution of the planar probe. |
| settings | Use this property to get the settings used for calculations. To edit the settings of the probe, use the unsanitized version of this property: settingsRaw. |
| settingsRaw | To read the settings of this probe, most of the time you should use the sanitized version of this property: settings. Use this property to read the settings of the probe only when it is important that you read the raw data. |
| texture | The texture used during lighting for this probe. |
| timeSlicing | Whether the realtime probe uses time slicing |
| type | The probe type |
| useInfluenceVolumeAsProxyVolume | Use the influence volume as the proxy volume if this is true. |
| weight | Weight for blending amongst probes (non PBR parameter). |
Methods
| Name | Description |
|---|---|
| GetRenderData(Mode) | Get the render data of a specific mode. Note: The HDProbe stores only one RenderData per mode, even for view dependent probes with multiple viewers. In that case, make sure that you have set the RenderData relative to the expected viewer before rendering. Otherwise the data retrieved by this function will be wrong. |
| GetTexture(Mode) | Get the texture for a specific mode. |
| PrepareCulling() | Prepare the probe for culling. You should call this method when you update the influenceVolume parameters during runtime. |
| RequestRenderNextUpdate() | Requests that Unity renders this Reflection Probe during the next update. |
| SetDepthTexture(Mode, Texture) | Set the depth texture for a specific target mode. |
| SetRenderData(Mode, RenderData) | Set the render data for a specific mode. Note: The HDProbe stores only one RenderData per mode, even for view dependent probes with multiple viewers. In that case, make sure that you have set the RenderData relative to the expected viewer before rendering. |
| SetTexture(Mode, Texture) | Set the texture for a specific target mode. |