Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ShadowDrawingSettings

Settings for ScriptableRenderContext.DrawShadows.
Read time 1 minuteLast updated 3 days ago

Definition

public struct ShadowDrawingSettings : IEquatable<ShadowDrawingSettings>

Remarks

This structure describes which shadow light to render (ShadowDrawingSettings.lightIndex) with what split settings (ShadowDrawingSettings.splitData).
Additional Resources: ShadowSplitData.

Constructors

Constructor

Description

ShadowDrawingSettings(UnityEngine.Rendering.CullingResults,System.Int32)Create a shadow settings object.

Properties

Property

Description

batchLayerMaskUnity renders objects whose BatchFilterSettings.batchLayer value is enabled in this bit mask.
cullingResultsCulling results to use.
lightIndexThe index of the shadow-casting light to be rendered.
objectsFilterSpecifies the filter Unity applies to GameObjects that it renders in the shadow pass.
sortShadowcastersByRenderQueueSorts shadowcasting renderers by their render queue index when rendering shadows.
splitIndexThe split index of the shadow-casting light to be rendered. With the default value of -1, Unity increments the split index from 0 for shadow renderer lists that are created consecutively for the same light index with matching filtering and masking settings.
useRenderingLayerMaskTestSet this to
true
to make Unity filter Renderers during shadow rendering. Unity filters Renderers based on the Rendering Layer Mask of the Renderer itself, and the Rendering Layer Mask of each shadow casting Light.