Class ContactShadows
A volume component that holds settings for the Contact Shadows effect.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
public class ContactShadows : VolumeComponentWithQualityFields
distanceScaleFactor
Scales the length of the contact shadow ray based on the linear depth value at the origin of the ray.
Declaration
public ClampedFloatParameter distanceScaleFactorField Value
| Type | Description |
|---|---|
| ClampedFloatParameter |
enable
When enabled, HDRP processes Contact Shadows for this Volume.
Declaration
public BoolParameter enableField Value
| Type | Description |
|---|---|
| BoolParameter |
fadeDistance
The distance, in meters, over which HDRP fades Contact Shadows out when past the Max Distance.
Declaration
public MinFloatParameter fadeDistanceField Value
| Type | Description |
|---|---|
| MinFloatParameter |
fadeInDistance
The distance, in meters, over which HDRP fades Contact Shadows in when past the Min Distance.
Declaration
public MinFloatParameter fadeInDistanceField Value
| Type | Description |
|---|---|
| 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 lengthField Value
| Type | Description |
|---|---|
| ClampedFloatParameter |
maxDistance
The distance from the camera, in meters, at which HDRP begins to fade out Contact Shadows.
Declaration
public MinFloatParameter maxDistanceField Value
| Type | Description |
|---|---|
| MinFloatParameter |
minDistance
The distance from the camera, in meters, at which HDRP begins to fade in Contact Shadows.
Declaration
public MinFloatParameter minDistanceField Value
| Type | Description |
|---|---|
| MinFloatParameter |
opacity
Controls the opacity of the contact shadows.
Declaration
public ClampedFloatParameter opacityField Value
| Type | Description |
|---|---|
| ClampedFloatParameter |
rayBias
Controls the bias applied to the screen space ray cast to get contact shadows.
Declaration
public ClampedFloatParameter rayBiasField Value
| Type | Description |
|---|---|
| ClampedFloatParameter |
thicknessScale
Controls the thickness of the objects found along the ray, essentially thickening the contact shadows.
Declaration
public ClampedFloatParameter thicknessScaleField Value
| Type | Description |
|---|---|
| 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 |