Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


clearStencilAfterLightingPass

Should the camera clear the stencil buffer after the deferred light pass?
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public bool clearStencilAfterLightingPass { get; set; }

Remarks

When using Deferred Shading, the G-buffer and lighting passes use the stencil buffer. By default contents of the stencil buffer are preserved (not cleared) and end up containing information related to lights. Setting this property to
true
makes stencil be cleared to zero after the deferred light pass is done.
Typically if you're using deferred shading camera and UI elements with Masks (see Mask), you'll want the stencil buffer to be cleared.