LumenViewState.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    LumenViewState.h:
=============================================================================*/
 
#pragma once
 
#include "RenderGraphResources.h"
#include "SceneTexturesConfig.h"
#include "Math/LFSR.h"
 
const static int32 NumLumenDiffuseIndirectTextures = 2;
// Must match shader
const static int32 MaxVoxelClipmapLevels = 8;
 
class FLumenGatherCvarState
{
public:
 
    FLumenGatherCvarState();
 
    int32 TraceMeshSDFs;
    float MeshSDFTraceDistance;
    float SurfaceBias;
    int32 VoxelTracingMode;
    int32 DirectLighting;
 
    inline bool operator==(const FLumenGatherCvarState& Rhs) const
    {
        return TraceMeshSDFs == Rhs.TraceMeshSDFs &&
            MeshSDFTraceDistance == Rhs.MeshSDFTraceDistance &&
            SurfaceBias == Rhs.SurfaceBias &&
            VoxelTracingMode == Rhs.VoxelTracingMode &&
            DirectLighting == Rhs.DirectLighting;
    }
};
 
class FScreenProbeGatherTemporalState
{
public:
    FIntRect DiffuseIndirectHistoryViewRect;
    FVector4f DiffuseIndirectHistoryScreenPositionScaleBias;
    FVector4f HistoryBufferSizeAndInvSize = FVector4f(0.0f, 0.0f, 0.0f, 0.0f);
    TRefCountPtr<IPooledRenderTarget> DiffuseIndirectHistoryRT;
    TRefCountPtr<IPooledRenderTarget> BackfaceDiffuseIndirectHistoryRT;
    TRefCountPtr<IPooledRenderTarget> RoughSpecularIndirectHistoryRT; 
    TRefCountPtr<IPooledRenderTarget> FastUpdateMode_NumFramesAccumulatedHistoryRT;
    TRefCountPtr<IPooledRenderTarget> ShortRangeAOHistoryRT;
    TRefCountPtr<IPooledRenderTarget> ShortRangeGIHistoryRT;
    FIntRect ProbeHistoryViewRect;
    FVector4f ProbeHistoryScreenPositionScaleBias;
    TRefCountPtr<IPooledRenderTarget> HistoryScreenProbeSceneDepth;
    TRefCountPtr<IPooledRenderTarget> HistoryScreenProbeTranslatedWorldPosition;
    TRefCountPtr<IPooledRenderTarget> ProbeHistoryScreenProbeRadiance;
    TRefCountPtr<IPooledRenderTarget> ImportanceSamplingHistoryScreenProbeRadiance;
    FLumenGatherCvarState LumenGatherCvars;
    FIntPoint HistoryEffectiveResolution;
    uint32 HistorySubstrateMaxClosureCount;
 
    FScreenProbeGatherTemporalState()
    {
        DiffuseIndirectHistoryViewRect = FIntRect(0, 0, 0, 0);
        DiffuseIndirectHistoryScreenPositionScaleBias = FVector4f(1, 1, 0, 0);
        ProbeHistoryViewRect = FIntRect(0, 0, 0, 0);
        ProbeHistoryScreenPositionScaleBias = FVector4f(1, 1, 0, 0);
        HistoryEffectiveResolution = FIntPoint(0,0);
        HistorySubstrateMaxClosureCount = 0;
    }
 
    void SafeRelease()
    {
        DiffuseIndirectHistoryRT.SafeRelease();
        BackfaceDiffuseIndirectHistoryRT.SafeRelease();
        RoughSpecularIndirectHistoryRT.SafeRelease();
        FastUpdateMode_NumFramesAccumulatedHistoryRT.SafeRelease();
        ShortRangeAOHistoryRT.SafeRelease();
        ShortRangeGIHistoryRT.SafeRelease();
        HistoryScreenProbeSceneDepth.SafeRelease();
        HistoryScreenProbeTranslatedWorldPosition.SafeRelease();
        ProbeHistoryScreenProbeRadiance.SafeRelease();
        ImportanceSamplingHistoryScreenProbeRadiance.SafeRelease();
    }
 
#if WITH_MGPU
    void AddCrossGPUTransfers(uint32 SourceGPUIndex, uint32 DestGPUIndex, TArray<FTransferResourceParams>& OutTransfers)
    {
        #define TRANSFER_LUMEN_RESOURCE(NAME) \
            if (NAME) OutTransfers.Add(FTransferResourceParams(NAME->GetRHI(), SourceGPUIndex, DestGPUIndex, false, false))
 
        TRANSFER_LUMEN_RESOURCE(DiffuseIndirectHistoryRT);
        TRANSFER_LUMEN_RESOURCE(RoughSpecularIndirectHistoryRT);
        TRANSFER_LUMEN_RESOURCE(FastUpdateMode_NumFramesAccumulatedHistoryRT);
        TRANSFER_LUMEN_RESOURCE(ShortRangeAOHistoryRT);
        TRANSFER_LUMEN_RESOURCE(ShortRangeGIHistoryRT);
        TRANSFER_LUMEN_RESOURCE(HistoryScreenProbeSceneDepth);
        TRANSFER_LUMEN_RESOURCE(HistoryScreenProbeTranslatedWorldPosition);
        TRANSFER_LUMEN_RESOURCE(ProbeHistoryScreenProbeRadiance);
        TRANSFER_LUMEN_RESOURCE(ImportanceSamplingHistoryScreenProbeRadiance);
 
        #undef TRANSFER_LUMEN_RESOURCE
    }
#endif  // WITH_MGPU
 
