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

    Class RenderGraph

    Inheritance
    System.Object
    RenderGraph
    Namespace: UnityEngine.Experimental.Rendering.RenderGraphModule
    Syntax
    public class RenderGraph

    Constructors

    RenderGraph(Boolean, MSAASamples)

    Declaration
    public RenderGraph(bool supportMSAA, MSAASamples initialSampleCount)
    Parameters
    Type Name Description
    System.Boolean supportMSAA
    MSAASamples initialSampleCount

    Fields

    kMaxMRTCount

    Declaration
    public static readonly int kMaxMRTCount
    Field Value
    Type Description
    System.Int32

    Properties

    enabled

    Declaration
    public bool enabled { get; }
    Property Value
    Type Description
    System.Boolean

    rtHandleProperties

    Declaration
    public RTHandleProperties rtHandleProperties { get; }
    Property Value
    Type Description
    RTHandleProperties

    Methods

    AddRenderPass<PassData>(String, out PassData, CustomSampler)

    Declaration
    public RenderGraphBuilder AddRenderPass<PassData>(string passName, out PassData passData, CustomSampler customSampler = null)
        where PassData : class, new()
    Parameters
    Type Name Description
    System.String passName
    PassData passData
    CustomSampler customSampler
    Returns
    Type Description
    RenderGraphBuilder
    Type Parameters
    Name Description
    PassData

    Cleanup()

    Declaration
    public void Cleanup()

    CreateRendererList(RendererListDesc)

    Declaration
    public RenderGraphResource CreateRendererList(in RendererListDesc desc)
    Parameters
    Type Name Description
    RendererListDesc desc
    Returns
    Type Description
    RenderGraphResource

    CreateTexture(RenderGraphResource, Int32)

    Declaration
    public RenderGraphMutableResource CreateTexture(in RenderGraphResource texture, int shaderProperty = 0)
    Parameters
    Type Name Description
    RenderGraphResource texture
    System.Int32 shaderProperty
    Returns
    Type Description
    RenderGraphMutableResource

    CreateTexture(TextureDesc, Int32)

    Declaration
    public RenderGraphMutableResource CreateTexture(TextureDesc desc, int shaderProperty = 0)
    Parameters
    Type Name Description
    TextureDesc desc
    System.Int32 shaderProperty
    Returns
    Type Description
    RenderGraphMutableResource

    Execute(ScriptableRenderContext, CommandBuffer, RenderGraphExecuteParams)

    Declaration
    public void Execute(ScriptableRenderContext renderContext, CommandBuffer cmd, in RenderGraphExecuteParams parameters)
    Parameters
    Type Name Description
    ScriptableRenderContext renderContext
    CommandBuffer cmd
    RenderGraphExecuteParams parameters

    GetTextureDesc(RenderGraphResource)

    Declaration
    public TextureDesc GetTextureDesc(in RenderGraphResource texture)
    Parameters
    Type Name Description
    RenderGraphResource texture
    Returns
    Type Description
    TextureDesc

    ImportTexture(RTHandle, Int32)

    Declaration
    public RenderGraphMutableResource ImportTexture(RTHandle rt, int shaderProperty = 0)
    Parameters
    Type Name Description
    RTHandle rt
    System.Int32 shaderProperty
    Returns
    Type Description
    RenderGraphMutableResource

    RegisterDebug()

    Declaration
    public void RegisterDebug()

    UnRegisterDebug()

    Declaration
    public void UnRegisterDebug()
    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