Class ContactShadows

A volume component that holds settings for the Contact Shadows effect.

Inheritance
Object
UnityEngine.Rendering.VolumeComponent
VolumeComponentWithQuality
ContactShadows
Inherited Members
UnityEngine.Rendering.VolumeComponent.active
UnityEngine.Rendering.VolumeComponent.OnEnable()
UnityEngine.Rendering.VolumeComponent.OnDisable()
UnityEngine.Rendering.VolumeComponent.Override(UnityEngine.Rendering.VolumeComponent, System.Single)
UnityEngine.Rendering.VolumeComponent.SetAllOverridesTo(System.Boolean)
UnityEngine.Rendering.VolumeComponent.GetHashCode()
UnityEngine.Rendering.VolumeComponent.OnDestroy()
UnityEngine.Rendering.VolumeComponent.Release()
UnityEngine.Rendering.VolumeComponent.displayName
UnityEngine.Rendering.VolumeComponent.parameters
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@10.3/manual/Override-Contact-Shadows.html")]
public class ContactShadows : VolumeComponentWithQuality

Fields

distanceScaleFactor

Scales the length of the contact shadow ray based on the linear depth value at the origin of the ray.

Declaration
public ClampedFloatParameter distanceScaleFactor
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

enable

When enabled, HDRP processes Contact Shadows for this Volume.

Declaration
public BoolParameter enable
Field Value
Type Description
UnityEngine.Rendering.BoolParameter

fadeDistance

The distance, in meters, over which HDRP fades Contact Shadows out when past the Max Distance.

Declaration
public MinFloatParameter fadeDistance
Field Value
Type Description
UnityEngine.Rendering.MinFloatParameter

fadeInDistance

The distance, in meters, over which HDRP fades Contact Shadows in when past the Min Distance.

Declaration
public MinFloatParameter fadeInDistance
Field Value
Type Description
UnityEngine.Rendering.MinFloatParameter

length

Controls the length of the rays HDRP uses to calculate Contact Shadows. It is in meters, but it gets scaled by a factor depending on Distance Scale Factor and the depth of the point from where the contact shadow ray is traced.

Declaration
public ClampedFloatParameter length
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

maxDistance

The distance from the camera, in meters, at which HDRP begins to fade out Contact Shadows.

Declaration
public MinFloatParameter maxDistance
Field Value
Type Description
UnityEngine.Rendering.MinFloatParameter

minDistance

The distance from the camera, in meters, at which HDRP begins to fade in Contact Shadows.

Declaration
public MinFloatParameter minDistance
Field Value
Type Description
UnityEngine.Rendering.MinFloatParameter

opacity

Controls the opacity of the contact shadows.

Declaration
public ClampedFloatParameter opacity
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

rayBias

Controls the bias applied to the screen space ray cast to get contact shadows.

Declaration
public ClampedFloatParameter rayBias
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

thicknessScale

Controls the thickness of the objects found along the ray, essentially thickening the contact shadows.

Declaration
public ClampedFloatParameter thicknessScale
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

Properties

sampleCount

Controls the numbers of samples taken during the ray-marching process for shadows. Increasing this might lead to higher quality at the expenses of performance.

Declaration
public int sampleCount { get; set; }
Property Value
Type Description
Int32