Struct ProbeSettings
Settings that defines the rendering of a probe.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
public struct ProbeSettings
Fields
cameraSettings
Probe camera settings.
Declaration
[FormerlySerializedAs("camera")]
public CameraSettings cameraSettings
Field Value
Type | Description |
---|---|
CameraSettings |
default
Default value.
Declaration
[Obsolete("Since 2019.3, use ProbeSettings.NewDefault() instead.")]
public static ProbeSettings @default
Field Value
Type | Description |
---|---|
ProbeSettings |
distanceBasedRoughness
Indicates whether the ReflectionProbe supports distance-based roughness.
Declaration
public bool distanceBasedRoughness
Field Value
Type | Description |
---|---|
bool |
frustum
The way the frustum is handled by the probe.
Declaration
public ProbeSettings.Frustum frustum
Field Value
Type | Description |
---|---|
ProbeSettings.Frustum |
influence
The influence volume of the probe.
Declaration
public InfluenceVolume influence
Field Value
Type | Description |
---|---|
InfluenceVolume |
lighting
The lighting of the probe.
Declaration
public ProbeSettings.Lighting lighting
Field Value
Type | Description |
---|---|
ProbeSettings.Lighting |
mode
The mode of the probe.
Declaration
public ProbeSettings.Mode mode
Field Value
Type | Description |
---|---|
ProbeSettings.Mode |
proxy
Set this variable to explicitly set the proxy volume to use.
Declaration
public ProxyVolume proxy
Field Value
Type | Description |
---|---|
ProxyVolume |
proxySettings
The proxy settings of the probe for the current volume.
Declaration
public ProbeSettings.ProxySettings proxySettings
Field Value
Type | Description |
---|---|
ProbeSettings.ProxySettings |
realtimeMode
The mode of the probe.
Declaration
public ProbeSettings.RealtimeMode realtimeMode
Field Value
Type | Description |
---|---|
ProbeSettings.RealtimeMode |
resolutionScalable
Camera settings to use when capturing data.
Declaration
public ProbeSettings.PlanarReflectionAtlasResolutionScalableSettingValue resolutionScalable
Field Value
Type | Description |
---|---|
ProbeSettings.PlanarReflectionAtlasResolutionScalableSettingValue |
roughReflections
Indicates whether the ReflectionProbe supports rough reflections.
Declaration
public bool roughReflections
Field Value
Type | Description |
---|---|
bool |
timeSlicing
Whether a realtime probe uses time slicing.
Declaration
public bool timeSlicing
Field Value
Type | Description |
---|---|
bool |
type
The type of the probe.
Declaration
public ProbeSettings.ProbeType type
Field Value
Type | Description |
---|---|
ProbeSettings.ProbeType |
Methods
ComputeHash()
Compute a hash of the settings.
Declaration
public Hash128 ComputeHash()
Returns
Type | Description |
---|---|
Hash128 | The computed hash. |
NewDefault()
Default value.
Declaration
public static ProbeSettings NewDefault()
Returns
Type | Description |
---|---|
ProbeSettings | The default value. |