PathTracingDenoiser.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "MultiGPU.h"
#include "Templates/RefCounting.h"
#include "Templates/UniquePtr.h"
 
class FSceneView;
class FRDGBuilder;
class FRDGTexture;
class FRHICommandListImmediate;
 
using FRDGTextureRef = FRDGTexture*;
 
namespace UE::Renderer::Private
{
 
class IPathTracingDenoiser
{
public:
 
    struct FInputs
    {
        FRDGTextureRef ColorTex;
        FRDGTextureRef AlbedoTex;
        FRDGTextureRef NormalTex;
        FRDGTextureRef OutputTex;
    };
 
    virtual ~IPathTracingDenoiser() {}
 
    virtual bool NeedTextureCreateExtraFlags() const { return false; }
 
    virtual void AddPasses(FRDGBuilder& GraphBuilder, const FSceneView& View, const FInputs& Inputs) const = 0;
};
 
class IPathTracingSpatialTemporalDenoiser
{
public:
 
    class IHistory : public FRefCountBase //IRefCountedObject
    {
    public:
        virtual ~IHistory() {}
 
        virtual const TCHAR* GetDebugName() const = 0;
    };
 
    struct FInputs
    {
        FRDGTextureRef ColorTex;
        FRDGTextureRef AlbedoTex;
        FRDGTextureRef NormalTex;
        FRDGTextureRef DepthTex;
        FRDGTextureRef VarianceTex;
        FRDGTextureRef OutputTex;
 
        FRDGTextureRef FlowTex;
        FRDGTextureRef PreviousOutputTex;
 
        int DenoisingFrameId = -1;
        bool bForceSpatialDenoiserOnly = false;
 
        TRefCountPtr<IHistory> PrevHistory;
    };
 
    struct FMotionVectorInputs
    {
        FRDGTextureRef InputFrameTex;
        FRDGTextureRef ReferenceFrameTex;
        FRDGTextureRef OutputTex;
        float PreExposure = 1.0f;
    };
 
    struct FOutputs
    {
        TRefCountPtr<IHistory> NewHistory;
    };
 
    virtual ~IPathTracingSpatialTemporalDenoiser() {}
 
    virtual const TCHAR* GetDebugName() const = 0;
 
    virtual bool NeedTextureCreateExtraFlags() const { return false; }
 
    virtual bool NeedVarianceTexture() const { return false;}
 
    virtual FOutputs AddPasses(FRDGBuilder& GraphBuilder, const FSceneView& View, const FInputs& Inputs) const = 0;
 
    virtual void AddMotionVectorPass(FRDGBuilder& GraphBuilder, const FSceneView& View, const FMotionVectorInputs& Inputs) const = 0;
};
 
} // namespace UE::Renderer::Private
 
UE_DEPRECATED(5.5, "GPathTracingDenoiserPlugin is deprecated. Use RegisterSpatialDenoiser/RegisterSpatialTemporalDenoiser to register")
extern RENDERER_API TUniquePtr<UE::Renderer::Private::IPathTracingDenoiser> GPathTracingDenoiserPlugin;
 
UE_DEPRECATED(5.5, "GPathTracingSpatialTemporalDenoiserPlugin is deprecated. Use RegisterSpatialDenoiser/RegisterSpatialTemporalDenoiser to register")
extern RENDERER_API TUniquePtr<UE::Renderer::Private::IPathTracingSpatialTemporalDenoiser> GPathTracingSpatialTemporalDenoiserPlugin;
 
extern RENDERER_API void RegisterSpatialDenoiser(TUniquePtr<UE::Renderer::Private::IPathTracingDenoiser> PathTracingDenoiser, FString Name);
 
extern RENDERER_API void RegisterSpatialTemporalDenoiser(TUniquePtr<UE::Renderer::Private::IPathTracingSpatialTemporalDenoiser> PathTracingDenoiser, FString Name);
 
extern RENDERER_API void UnregisterDenoiser(FString Name);
 
extern RENDERER_API bool HasTemporalDenoiser();