Class DepthOnlyPass

Render all objects that have a 'DepthOnly' pass into the given depth buffer.

You can use this pass to prime a depth buffer for subsequent rendering. Use it as a z-prepass, or use it to generate a depth buffer.

Inheritance

Object

ScriptableRenderPass

DepthOnlyPass

Inherited Members

ScriptableRenderPass.renderPassEvent

ScriptableRenderPass.colorAttachment

ScriptableRenderPass.depthAttachment

ScriptableRenderPass.clearFlag

ScriptableRenderPass.clearColor

ScriptableRenderPass.ConfigureTarget(RenderTargetIdentifier, RenderTargetIdentifier)

ScriptableRenderPass.ConfigureTarget(RenderTargetIdentifier)

ScriptableRenderPass.ConfigureClear(ClearFlag, Color)

ScriptableRenderPass.Blit(CommandBuffer, RenderTargetIdentifier, RenderTargetIdentifier, Material, Int32)

ScriptableRenderPass.CreateDrawingSettings(ShaderTagId, RenderingData, SortingCriteria)

ScriptableRenderPass.CreateDrawingSettings(List<ShaderTagId>, RenderingData, SortingCriteria)

Namespace: UnityEngine.Rendering.Universal.Internal

Syntax

public class DepthOnlyPass : ScriptableRenderPass

Constructors

DepthOnlyPass(RenderPassEvent, RenderQueueRange, LayerMask)

Create the DepthOnlyPass

Declaration

public DepthOnlyPass(RenderPassEvent evt, RenderQueueRange renderQueueRange, LayerMask layerMask)

Parameters

Type	Name	Description
RenderPassEvent	evt
RenderQueueRange	renderQueueRange
LayerMask	layerMask

Methods

Configure(CommandBuffer, RenderTextureDescriptor)

Declaration

public override void Configure(CommandBuffer cmd, RenderTextureDescriptor cameraTextureDescriptor)

Parameters

Type	Name	Description
CommandBuffer	cmd
RenderTextureDescriptor	cameraTextureDescriptor

Overrides

ScriptableRenderPass.Configure(CommandBuffer, RenderTextureDescriptor)

Execute(ScriptableRenderContext, ref RenderingData)

Execute the pass. This is where custom rendering occurs. Specific details are left to the implementation

Declaration

public override void Execute(ScriptableRenderContext context, ref RenderingData renderingData)

Parameters

Type	Name	Description
ScriptableRenderContext	context	Use this render context to issue any draw commands during execution
RenderingData	renderingData	Current rendering state information

Overrides

ScriptableRenderPass.Execute(ScriptableRenderContext, ref RenderingData)

FrameCleanup(CommandBuffer)

Cleanup any allocated data that was created during the execution of the pass.

Declaration

public override void FrameCleanup(CommandBuffer cmd)

Parameters

Type	Name	Description
CommandBuffer	cmd	Use this CommandBuffer to cleanup any generated data

Overrides

ScriptableRenderPass.FrameCleanup(CommandBuffer)

Setup(RenderTextureDescriptor, RenderTargetHandle)

Configure the pass

Declaration

public void Setup(RenderTextureDescriptor baseDescriptor, RenderTargetHandle depthAttachmentHandle)

Parameters

Type	Name	Description
RenderTextureDescriptor	baseDescriptor
RenderTargetHandle	depthAttachmentHandle