docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class CommandBufferDenoiser

    The Denoiser class exposes a public API for denoising images that are stored as render textures. The operations are asynchronous and are recorded in a command buffer.

    Inheritance
    object
    DenoiserBase
    CommandBufferDenoiser
    Inherited Members
    DenoiserBase.type
    DenoiserBase.filterHint
    DenoiserBase.IsDenoiserTypeSupported(DenoiserType)
    DenoiserBase.DisposeDenoiser()
    DenoiserBase.m_RequestWidth
    DenoiserBase.m_RequestHeight
    DenoiserBase.m_FilterHint
    DenoiserBase.m_Type
    DenoiserBase.m_InternalState
    DenoiserBase.udnCreateDenoiser(StringBuilder, int, int, int, int, int, DenoiserBase.FilterHint)
    DenoiserBase.udnDisposeDenoiser(IntPtr)
    DenoiserBase.udnGetResult(IntPtr, void*)
    DenoiserBase.udnDenoiseBuffer(IntPtr, StringBuilder, void*, GraphicsFormat)
    DenoiserBase.udnSetPath(IntPtr, StringBuilder)
    DenoiserBase.m_DenoiserBackend
    DenoiserBase.m_UseAOV
    DenoiserBase.m_Temporal
    DenoiserBase.m_ActiveBacked
    DenoiserBase.m_ActiveAOV
    DenoiserBase.m_ActiveWidth
    DenoiserBase.m_ActiveHeight
    DenoiserBase.m_TileWidth
    DenoiserBase.m_TileHeight
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Rendering.Denoising
    Assembly: Unity.Rendering.Denoising.Runtime.dll
    Syntax
    public class CommandBufferDenoiser : DenoiserBase

    Methods

    DenoiseRequest(CommandBuffer, string, RenderTexture)

    Create a denoise request using a render texture as input.

    Declaration
    public DenoiserBase.State DenoiseRequest(CommandBuffer cmd, string type, RenderTexture src)
    Parameters
    Type Name Description
    CommandBuffer cmd

    The command buffer where Unity records the denoise request.

    string type

    The type of data passed in the render texture. Supported options are color, albedo, normal, or flow.

    RenderTexture src

    The input texture used for denoising.

    Returns
    Type Description
    DenoiserBase.State

    The state of the denoising operation. The valid states are Success and Failure.

    GetResults(CommandBuffer, RenderTexture)

    Retrieve the results of a denoise request.

    Declaration
    public DenoiserBase.State GetResults(CommandBuffer cmd, RenderTexture dst)
    Parameters
    Type Name Description
    CommandBuffer cmd

    The command buffer where Unity records this operation.

    RenderTexture dst

    The destination texture that receives the denoise results.

    Returns
    Type Description
    DenoiserBase.State

    Returns the state of the operation, whether Success or Failure.

    Init(DenoiserType, int, int, int, int, FilterHint)

    Create a new denoiser.

    Declaration
    public DenoiserBase.State Init(DenoiserType type, int width, int height, int tileX = 0, int tileY = 0, DenoiserBase.FilterHint filterHint = FilterHint.Default)
    Parameters
    Type Name Description
    DenoiserType type

    The type of denoiser backend to create.

    int width

    The width of the image buffer to be denoised.

    int height

    The height of the image buffer to be denoised.

    int tileX

    Determines the width of tiles in pixels. 0 disables tiling. Use this parameter to divide the image buffer into tiles that match the amount of memory available on your GPU.

    int tileY

    Determines the height of tiles in pixels. 0 disables tiling. Use this parameter to divide the image buffer into tiles that match the amount of memory available on your GPU.

    DenoiserBase.FilterHint filterHint

    The type of filter to use in the denoising operations (default or lightmap)

    Returns
    Type Description
    DenoiserBase.State

    Returns the state of the operation, whether Success or Failure.

    QueryCompletion()

    Query the completion of a denoise request.

    Declaration
    public DenoiserBase.State QueryCompletion()
    Returns
    Type Description
    DenoiserBase.State

    Returns Executing if the denoising operation is not yet completed. If denoising is completed, returns Success or Failure.

    WaitForCompletion(ScriptableRenderContext, CommandBuffer)

    Wait until the denoise request has finished executing.

    Declaration
    public DenoiserBase.State WaitForCompletion(ScriptableRenderContext renderContext, CommandBuffer cmd)
    Parameters
    Type Name Description
    ScriptableRenderContext renderContext

    The scriptable render context used for rendering.

    CommandBuffer cmd

    The command buffer where Unity records this operation.

    Returns
    Type Description
    DenoiserBase.State

    Returns the state of the operation, whether Success or Failure.

    In This Article
    • Methods
      • DenoiseRequest(CommandBuffer, string, RenderTexture)
      • GetResults(CommandBuffer, RenderTexture)
      • Init(DenoiserType, int, int, int, int, FilterHint)
      • QueryCompletion()
      • WaitForCompletion(ScriptableRenderContext, CommandBuffer)
    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)