    uint64 GetGPUSizeBytes(bool bLogSizes) const;
};
 
class FReSTIRTemporalResamplingState
{
public:
 
    FIntRect HistoryViewRect;
    FVector4f HistoryScreenPositionScaleBias;
    FIntPoint HistoryReservoirViewSize;
    FIntPoint HistoryReservoirBufferSize;
    TRefCountPtr<IPooledRenderTarget> TemporalReservoirRayDirectionRT;
    TRefCountPtr<IPooledRenderTarget> TemporalReservoirTraceRadianceRT;
    TRefCountPtr<IPooledRenderTarget> TemporalReservoirTraceHitDistanceRT;
    TRefCountPtr<IPooledRenderTarget> TemporalReservoirTraceHitNormalRT;
    TRefCountPtr<IPooledRenderTarget> TemporalReservoirWeightsRT;
    TRefCountPtr<IPooledRenderTarget> DownsampledDepthHistoryRT;
    TRefCountPtr<IPooledRenderTarget> DownsampledNormalHistoryRT;
 
    FReSTIRTemporalResamplingState()
    {
        HistoryViewRect = FIntRect(0, 0, 0, 0);
        HistoryScreenPositionScaleBias = FVector4f(1, 1, 0, 0);
        HistoryReservoirViewSize = FIntPoint(0, 0);
        HistoryReservoirBufferSize = FIntPoint(0, 0);
    }
 
    void SafeRelease()
    {
        TemporalReservoirRayDirectionRT.SafeRelease();
        TemporalReservoirTraceRadianceRT.SafeRelease();
        TemporalReservoirTraceHitDistanceRT.SafeRelease();
        TemporalReservoirTraceHitNormalRT.SafeRelease();
        TemporalReservoirWeightsRT.SafeRelease();
        DownsampledDepthHistoryRT.SafeRelease();
        DownsampledNormalHistoryRT.SafeRelease();
    }
};
 
class FReSTIRTemporalAccumulationState
{
public:
    FIntRect DiffuseIndirectHistoryViewRect;
    FVector4f DiffuseIndirectHistoryScreenPositionScaleBias;
    TRefCountPtr<IPooledRenderTarget> DiffuseIndirectHistoryRT;
    TRefCountPtr<IPooledRenderTarget> RoughSpecularIndirectHistoryRT;
    TRefCountPtr<IPooledRenderTarget> ResolveVarianceHistoryRT;
    TRefCountPtr<IPooledRenderTarget> NumFramesAccumulatedRT;
    FIntPoint HistorySceneTexturesExtent;
    FIntPoint HistoryEffectiveResolution;
 
    FReSTIRTemporalAccumulationState()
    {
        DiffuseIndirectHistoryViewRect = FIntRect(0, 0, 0, 0);
        DiffuseIndirectHistoryScreenPositionScaleBias = FVector4f(1, 1, 0, 0);
    }
 
    void SafeRelease()
    {
        DiffuseIndirectHistoryRT.SafeRelease();
        RoughSpecularIndirectHistoryRT.SafeRelease();
        ResolveVarianceHistoryRT.SafeRelease();
        NumFramesAccumulatedRT.SafeRelease();
    }
};
 
class FReSTIRGatherTemporalState
{
public:
 
    FReSTIRTemporalResamplingState TemporalResamplingState;
    FReSTIRTemporalAccumulationState TemporalAccumulationState;
 
    void SafeRelease()
    {
        TemporalResamplingState.SafeRelease();
        TemporalAccumulationState.SafeRelease();
    }
};
 
class FReflectionTemporalState
{
public:
    TRefCountPtr<IPooledRenderTarget> SpecularAndSecondMomentHistory;
    TRefCountPtr<IPooledRenderTarget> NumFramesAccumulatedHistory;
 
    // Only valid for Front Layer Transparency
    TRefCountPtr<IPooledRenderTarget> LayerSceneDepthHistory;
    TRefCountPtr<IPooledRenderTarget> LayerSceneNormalHistory;
 
