Class HDProbe
Syntax
public abstract class HDProbe : MonoBehaviour, IVersionable<HDProbe.Version>
Fields
k_Migration
Declaration
protected static readonly MigrationDescription<HDProbe.Version, HDProbe> k_Migration
Field Value
m_ObsoleteCaptureSettings
Declaration
[Obsolete("For Data Migration")]
protected ObsoleteCaptureSettings m_ObsoleteCaptureSettings
Field Value
m_ObsoleteInfiniteProjection
Declaration
[Obsolete("For Data Migration")]
protected bool m_ObsoleteInfiniteProjection
Field Value
m_ObsoleteInfluenceVolume
Declaration
[Obsolete("For Data Migration")]
protected InfluenceVolume m_ObsoleteInfluenceVolume
Field Value
m_ObsoleteMode
Declaration
[Obsolete("For Data Migration")]
protected ProbeSettings.Mode m_ObsoleteMode
Field Value
m_ObsoleteMultiplier
Declaration
[Obsolete("For Data Migration")]
protected float m_ObsoleteMultiplier
Field Value
m_ObsoleteWeight
Declaration
[Obsolete("For Data Migration")]
protected float m_ObsoleteWeight
Field Value
m_ProbeSettings
Declaration
protected ProbeSettings m_ProbeSettings
Field Value
Properties
bakedRenderData
Declaration
public HDProbe.RenderData bakedRenderData { get; }
Property Value
bakedTexture
Declaration
public Texture bakedTexture { get; }
Property Value
boundingSphere
Declaration
public BoundingSphere boundingSphere { get; }
Property Value
| Type |
Description |
| BoundingSphere |
|
bounds
Declaration
public Bounds bounds { get; }
Property Value
customRenderData
Declaration
public HDProbe.RenderData customRenderData { get; }
Property Value
customTexture
Declaration
public Texture customTexture { get; }
Property Value
frameSettings
Frame settings in use with this probe.
Declaration
public FrameSettings frameSettings { get; }
Property Value
frameSettingsOverrideMask
Declaration
public FrameSettingsOverrideMask frameSettingsOverrideMask { get; }
Property Value
influenceVolume
InfluenceVolume of the probe.
Declaration
public InfluenceVolume influenceVolume { get; }
Property Value
isProjectionInfinite
Is the projection at infinite? Value could be changed by Proxy mode.
Declaration
public bool isProjectionInfinite { get; }
Property Value
lightLayers
Light layer to use by this probe.
Declaration
public LightLayerEnum lightLayers { get; set; }
Property Value
lightLayersAsUInt
Declaration
public uint lightLayersAsUInt { get; }
Property Value
mode
Declaration
public ProbeSettings.Mode mode { get; set; }
Property Value
multiplier
Multiplier factor of reflection (non PBR parameter).
Declaration
public float multiplier { get; set; }
Property Value
proxyExtents
Declaration
public Vector3 proxyExtents { get; }
Property Value
proxyVolume
ProxyVolume currently used by this probe.
Declaration
public ReflectionProxyVolumeComponent proxyVolume { get; }
Property Value
realtimeMode
Declaration
public ProbeSettings.RealtimeMode realtimeMode { get; set; }
Property Value
realtimeRenderData
Declaration
public HDProbe.RenderData realtimeRenderData { get; }
Property Value
realtimeTexture
Declaration
public RenderTexture realtimeTexture { get; }
Property Value
| Type |
Description |
| RenderTexture |
|
renderData
Declaration
public HDProbe.RenderData renderData { get; }
Property Value
texture
Declaration
public Texture texture { get; }
Property Value
type
Declaration
public ProbeSettings.ProbeType type { get; protected set; }
Property Value
useInfluenceVolumeAsProxyVolume
Declaration
public bool useInfluenceVolumeAsProxyVolume { get; }
Property Value
weight
Weight for blending amongst probes (non PBR parameter).
Declaration
public float weight { get; set; }
Property Value
Methods
GetRenderData(ProbeSettings.Mode)
Declaration
public HDProbe.RenderData GetRenderData(ProbeSettings.Mode targetMode)
Parameters
Returns
GetTexture(ProbeSettings.Mode)
Declaration
public Texture GetTexture(ProbeSettings.Mode targetMode)
Parameters
Returns
PrepareCulling()
Prepare the probe for culling.
You should call this method when you update the influenceVolume parameters during runtime.
Declaration
public virtual void PrepareCulling()
RequestRenderNextUpdate()
Request to render this probe next update.
Call this method with the mode OnDemand and the probe will
be rendered the next time it will influence a camera rendering.
Declaration
public void RequestRenderNextUpdate()
SetRenderData(ProbeSettings.Mode, HDProbe.RenderData)
Declaration
public void SetRenderData(ProbeSettings.Mode targetMode, HDProbe.RenderData renderData)
Parameters
SetTexture(ProbeSettings.Mode, Texture)
Declaration
public Texture SetTexture(ProbeSettings.Mode targetMode, Texture texture)
Parameters
Returns
Explicit Interface Implementations
IVersionable<HDProbe.Version>.version
Declaration
HDProbe.Version IVersionable<HDProbe.Version>.version { get; set; }
Returns
Implements