Class ScriptableRenderPass | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class ScriptableRenderPass

    Inheritance
    System.Object
    ScriptableRenderPass
    DepthOnlyPass
    DirectionalShadowsPass
    ForwardLitPass
    LocalShadowsPass
    ScreenSpaceShadowResolvePass
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: UnityEngine.Experimental.Rendering.LightweightPipeline
    Syntax
    public abstract class ScriptableRenderPass

    Constructors

    ScriptableRenderPass(LightweightForwardRenderer)

    Declaration
    public ScriptableRenderPass(LightweightForwardRenderer renderer)
    Parameters
    Type Name Description
    LightweightForwardRenderer renderer

    Fields

    m_ShaderPassNames

    Declaration
    protected List<ShaderPassName> m_ShaderPassNames
    Field Value
    Type Description
    List<ShaderPassName>

    Properties

    colorAttachmentHandle

    Declaration
    public int colorAttachmentHandle { get; }
    Property Value
    Type Description
    System.Int32

    colorAttachmentHandles

    Declaration
    public int[] colorAttachmentHandles { get; }
    Property Value
    Type Description
    System.Int32[]

    depthAttachmentHandle

    Declaration
    public int depthAttachmentHandle { get; }
    Property Value
    Type Description
    System.Int32

    renderer

    Declaration
    public LightweightForwardRenderer renderer { get; }
    Property Value
    Type Description
    LightweightForwardRenderer

    samples

    Declaration
    public int samples { get; }
    Property Value
    Type Description
    System.Int32

    textureDimension

    Declaration
    public TextureDimension textureDimension { get; }
    Property Value
    Type Description
    TextureDimension

    Methods

    CreateDrawRendererSettings(Camera, SortFlags, RendererConfiguration, Boolean)

    Declaration
    public DrawRendererSettings CreateDrawRendererSettings(Camera camera, SortFlags sortFlags, RendererConfiguration rendererConfiguration, bool supportsDynamicBatching)
    Parameters
    Type Name Description
    Camera camera
    SortFlags sortFlags
    RendererConfiguration rendererConfiguration
    System.Boolean supportsDynamicBatching
    Returns
    Type Description
    DrawRendererSettings

    Dispose(CommandBuffer)

    Declaration
    public virtual void Dispose(CommandBuffer cmd)
    Parameters
    Type Name Description
    CommandBuffer cmd

    Execute(ref ScriptableRenderContext, ref CullResults, ref RenderingData)

    Declaration
    public abstract void Execute(ref ScriptableRenderContext context, ref CullResults cullResults, ref RenderingData renderingData)
    Parameters
    Type Name Description
    ScriptableRenderContext context
    CullResults cullResults
    RenderingData renderingData

    GetSurface(Int32)

    Declaration
    public RenderTargetIdentifier GetSurface(int handle)
    Parameters
    Type Name Description
    System.Int32 handle
    Returns
    Type Description
    RenderTargetIdentifier

    RegisterShaderPassName(String)

    Declaration
    public void RegisterShaderPassName(string passName)
    Parameters
    Type Name Description
    System.String passName

    SetRenderTarget(CommandBuffer, RenderTargetIdentifier, RenderBufferLoadAction, RenderBufferStoreAction, ClearFlag, Color)

    Declaration
    public void SetRenderTarget(CommandBuffer cmd, RenderTargetIdentifier colorAttachment, RenderBufferLoadAction colorLoadAction, RenderBufferStoreAction colorStoreAction, ClearFlag clearFlag, Color clearColor)
    Parameters
    Type Name Description
    CommandBuffer cmd
    RenderTargetIdentifier colorAttachment
    RenderBufferLoadAction colorLoadAction
    RenderBufferStoreAction colorStoreAction
    ClearFlag clearFlag
    Color clearColor

    SetRenderTarget(CommandBuffer, RenderTargetIdentifier, RenderBufferLoadAction, RenderBufferStoreAction, RenderTargetIdentifier, RenderBufferLoadAction, RenderBufferStoreAction, ClearFlag, Color)

    Declaration
    public void SetRenderTarget(CommandBuffer cmd, RenderTargetIdentifier colorAttachment, RenderBufferLoadAction colorLoadAction, RenderBufferStoreAction colorStoreAction, RenderTargetIdentifier depthAttachment, RenderBufferLoadAction depthLoadAction, RenderBufferStoreAction depthStoreAction, ClearFlag clearFlag, Color clearColor)
    Parameters
    Type Name Description
    CommandBuffer cmd
    RenderTargetIdentifier colorAttachment
    RenderBufferLoadAction colorLoadAction
    RenderBufferStoreAction colorStoreAction
    RenderTargetIdentifier depthAttachment
    RenderBufferLoadAction depthLoadAction
    RenderBufferStoreAction depthStoreAction
    ClearFlag clearFlag
    Color clearColor

    Setup(CommandBuffer, RenderTextureDescriptor, Int32[], Int32, Int32)

    Declaration
    public virtual void Setup(CommandBuffer cmd, RenderTextureDescriptor baseDescriptor, int[] colorAttachmentHandles = null, int depthAttachmentHandle = -1, int samples = 1)
    Parameters
    Type Name Description
    CommandBuffer cmd
    RenderTextureDescriptor baseDescriptor
    System.Int32[] colorAttachmentHandles
    System.Int32 depthAttachmentHandle
    System.Int32 samples
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023