docs.unity3d.com
    Show / Hide Table of Contents

    Class FullScreenCustomPass

    FullScreen Custom Pass

    Inheritance
    Object
    CustomPass
    FullScreenCustomPass
    Inherited Members
    CustomPass.name
    CustomPass.enabled
    CustomPass.targetColorBuffer
    CustomPass.targetDepthBuffer
    CustomPass.clearFlags
    CustomPass.fadeValue
    CustomPass.injectionPoint
    CustomPass.executeInSceneView
    CustomPass.IVersionable<CustomPass.Version>.version
    CustomPass.AggregateCullingParameters(ScriptableCullingParameters, HDCamera)
    CustomPass.Execute(ScriptableRenderContext, CommandBuffer, HDCamera, CullingResults)
    CustomPass.Cleanup()
    CustomPass.SetCameraRenderTarget(CommandBuffer, Boolean, ClearFlag)
    CustomPass.SetCustomRenderTarget(CommandBuffer, Boolean, ClearFlag)
    CustomPass.SetRenderTargetAuto(CommandBuffer)
    CustomPass.ResolveMSAAColorBuffer(CommandBuffer, HDCamera)
    CustomPass.ResolveMSAAColorBuffer(CustomPassContext)
    CustomPass.GetCameraBuffers(RTHandle, RTHandle)
    CustomPass.GetCustomBuffers(RTHandle, RTHandle)
    CustomPass.GetNormalBuffer()
    CustomPass.GetRenderQueueRange(CustomPass.RenderQueueType)
    CustomPass.CreateFullScreenPass(Material, CustomPass.TargetBuffer, CustomPass.TargetBuffer)
    CustomPass.CreateDrawRenderersPass(CustomPass.RenderQueueType, LayerMask, Material, String, SortingCriteria, ClearFlag, CustomPass.TargetBuffer, CustomPass.TargetBuffer)
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    public class FullScreenCustomPass : CustomPass, IVersionable<CustomPass.Version>

    Fields

    fetchColorBuffer

    Set to true if your shader will sample in the camera color buffer.

    Declaration
    public bool fetchColorBuffer
    Field Value
    Type Description
    Boolean

    fullscreenPassMaterial

    Material used for the fullscreen pass, it's shader must have been created with.

    Declaration
    public Material fullscreenPassMaterial
    Field Value
    Type Description
    Material

    materialPassName

    Name of the pass to use in the fullscreen material.

    Declaration
    public string materialPassName
    Field Value
    Type Description
    String

    Methods

    Execute(CustomPassContext)

    Execute the pass with the fullscreen setup

    Declaration
    protected override void Execute(CustomPassContext ctx)
    Parameters
    Type Name Description
    CustomPassContext ctx

    The context of the custom pass. Contains command buffer, render context, buffer, etc.

    Overrides
    CustomPass.Execute(CustomPassContext)

    RegisterMaterialForInspector()

    List all the materials that need to be displayed at the bottom of the component. All the materials gathered by this method will be used to create a Material Editor and then can be edited directly on the custom pass.

    Declaration
    public override IEnumerable<Material> RegisterMaterialForInspector()
    Returns
    Type Description
    IEnumerable<Material>

    An enumerable of materials to show in the inspector. These materials can be null, the list is cleaned afterwards

    Overrides
    CustomPass.RegisterMaterialForInspector()

    Setup(ScriptableRenderContext, CommandBuffer)

    Called before the first execution of the pass occurs. Allow you to allocate custom buffers.

    Declaration
    protected override void Setup(ScriptableRenderContext renderContext, CommandBuffer cmd)
    Parameters
    Type Name Description
    ScriptableRenderContext renderContext

    The render context

    CommandBuffer cmd

    Current command buffer of the frame

    Overrides
    CustomPass.Setup(ScriptableRenderContext, CommandBuffer)
    Back to top
    Terms of use
    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