    uint32 HistoryFrameIndex = 0;
    FIntRect HistoryViewRect = FIntRect(0, 0, 0, 0);
    FVector4f HistoryScreenPositionScaleBias = FVector4f(1.0f, 1.0f, 0.0f, 0.0f);
    FVector4f HistoryUVMinMax = FVector4f(0.0f, 0.0f, 0.0f, 0.0f);
    FVector4f HistoryGatherUVMinMax = FVector4f(0.0f, 0.0f, 0.0f, 0.0f);
    FVector4f HistoryBufferSizeAndInvSize = FVector4f(0.0f, 0.0f, 0.0f, 0.0f);
 
    void SafeRelease()
    {
        SpecularAndSecondMomentHistory.SafeRelease();
        NumFramesAccumulatedHistory.SafeRelease();
 
        LayerSceneDepthHistory.SafeRelease();
        LayerSceneNormalHistory.SafeRelease();
    }
 
#if WITH_MGPU
    void AddCrossGPUTransfers(uint32 SourceGPUIndex, uint32 DestGPUIndex, TArray<FTransferResourceParams>& OutTransfers)
    {
        #define TRANSFER_LUMEN_RESOURCE(NAME) \
            if (NAME) OutTransfers.Add(FTransferResourceParams(NAME->GetRHI(), SourceGPUIndex, DestGPUIndex, false, false))
 
        TRANSFER_LUMEN_RESOURCE(SpecularAndSecondMomentHistory);
        TRANSFER_LUMEN_RESOURCE(NumFramesAccumulatedHistory);
 
        TRANSFER_LUMEN_RESOURCE(LayerSceneDepthHistory);
        TRANSFER_LUMEN_RESOURCE(LayerSceneNormalHistory);
 
        #undef TRANSFER_LUMEN_RESOURCE
    }
#endif  // WITH_MGPU
 
    uint64 GetGPUSizeBytes(bool bLogSizes) const;
};
 
class FRadianceCacheClipmap
{
public:
    FVector Center;
    float Extent;
 
    FVector3d CornerWorldSpace;
    FVector3f CornerTranslatedWorldSpace;
 
    float ProbeTMin;
 
    FVector VolumeUVOffset;
 
    /* Distance between two probes. */
    float CellSize;
};
 
class FRadianceCacheState
{
public:
    FRadianceCacheState()
    {}
 
    TArray<FRadianceCacheClipmap> Clipmaps;
 
    float ClipmapWorldExtent = 0.0f;
    float ClipmapDistributionBase = 0.0f;
    float CachedLightingPreExposure = 0.0f;
 
    TRefCountPtr<IPooledRenderTarget> RadianceProbeIndirectionTexture;
 
    TRefCountPtr<IPooledRenderTarget> RadianceProbeAtlasTexture;
    TRefCountPtr<IPooledRenderTarget> SkyVisibilityProbeAtlasTexture;
    TRefCountPtr<IPooledRenderTarget> FinalRadianceAtlas;
    TRefCountPtr<IPooledRenderTarget> FinalSkyVisibilityAtlas;
    TRefCountPtr<IPooledRenderTarget> FinalIrradianceAtlas;
    TRefCountPtr<IPooledRenderTarget> ProbeOcclusionAtlas;
 
    TRefCountPtr<IPooledRenderTarget> DepthProbeAtlasTexture;
 
    TRefCountPtr<FRDGPooledBuffer> ProbeAllocator;
    TRefCountPtr<FRDGPooledBuffer> ProbeFreeListAllocator;
    TRefCountPtr<FRDGPooledBuffer> ProbeFreeList;
    TRefCountPtr<FRDGPooledBuffer> ProbeLastUsedFrame;
    TRefCountPtr<FRDGPooledBuffer> ProbeLastTracedFrame;
    TRefCountPtr<FRDGPooledBuffer> ProbeWorldOffset;
 
