docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DrawObjectsPass

    Draw objects into the given color and depth target

    You can use this pass to render objects that have a material and/or shader with the pass names UniversalForward or SRPDefaultUnlit.

    Inheritance
    object
    ScriptableRenderPass
    DrawObjectsPass
    Inherited Members
    ScriptableRenderPass.k_CameraTarget
    ScriptableRenderPass.renderPassEvent
    ScriptableRenderPass.colorAttachmentHandles
    ScriptableRenderPass.colorAttachmentHandle
    ScriptableRenderPass.depthAttachmentHandle
    ScriptableRenderPass.colorStoreActions
    ScriptableRenderPass.depthStoreAction
    ScriptableRenderPass.input
    ScriptableRenderPass.clearFlag
    ScriptableRenderPass.clearColor
    ScriptableRenderPass.profilingSampler
    ScriptableRenderPass.ConfigureInput(ScriptableRenderPassInput)
    ScriptableRenderPass.ConfigureColorStoreAction(RenderBufferStoreAction, uint)
    ScriptableRenderPass.ConfigureColorStoreActions(RenderBufferStoreAction[])
    ScriptableRenderPass.ConfigureDepthStoreAction(RenderBufferStoreAction)
    ScriptableRenderPass.ResetTarget()
    ScriptableRenderPass.ConfigureTarget(RTHandle, RTHandle)
    ScriptableRenderPass.ConfigureTarget(RTHandle[], RTHandle)
    ScriptableRenderPass.ConfigureTarget(RTHandle)
    ScriptableRenderPass.ConfigureTarget(RTHandle[])
    ScriptableRenderPass.ConfigureClear(ClearFlag, Color)
    ScriptableRenderPass.OnCameraSetup(CommandBuffer, ref RenderingData)
    ScriptableRenderPass.Configure(CommandBuffer, RenderTextureDescriptor)
    ScriptableRenderPass.OnCameraCleanup(CommandBuffer)
    ScriptableRenderPass.OnFinishCameraStackRendering(CommandBuffer)
    ScriptableRenderPass.Blit(CommandBuffer, RTHandle, RTHandle, Material, int)
    ScriptableRenderPass.Blit(CommandBuffer, ref RenderingData, Material, int)
    ScriptableRenderPass.Blit(CommandBuffer, ref RenderingData, RTHandle, Material, int)
    ScriptableRenderPass.CreateDrawingSettings(ShaderTagId, ref RenderingData, SortingCriteria)
    ScriptableRenderPass.CreateDrawingSettings(List<ShaderTagId>, ref RenderingData, SortingCriteria)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Rendering.Universal.Internal
    Assembly: Unity.RenderPipelines.Universal.Runtime.dll
    Syntax
    public class DrawObjectsPass : ScriptableRenderPass

    Constructors

    DrawObjectsPass(string, bool, RenderPassEvent, RenderQueueRange, LayerMask, StencilState, int)

    Creates a new DrawObjectsPass instance.

    Declaration
    public DrawObjectsPass(string profilerTag, bool opaque, RenderPassEvent evt, RenderQueueRange renderQueueRange, LayerMask layerMask, StencilState stencilState, int stencilReference)
    Parameters
    Type Name Description
    string profilerTag
    bool opaque
    RenderPassEvent evt
    RenderQueueRange renderQueueRange
    LayerMask layerMask
    StencilState stencilState
    int stencilReference
    See Also
    RenderPassEvent
    RenderQueueRange
    LayerMask
    StencilState

    DrawObjectsPass(string, ShaderTagId[], bool, RenderPassEvent, RenderQueueRange, LayerMask, StencilState, int)

    Creates a new DrawObjectsPass instance.

    Declaration
    public DrawObjectsPass(string profilerTag, ShaderTagId[] shaderTagIds, bool opaque, RenderPassEvent evt, RenderQueueRange renderQueueRange, LayerMask layerMask, StencilState stencilState, int stencilReference)
    Parameters
    Type Name Description
    string profilerTag
    ShaderTagId[] shaderTagIds
    bool opaque
    RenderPassEvent evt

    The RenderPassEvent to use.

    RenderQueueRange renderQueueRange
    LayerMask layerMask
    StencilState stencilState
    int stencilReference
    See Also
    ShaderTagId
    RenderPassEvent
    RenderQueueRange
    LayerMask
    StencilState

    Fields

    m_IsActiveTargetBackBuffer

    Used to indicate if the active target of the pass is the back buffer

    Declaration
    public bool m_IsActiveTargetBackBuffer
    Field Value
    Type Description
    bool

    m_ShouldTransparentsReceiveShadows

    Used to indicate whether transparent objects should receive shadows or not.

    Declaration
    public bool m_ShouldTransparentsReceiveShadows
    Field Value
    Type Description
    bool

    Methods

    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)

    OnExecute(CommandBuffer)

    Called before ExecutePass draws the objects.

    Declaration
    protected virtual void OnExecute(CommandBuffer cmd)
    Parameters
    Type Name Description
    CommandBuffer cmd

    The command buffer to use.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)