Struct ProbeSettings
Settings that defines the rendering of a probe.
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
public struct ProbeSettingsFields
cameraSettings
Probe camera settings.
Declaration
public CameraSettings cameraSettingsField Value
| Type | Description |
|---|---|
| CameraSettings |
default
Default value.
Declaration
[Obsolete("Since 2019.3, use ProbeSettings.NewDefault() instead.")]
public static ProbeSettings defaultField Value
| Type | Description |
|---|---|
| ProbeSettings |
frustum
The way the frustum is handled by the probe.
Declaration
public ProbeSettings.Frustum frustumField Value
| Type | Description |
|---|---|
| ProbeSettings.Frustum |
influence
The influence volume of the probe.
Declaration
public InfluenceVolume influenceField Value
| Type | Description |
|---|---|
| InfluenceVolume |
lighting
The lighting of the probe.
Declaration
public ProbeSettings.Lighting lightingField Value
| Type | Description |
|---|---|
| ProbeSettings.Lighting |
mode
The mode of the probe.
Declaration
public ProbeSettings.Mode modeField Value
| Type | Description |
|---|---|
| ProbeSettings.Mode |
proxy
Set this variable to explicitly set the proxy volume to use.
Declaration
public ProxyVolume proxyField Value
| Type | Description |
|---|---|
| ProxyVolume |
proxySettings
The proxy settings of the probe for the current volume.
Declaration
public ProbeSettings.ProxySettings proxySettingsField Value
| Type | Description |
|---|---|
| ProbeSettings.ProxySettings |
realtimeMode
The mode of the probe.
Declaration
public ProbeSettings.RealtimeMode realtimeModeField Value
| Type | Description |
|---|---|
| ProbeSettings.RealtimeMode |
resolution
Camera settings to use when capturing data.
Declaration
public PlanarReflectionAtlasResolution resolutionField Value
| Type | Description |
|---|---|
| PlanarReflectionAtlasResolution |
type
The type of the probe.
Declaration
public ProbeSettings.ProbeType typeField 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. |