Class RayTracingSettings

A volume component that holds the general settings for ray traced effects.

Inheritance

object

Object

ScriptableObject

VolumeComponent

RayTracingSettings

Implements

IApplyRevertPropertyContextMenuItemProvider

Inherited Members

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.GetHashCode()

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.Release()

VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceTerm()

VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceName(Component)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
[VolumeComponentMenuForRenderPipeline("Ray Tracing/Ray Tracing Settings (Preview)", new Type[] { typeof(HDRenderPipeline) })]
public sealed class RayTracingSettings : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider

Constructors

RayTracingSettings()

Default constructor for the ray tracing settings volume component.

Declaration

public RayTracingSettings()

Fields

buildMode

Controls how the ray tracing acceleration structure is build.

Declaration

[Tooltip("Controls how the ray tracing acceleration structure is build.")]
public RTASBuildModeParameter buildMode

Field Value

Type	Description
RTASBuildModeParameter

cullingDistance

Specifies the radius of the sphere used to cull objects out of the ray tracing acceleration structure when the culling mode is set to Sphere.

Declaration

[Tooltip("Specifies the radius of the sphere used to cull objects out of the ray tracing acceleration structure when the culling mode is set to Sphere.")]
public MinFloatParameter cullingDistance

Field Value

Type	Description
MinFloatParameter

cullingMode

Controls how the maximum distance for the ray tracing culling is defined.

Declaration

[Tooltip("Controls how the maximum distance for the ray tracing culling is defined.")]
public RTASCullingModeParameter cullingMode

Field Value

Type	Description
RTASCullingModeParameter

directionalShadowFallbackIntensity

Controls the fallback directional shadow value that is used when the point to shade is outside of the cascade.

Declaration

[Tooltip("Controls the fallback directional shadow value that is used when the point to shade is outside of the cascade.")]
public ClampedFloatParameter directionalShadowFallbackIntensity

Field Value

Type	Description
ClampedFloatParameter

directionalShadowRayLength

Controls the maximal ray length for ray traced shadows.

Declaration

[Tooltip("Controls the maximal ray length for ray traced directional shadows.")]
public MinFloatParameter directionalShadowRayLength

Field Value

Type	Description
MinFloatParameter

distantRayBias

Controls the Ray Bias value used when the distance between the pixel and the camera is close to the far plane. Between the near and far plane the Ray Bias and Distant Ray Bias are interpolated linearly. This does not affect Path Tracing or Recursive Rendering. This value can be increased to mitigate Ray Tracing z-fighting issues at a distance.

Declaration

[Tooltip("Controls the Ray Bias value used when the distance between the pixel and the camera is close to the far plane. Between the near and far plane the Ray Bias and Distant Ray Bias are interpolated linearly. This does not affect Path Tracing or Recursive Rendering. This value can be increased to mitigate Ray Tracing z-fighting issues at a distance.")]
public ClampedFloatParameter distantRayBias

Field Value

Type	Description
ClampedFloatParameter

extendCameraCulling

Enables the override of the camera culling. This increases the validity area of animated skinned mesh that are outside of the frustum..

Declaration

[Tooltip("Enables the override of the camera culling. This increases the validity area of animated skinned mesh that are outside of the frustum.")]
public BoolParameter extendCameraCulling

Field Value

Type	Description
BoolParameter

extendShadowCulling

When enabled, the culling region for punctual and area lights shadow maps is increased from frustum culling to extended culling. For Directional lights, cascades are not extended, but additional objects may appear in the cascades.

Declaration

[Tooltip("When enabled, the culling region for punctual and area lights shadow maps is increased from frustum culling to extended culling. For Directional lights, cascades are not extended, but additional objects may appear in the cascades.")]
[FormerlySerializedAs("extendCulling")]
public BoolParameter extendShadowCulling

Field Value

Type	Description
BoolParameter

rayBias

Controls the bias for all real-time ray tracing effects.

Declaration

[Tooltip("Controls the bias for all real-time ray tracing effects.")]
public ClampedFloatParameter rayBias

Field Value

Type	Description
ClampedFloatParameter

Implements

IApplyRevertPropertyContextMenuItemProvider