StaticMeshUpdate.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
StaticMeshUpdate.h: Helpers to stream in and out static mesh LODs.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/StaticMesh.h"
#include "Async/AsyncFileHandle.h"
#include "IO/IoDispatcher.h"
#include "RenderAssetUpdate.h"
#include "RayTracingGeometry.h"
 
struct FStaticMeshUpdateContext
{
    typedef int32 EThreadType;
 
    FStaticMeshUpdateContext(const UStaticMesh* InMesh, EThreadType InCurrentThread);
 
    FStaticMeshUpdateContext(const UStreamableRenderAsset* InMesh, EThreadType InCurrentThread);
 
    EThreadType GetCurrentThread() const
    {
        return CurrentThread;
    }
 
    const UStaticMesh* Mesh;
    FStaticMeshRenderData* RenderData;
    TArrayView<FStaticMeshLODResources*> LODResourcesView;
 
    EThreadType CurrentThread;
};
 
// Declare that TRenderAssetUpdate is instantiated for FStaticMeshUpdateContext
extern template class TRenderAssetUpdate<FStaticMeshUpdateContext>;
 
class FStaticMeshUpdate : public TRenderAssetUpdate<FStaticMeshUpdateContext>
{
public:
    FStaticMeshUpdate(const UStaticMesh* InMesh);
 
    virtual void Abort()
    {
        TRenderAssetUpdate<FStaticMeshUpdateContext>::Abort();
    }
 
protected:
 
    virtual ~FStaticMeshUpdate() {}
};
 
class FStaticMeshStreamIn : public FStaticMeshUpdate
{
public:
    FStaticMeshStreamIn(const UStaticMesh* InMesh, EThreadType CreateResourcesThread);
 
    virtual ~FStaticMeshStreamIn();
 
protected:
    struct FIntermediateBuffers
    {
        FBufferRHIRef TangentsVertexBuffer;
        FBufferRHIRef TexCoordVertexBuffer;
        FBufferRHIRef PositionVertexBuffer;
        FBufferRHIRef ColorVertexBuffer;
        FBufferRHIRef IndexBuffer;
        FBufferRHIRef ReversedIndexBuffer;
        FBufferRHIRef DepthOnlyIndexBuffer;
        FBufferRHIRef ReversedDepthOnlyIndexBuffer;
        FBufferRHIRef WireframeIndexBuffer;
 
        void CreateFromCPUData(FRHICommandListBase& RHICmdList, FStaticMeshLODResources& LODResource);
 
        void TransferBuffers(FStaticMeshLODResources& LODResource, FRHIResourceReplaceBatcher& Batcher);
    };
 
#if RHI_RAYTRACING
    struct FIntermediateRayTracingGeometry
    {
    private:
        FRayTracingGeometryInitializer Initializer;
        FRayTracingGeometryRHIRef RayTracingGeometryRHI;
        bool bRequiresBuild = false;
 
    public:
        void CreateFromCPUData(FRHICommandListBase& RHICmdList, FRayTracingGeometry& RayTracingGeometry);
 
        void SafeRelease();
 
        void TransferRayTracingGeometry(FRayTracingGeometry& RayTracingGeometry, FRHIResourceReplaceBatcher& Batcher);
    };
#endif
 
    void CreateBuffers(const FContext& Context);
 
    void DiscardNewLODs(const FContext& Context);
 
    void DoFinishUpdate(const FContext& Context);
 
    void DoCancel(const FContext& Context);
 
    FIntermediateBuffers IntermediateBuffersArray[MAX_MESH_LOD_COUNT];
    
#if RHI_RAYTRACING
    FIntermediateRayTracingGeometry IntermediateRayTracingGeometry[MAX_MESH_LOD_COUNT];
#endif
 
    FRHICommandList* StreamingRHICmdList = nullptr;
 
    const EThreadType CreateResourcesThread;
};
 
class FStaticMeshStreamOut : public FStaticMeshUpdate
{
public:
    FStaticMeshStreamOut(const UStaticMesh* InMesh, bool InDiscardCPUData);
 
private:
 
    void CheckReferencesAndDiscardCPUData(const FContext& Context);
    void ReleaseRHIBuffers(const FContext& Context);
    void Cancel(const FContext& Context);
 
    bool bDiscardCPUData = false;
    int32 NumReferenceChecks = 0;
    uint32 PreviousNumberOfExternalReferences = 0;
};
 
class FStaticMeshStreamIn_IO : public FStaticMeshStreamIn
{
public:
    FStaticMeshStreamIn_IO(const UStaticMesh* InMesh, bool bHighPrio, EThreadType CreateResourcesThread);
 
    virtual ~FStaticMeshStreamIn_IO() {}
 
    virtual void Abort() override;
 
protected:
    class FCancelIORequestsTask : public FNonAbandonableTask
    {
    public:
        FCancelIORequestsTask(FStaticMeshStreamIn_IO* InPendingUpdate)
            : PendingUpdate(InPendingUpdate)
        {}
 
        void DoWork();
 
        FORCEINLINE TStatId GetStatId() const
        {
            RETURN_QUICK_DECLARE_CYCLE_STAT(FCancelIORequestsTask_StaticMesh, STATGROUP_ThreadPoolAsyncTasks);
        }
 
    private:
        TRefCountPtr<FStaticMeshStreamIn_IO> PendingUpdate;
    };
 
    typedef FAutoDeleteAsyncTask<FCancelIORequestsTask> FAsyncCancelIORequestsTask;
    friend class FCancelIORequestsTask;
 
    void SetIORequest(const FContext& Context);
 
    void ClearIORequest(const FContext& Context);
 
    void ReportIOError(const FContext& Context);
 
    void SerializeLODData(const FContext& Context);
 
    void Cancel(const FContext& Context);
 
    void CancelIORequest();
 
    FBulkDataBatchRequest BulkDataRequest;
 
    FIoBuffer BulkData;
 
    bool bHighPrioIORequest;
 
    // Whether an IO error was detected (when files do not exists).
    bool bFailedOnIOError = false;
 
    void DoInitiateIO(const FContext& Context);
 
    void DoSerializeLODData(const FContext& Context);
 
    void DoCreateBuffers(const FContext& Context);
 
    void DoCancelIO(const FContext& Context);
};
 
#if WITH_EDITOR
class FStaticMeshStreamIn_DDC : public FStaticMeshStreamIn
{
public:
    FStaticMeshStreamIn_DDC(const UStaticMesh* InMesh, EThreadType CreateResourcesThread);
 
    virtual ~FStaticMeshStreamIn_DDC() {}
 
protected:
    void LoadNewLODsFromDDC(const FContext& Context);
 
private:
    void DoLoadNewLODsFromDDC(const FContext& Context);
 
    void DoCreateBuffers(const FContext& Context);
};
#endif