PostProcessMaterialInputs.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "SceneTexturesConfig.h"
#include "ScreenPass.h"
 
struct FSceneWithoutWaterTextures;
 
const uint32 kPostProcessMaterialInputCountMax = 5;
const uint32 kPathTracingPostProcessMaterialInputCountMax = 5;
 
enum class EPostProcessMaterialInput : uint32
{
    // Always Active. Color from the previous stage of the post process chain.
    SceneColor = 0,
 
    // Always Active.
    SeparateTranslucency = 1,
 
    // Replace Tonemap Only. Half resolution combined bloom input.
    CombinedBloom = 2,
 
    // Buffer Visualization Only.
    PreTonemapHDRColor = 2,
    PostTonemapHDRColor = 3,
 
    // Active if separate velocity pass is used--i.e. not part of base pass; Not active during Replace Tonemap.
    Velocity = 4
};
 
enum class EPathTracingPostProcessMaterialInput : uint32
{
    Radiance = 0,
    DenoisedRadiance = 1,
    Albedo = 2,
    Normal = 3,
    Variance = 4
};
 
struct FPostProcessMaterialInputs
{
    FPostProcessMaterialInputs()
    {
        FMemory::Memset(bUserSceneTexturesSet, 0);
    }
 
    inline void SetInput(FRDGBuilder& GraphBuilder, EPostProcessMaterialInput Input, FScreenPassTexture Texture)
    {
        SetInput(Input, FScreenPassTextureSlice::CreateFromScreenPassTexture(GraphBuilder, Texture));
    }
 
    inline void SetInput(EPostProcessMaterialInput Input, FScreenPassTextureSlice Texture)
    {
        check((uint32)Input < kPostProcessMaterialInputCountMax);
 
        Textures[(uint32)Input] = Texture;
    }
 
    inline void SetUserSceneTextureInput(EPostProcessMaterialInput Input, FScreenPassTextureSlice Texture)
    {
        check((uint32)Input < kPostProcessMaterialInputCountMax);
 
        UserSceneTextures[(uint32)Input] = Texture;
        bUserSceneTexturesSet[(uint32)Input] = true;
    }
 
    inline FScreenPassTextureSlice GetInput(EPostProcessMaterialInput Input) const
    {
        return bUserSceneTexturesSet[(uint32)Input] ? UserSceneTextures[(uint32)Input] : Textures[(uint32)Input];
    }
 
    inline FScreenPassTextureSlice GetSceneColorOutput(EBlendableLocation BlendableLocation) const
    {
        return Textures[(uint32)(BlendableLocation == BL_TranslucencyAfterDOF ? EPostProcessMaterialInput::SeparateTranslucency : EPostProcessMaterialInput::SceneColor)];
    }
 
    inline void SetPathTracingInput(EPathTracingPostProcessMaterialInput Input, FScreenPassTexture Texture)
    {
        PathTracingTextures[(uint32)Input] = Texture;
    }
 
    inline FScreenPassTexture GetPathTracingInput(EPathTracingPostProcessMaterialInput Input) const
    {
        return PathTracingTextures[(uint32)Input];
    }
 
    inline void Validate() const
    {
        ValidateInputExists(EPostProcessMaterialInput::SceneColor);
        
        // TODO:  Is separate translucency always guaranteeed to be present?  A previous version of the code appeared to be attempting to validate this, but
        //        due to a bug (ValidateInputExists ignoring its Input argument and instead validating EPostProcessMaterialInput::SceneColor regardless of
        //        what was passed in), didn't actually do so.  I'm afraid to enable this assert now, as I don't know if it will randomly crash some project.
        // ValidateInputExists(EPostProcessMaterialInput::SeparateTranslucency);
 
        // Either override output format is valid or the override output texture is; not both.
        if (OutputFormat != PF_Unknown)
        {
            check(OverrideOutput.Texture == nullptr);
        }
        if (OverrideOutput.Texture)
        {
            check(OutputFormat == PF_Unknown);
        }
 
        check(SceneTextures.SceneTextures || SceneTextures.MobileSceneTextures);
    }
 
    inline void ValidateInputExists(EPostProcessMaterialInput Input) const
    {
        check(Textures[(int32)Input].IsValid());
    }
 
    RENDERER_API FScreenPassTexture ReturnUntouchedSceneColorForPostProcessing(FRDGBuilder& GraphBuilder) const;
 
    // [Optional] Render to the specified output. If invalid, a new texture is created and returned.
    FScreenPassRenderTarget OverrideOutput;
 
    TStaticArray<FScreenPassTextureSlice, kPostProcessMaterialInputCountMax> Textures;
 
    TStaticArray<FScreenPassTextureSlice, kPostProcessMaterialInputCountMax> UserSceneTextures;
    TStaticArray<bool, kPostProcessMaterialInputCountMax> bUserSceneTexturesSet;
 
    TStaticArray<FScreenPassTexture, kPathTracingPostProcessMaterialInputCountMax> PathTracingTextures;
 
    EPixelFormat OutputFormat = PF_Unknown;
 
    bool bManualStencilTest = false;
 
    FRDGTextureRef CustomDepthTexture = nullptr;
 
    FSceneTextureShaderParameters SceneTextures;
 
    const FSceneWithoutWaterTextures* SceneWithoutWaterTextures = nullptr;
 
    bool bAllowSceneColorInputAsOutput = true;
 
    bool bMetalMSAAHDRDecode = false;
 
    bool bUserSceneTextureOutput = false;
    bool bUserSceneTextureFirstRender = false;
    uint32 UserSceneTextureSceneColorInput = INDEX_NONE;
};
 
class UMaterialInterface;
 
FScreenPassTexture RENDERER_API AddPostProcessMaterialPass(
    FRDGBuilder& GraphBuilder,
    const FSceneView& View,
    const FPostProcessMaterialInputs& Inputs,
    const UMaterialInterface* MaterialInterface);