GPUSceneWriter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "ShaderParameterMacros.h"
#include "ShaderParameters.h"
#include "MeshBatch.h"
#include "RenderGraphFwd.h"
#include "SceneManagement.h"
 
class FSceneView;
class FRDGBuilder;
class FMeshElementCollector;
 
DECLARE_UNIFORM_BUFFER_STRUCT(FGPUSceneWriterUniformParameters, RENDERER_API)
 
 
#if ENABLE_SCENE_DATA_DX11_UB_ERROR_WORKAROUND
 
// Parameter sub struct that is common to all parameter use-cases
BEGIN_SHADER_PARAMETER_STRUCT(FGPUSceneCommonParameters, RENDERER_API)
    SHADER_PARAMETER(uint32, GPUSceneInstanceDataTileSizeLog2)
    SHADER_PARAMETER(uint32, GPUSceneInstanceDataTileSizeMask)
    SHADER_PARAMETER(uint32, GPUSceneInstanceDataTileStride)
    SHADER_PARAMETER(uint32, GPUSceneFrameNumber)
    SHADER_PARAMETER(int32, GPUSceneMaxAllocatedInstanceId)
    SHADER_PARAMETER(int32, GPUSceneMaxPersistentPrimitiveIndex)
    SHADER_PARAMETER(int32, GPUSceneNumLightmapDataItems)
END_SHADER_PARAMETER_STRUCT()
 
#endif
 
BEGIN_SHADER_PARAMETER_STRUCT(FGPUSceneWriterParameters, RENDERER_API)
    SHADER_PARAMETER_RDG_BUFFER_UAV(RWStructuredBuffer<float4>, GPUSceneInstanceSceneDataRW)
    SHADER_PARAMETER_RDG_BUFFER_UAV(RWStructuredBuffer<float4>, GPUSceneInstancePayloadDataRW)
    SHADER_PARAMETER_RDG_BUFFER_UAV(RWStructuredBuffer<float4>, GPUScenePrimitiveSceneDataRW)
    SHADER_PARAMETER(uint32, GPUSceneInstanceSceneDataSOAStride)
    SHADER_PARAMETER(uint32, GPUSceneNumAllocatedInstances)
    SHADER_PARAMETER(uint32, GPUSceneNumAllocatedPrimitives)
 
    SHADER_PARAMETER_RDG_UNIFORM_BUFFER(FGPUSceneWriterUniformParameters, GPUSceneWriterUB)
#if ENABLE_SCENE_DATA_DX11_UB_ERROR_WORKAROUND
    SHADER_PARAMETER_STRUCT_INCLUDE(FGPUSceneCommonParameters, CommonParameters)
#else
    // This is retained purely for backwards API compatibility
    SHADER_PARAMETER(uint32, GPUSceneFrameNumber)
#endif
 
END_SHADER_PARAMETER_STRUCT()
 
 
struct FGPUSceneWriteDelegateParams
{
    uint32 PersistentPrimitiveId = (uint32)INDEX_NONE;
    uint32 InstanceSceneDataOffset = (uint32)INDEX_NONE;
    uint32 NumCustomDataFloats = (uint32)INDEX_NONE;
    uint32 PackedInstanceSceneDataFlags = 0u;
    EGPUSceneGPUWritePass GPUWritePass = EGPUSceneGPUWritePass::None;
    FSceneView* View = nullptr;
    UE_DEPRECATED(5.6, "Only the opaque UB (see GPUSceneWriterUB below) should be referenced")
    FGPUSceneWriterParameters GPUWriteParams;
    TRDGUniformBufferRef<FGPUSceneWriterUniformParameters> GPUSceneWriterUB;
};
 
DECLARE_DELEGATE_TwoParams(FGPUSceneWriteDelegateImpl, FRDGBuilder&, const FGPUSceneWriteDelegateParams&);
 
class FGPUSceneWriteDelegate : public FOneFrameResource
{
public:
    FGPUSceneWriteDelegate() = default;
    FGPUSceneWriteDelegate(FGPUSceneWriteDelegate&&) = default;
    FGPUSceneWriteDelegate &operator=(FGPUSceneWriteDelegate&&) = default;
    RENDERER_API FGPUSceneWriteDelegate(FGPUSceneWriteDelegateImpl&& GPUSceneWriteDelegateImpl);
 
    template <typename LambdaType>
    static FGPUSceneWriteDelegateRef CreateLambda(FMeshElementCollector* MeshElementCollector, LambdaType&& Lambda)
    {
        return CreateInternal(MeshElementCollector, FGPUSceneWriteDelegateImpl::CreateLambda(MoveTemp(Lambda)));
    }
 
    template <typename LambdaType>
    static FGPUSceneWriteDelegate CreateLambda(LambdaType&& Lambda)
    {
        return FGPUSceneWriteDelegate(FGPUSceneWriteDelegateImpl::CreateLambda(MoveTemp(Lambda)));
    }
 
    RENDERER_API void Execute(FRDGBuilder& GraphBuilder, const FGPUSceneWriteDelegateParams& Params) const;
 
    bool IsBound() const { return Delegate.IsBound(); }
 
private:
    RENDERER_API static FGPUSceneWriteDelegateRef CreateInternal(FMeshElementCollector* MeshElementCollector, FGPUSceneWriteDelegateImpl&& DelegateImpl);
 
    FGPUSceneWriteDelegateImpl Delegate;
};