    void ReleaseTextures()
    {
        RadianceProbeIndirectionTexture.SafeRelease();
        RadianceProbeAtlasTexture.SafeRelease();
        SkyVisibilityProbeAtlasTexture.SafeRelease();
        FinalRadianceAtlas.SafeRelease();
        FinalSkyVisibilityAtlas.SafeRelease();
        FinalIrradianceAtlas.SafeRelease();
        ProbeOcclusionAtlas.SafeRelease();
        DepthProbeAtlasTexture.SafeRelease();
        ProbeAllocator.SafeRelease();
        ProbeFreeListAllocator.SafeRelease();
        ProbeFreeList.SafeRelease();
        ProbeLastUsedFrame.SafeRelease();
        ProbeLastTracedFrame.SafeRelease();
        ProbeWorldOffset.SafeRelease();
    }
 
#if WITH_MGPU
    void AddCrossGPUTransfers(uint32 SourceGPUIndex, uint32 DestGPUIndex, TArray<FTransferResourceParams>& OutTransfers)
    {
        #define TRANSFER_LUMEN_RESOURCE(NAME) \
            if (NAME) OutTransfers.Add(FTransferResourceParams(NAME->GetRHI(), SourceGPUIndex, DestGPUIndex, false, false))
 
        TRANSFER_LUMEN_RESOURCE(RadianceProbeIndirectionTexture);
        TRANSFER_LUMEN_RESOURCE(RadianceProbeAtlasTexture);
        TRANSFER_LUMEN_RESOURCE(SkyVisibilityProbeAtlasTexture);
        TRANSFER_LUMEN_RESOURCE(FinalRadianceAtlas);
        TRANSFER_LUMEN_RESOURCE(FinalIrradianceAtlas);
        TRANSFER_LUMEN_RESOURCE(ProbeOcclusionAtlas);
        TRANSFER_LUMEN_RESOURCE(DepthProbeAtlasTexture);
        TRANSFER_LUMEN_RESOURCE(ProbeAllocator);
        TRANSFER_LUMEN_RESOURCE(ProbeFreeListAllocator);
        TRANSFER_LUMEN_RESOURCE(ProbeFreeList);
        TRANSFER_LUMEN_RESOURCE(ProbeLastUsedFrame);
        TRANSFER_LUMEN_RESOURCE(ProbeLastTracedFrame);
        TRANSFER_LUMEN_RESOURCE(ProbeWorldOffset);
 
        #undef TRANSFER_LUMEN_RESOURCE
    }
#endif  // WITH_MGPU
 
    uint64 GetGPUSizeBytes(bool bLogSizes) const;
};
 
class FLumenViewState
{
public:
 
    FScreenProbeGatherTemporalState ScreenProbeGatherState;
    FReSTIRGatherTemporalState ReSTIRGatherState;
    FReflectionTemporalState ReflectionState;
    FReflectionTemporalState TranslucentReflectionState;
    FReflectionTemporalState WaterReflectionState;
 
    // Translucency
    TRefCountPtr<IPooledRenderTarget> TranslucencyVolume0;
    TRefCountPtr<IPooledRenderTarget> TranslucencyVolume1;
 
    FRadianceCacheState RadianceCacheState;
    FRadianceCacheState TranslucencyVolumeRadianceCacheState;
 
    void SafeRelease()
    {
        ScreenProbeGatherState.SafeRelease();
        ReSTIRGatherState.SafeRelease();
        ReflectionState.SafeRelease();
        TranslucentReflectionState.SafeRelease();
        WaterReflectionState.SafeRelease();
 
        TranslucencyVolume0.SafeRelease();
        TranslucencyVolume1.SafeRelease();
 
        RadianceCacheState.ReleaseTextures();
        TranslucencyVolumeRadianceCacheState.ReleaseTextures();
    }
 
#if WITH_MGPU
    void AddCrossGPUTransfers(uint32 SourceGPUIndex, uint32 DestGPUIndex, TArray<FTransferResourceParams>& OutTransfers)
    {
        #define TRANSFER_LUMEN_RESOURCE(NAME) \
            if (NAME) OutTransfers.Add(FTransferResourceParams(NAME->GetRHI(), SourceGPUIndex, DestGPUIndex, false, false))
 
        TRANSFER_LUMEN_RESOURCE(TranslucencyVolume0);
        TRANSFER_LUMEN_RESOURCE(TranslucencyVolume1);
 
        #undef TRANSFER_LUMEN_RESOURCE
 
        ScreenProbeGatherState.AddCrossGPUTransfers(SourceGPUIndex, DestGPUIndex, OutTransfers);
        ReflectionState.AddCrossGPUTransfers(SourceGPUIndex, DestGPUIndex, OutTransfers);
        TranslucentReflectionState.AddCrossGPUTransfers(SourceGPUIndex, DestGPUIndex, OutTransfers);
        RadianceCacheState.AddCrossGPUTransfers(SourceGPUIndex, DestGPUIndex, OutTransfers);
        TranslucencyVolumeRadianceCacheState.AddCrossGPUTransfers(SourceGPUIndex, DestGPUIndex, OutTransfers);
    }
#endif  // WITH_MGPU
 
    uint64 GetGPUSizeBytes(bool bLogSizes) const;
};
 
BEGIN_GLOBAL_SHADER_PARAMETER_STRUCT(FLumenCardPassUniformParameters, RENDERER_API)
    SHADER_PARAMETER_STRUCT(FSceneTextureUniformParameters, SceneTextures)
    SHADER_PARAMETER_RDG_BUFFER_SRV(StructuredBuffer<float4>, EyeAdaptationBuffer)
    SHADER_PARAMETER(float, CachedLightingPreExposure)
END_GLOBAL_SHADER_PARAMETER_STRUCT()