SkeletalRenderNanite.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "ProfilingDebugging/ResourceSize.h"
#include "RenderResource.h"
#include "RayTracingGeometry.h"
#include "ShaderParameters.h"
#include "Components/ExternalMorphSet.h"
#include "Components/SkinnedMeshComponent.h"
#include "GlobalShader.h"
#include "SkeletalMeshUpdater.h"
#include "SkeletalRenderPublic.h"
#include "ClothingSystemRuntimeTypes.h"
#include "Rendering/SkeletalMeshRenderData.h"
#include "Rendering/SkeletalMeshLODRenderData.h"
#include "Animation/MeshDeformerGeometry.h"
#include "NaniteSceneProxy.h"
#include "Animation/AnimBank.h"
 
class FPrimitiveDrawInterface;
class UMorphTarget;
class FSkeletalMeshObjectNanite;
 
class FDynamicSkelMeshObjectDataNanite final : public TSkeletalMeshDynamicData<FDynamicSkelMeshObjectDataNanite>
{
    friend class TSkeletalMeshDynamicDataPool<FDynamicSkelMeshObjectDataNanite>;
    int32 Reset();
 
public:
    void Init(
        USkinnedMeshComponent* InComponent,
        FSkeletalMeshRenderData* InRenderData,
        int32 InLODIndex,
        EPreviousBoneTransformUpdateMode InPreviousBoneTransformUpdateMode,
        FSkeletalMeshObjectNanite* InMeshObject);
 
    void Init(
        const FSkinnedMeshSceneProxyDynamicData& InDynamicData,
        const USkinnedAsset* InSkinnedAsset,
        FSkeletalMeshRenderData* InRenderData,
        int32 InLODIndex,
        EPreviousBoneTransformUpdateMode InPreviousBoneTransformUpdateMode,
        FSkeletalMeshObjectNanite* InMeshObject);
 
    // Current reference pose to local space transforms
    TArray<FMatrix44f> ReferenceToLocal;
    TArray<FMatrix44f> ReferenceToLocalForRayTracing;
    TArray<FMatrix44f> PreviousReferenceToLocal;
 
    TConstArrayView<FMatrix44f> GetReferenceToLocal() const
    {
        return RayTracingLODIndex != LODIndex ? ReferenceToLocalForRayTracing : ReferenceToLocal;
    }
 
    bool IsRequiredUpdate() const
    {
        return PreviousBoneTransformUpdateMode != EPreviousBoneTransformUpdateMode::None;
    }
 
    void BuildBoneTransforms(FDynamicSkelMeshObjectDataNanite* PreviousDynamicData);
 
#if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
    // Component space bone transforms
    TArray<FTransform> ComponentSpaceTransforms;
#endif
 
    uint32 BoneTransformFrameNumber;
    uint32 RevisionNumber;
    uint32 PreviousRevisionNumber;
    EPreviousBoneTransformUpdateMode PreviousBoneTransformUpdateMode;
    uint8 bRecreating : 1;
    uint8 bNeedsBoneTransformsCurrent : 1;
    uint8 bNeedsBoneTransformsPrevious : 1;
 
    // Current LOD for bones being updated
    int32 LODIndex;
    int32 RayTracingLODIndex;
 
    // Returns the size of memory allocated by render data
    void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize);
 
private:
 
    enum class ETransformsToUpdate
    {
        Current,
        Previous,
    };
 
    void UpdateBonesRemovedByLOD(
        FSkeletalMeshObjectNanite* MeshObject,
        TArray<FMatrix44f>& PoseBuffer,
        const FSkinnedMeshSceneProxyDynamicData& InDynamicData,
        const USkinnedAsset* InSkinnedAsset,
        ETransformsToUpdate TransformsToUpdate) const;
};
 
class FSkeletalMeshObjectNanite final : public FSkeletalMeshObject
{
public:
    FSkeletalMeshObjectNanite(USkinnedMeshComponent* InComponent, FSkeletalMeshRenderData* InRenderData, ERHIFeatureLevel::Type InFeatureLevel);
    FSkeletalMeshObjectNanite(const FSkinnedMeshSceneProxyDesc& InMeshComponent, FSkeletalMeshRenderData* InSkelMeshRenderData, ERHIFeatureLevel::Type InFeatureLevel);
    virtual ~FSkeletalMeshObjectNanite();
 
    virtual void InitResources(const FSkinnedMeshSceneProxyDesc& InMeshDesc) override;
    virtual void ReleaseResources() override;
    
    void Update(
        int32 LODIndex,
        USkinnedMeshComponent* InComponent,
        const FMorphTargetWeightMap& InActiveMorphTargets,
        const TArray<float>& MorphTargetWeights,
        EPreviousBoneTransformUpdateMode PreviousBoneTransformUpdateMode,
        const FExternalMorphWeightData& InExternalMorphWeightData);
    
    virtual void Update(int32 LODIndex, const FSkinnedMeshSceneProxyDynamicData& InSkeletalMeshDynamicData, const FPrimitiveSceneProxy* InSceneProxy, const USkinnedAsset* InSkinnedAsset, const FMorphTargetWeightMap& InActiveMorphTargets, const TArray<float>& InMorphTargetWeights, EPreviousBoneTransformUpdateMode PreviousBoneTransformUpdateMode, const FExternalMorphWeightData& InExternalMorphWeightData);
 
    void UpdateDynamicData_RenderThread(FRHICommandList& RHICmdList, FGPUSkinCache* GPUSkinCache, FDynamicSkelMeshObjectDataNanite* InDynamicData);
 
    virtual const FVertexFactory* GetSkinVertexFactory(const FSceneView* View, int32 LODIndex, int32 ChunkIdx, ESkinVertexFactoryMode VFMode = ESkinVertexFactoryMode::Default) const override;
    virtual const FVertexFactory* GetStaticSkinVertexFactory(int32 LODIndex, int32 ChunkIdx, ESkinVertexFactoryMode VFMode = ESkinVertexFactoryMode::Default) const override;
    virtual TArray<FTransform>* GetComponentSpaceTransforms() const override;
    virtual TConstArrayView<FMatrix44f> GetReferenceToLocalMatrices() const override;
    virtual TConstArrayView<FMatrix44f> GetPrevReferenceToLocalMatrices() const override;
 
    virtual int32 GetLOD() const override;
 
    virtual bool HaveValidDynamicData() const override;
 
    virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
 
    void UpdateSkinWeightBuffer(USkinnedMeshComponent* InMeshComponent);
    virtual void UpdateSkinWeightBuffer(const TArrayView<const FSkelMeshComponentLODInfo> InLODInfo) override;
 
    virtual bool IsNaniteMesh() const override { return true; }
    virtual const Nanite::FMaterialAudit* GetNaniteMaterials() const override { return &NaniteMaterials; }
 
    virtual FSkinWeightVertexBuffer* GetSkinWeightVertexBuffer(int32 LODIndex) const;
 
#if RHI_RAYTRACING  
    FRayTracingGeometry RayTracingGeometry;
    
    virtual void UpdateRayTracingGeometry(FRHICommandListBase& RHICmdList, FSkeletalMeshLODRenderData& LODModel, uint32 LODIndex, TArray<FBufferRHIRef>& VertexBuffers) override;
    
    // GetRayTracingGeometry()->IsInitialized() is checked as a workaround for UE-92634. FSkeletalMeshSceneProxy's resources may have already been released, but proxy has not removed yet)
    FRayTracingGeometry* GetRayTracingGeometry() { return RayTracingGeometry.HasValidInitializer() && RayTracingGeometry.IsInitialized() ? & RayTracingGeometry : nullptr; }
    const FRayTracingGeometry* GetRayTracingGeometry() const { return RayTracingGeometry.HasValidInitializer() && RayTracingGeometry.IsInitialized() ? & RayTracingGeometry : nullptr; }
 
    virtual int32 GetRayTracingLOD() const override
    {
        if (DynamicData)
        {
            return DynamicData->RayTracingLODIndex;
        }
        else
        {
            return 0;
        }
    }
#endif
 
    inline bool HasValidMaterials() const
    {
        return bHasValidMaterials;
    }
 
    TConstArrayView<FBoneReference> GetCachedBonesToRemove(const USkinnedAsset* SkinnedAsset, int32 LODIndex)
    {
        if (SkinnedAsset != BonesToRemoveCache.SkinnedAsset || LODIndex != BonesToRemoveCache.LODIndex)
        {
            BonesToRemoveCache.SkinnedAsset = SkinnedAsset;
            BonesToRemoveCache.LODIndex = LODIndex;
            BonesToRemoveCache.BonesToRemove = SkinnedAsset->GetLODInfo(LODIndex)->BonesToRemove;
        }
        return BonesToRemoveCache.BonesToRemove;
    }
 
private:
    FDynamicSkelMeshObjectDataNanite* DynamicData = nullptr;
 
    void ProcessUpdatedDynamicData(FRHICommandList& RHICmdList, FGPUSkinCache* GPUSkinCache);
    void UpdateBoneData(FRHICommandList& RHICmdList);
 
    struct FSkeletalMeshObjectLOD
    {
        FSkeletalMeshRenderData* RenderData;
        int32 LODIndex;
        bool bInitialized;
        
        // Needed for skin cache update for ray tracing
        TArray<TUniquePtr<FGPUBaseSkinVertexFactory>> VertexFactories;
        TUniquePtr<FGPUSkinPassthroughVertexFactory> PassthroughVertexFactory;
 
        FSkinWeightVertexBuffer* MeshObjectWeightBuffer = nullptr;
 
        FSkeletalMeshObjectLOD(ERHIFeatureLevel::Type InFeatureLevel, FSkeletalMeshRenderData* InRenderData, int32 InLOD)
        : RenderData(InRenderData)
        , LODIndex(InLOD)
        , bInitialized(false)
        {
        }
 
        void InitResources(const FSkelMeshComponentLODInfo* LODInfo, ERHIFeatureLevel::Type FeatureLevel);
        void ReleaseResources();
        void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize);
        void UpdateSkinWeights(const FSkelMeshComponentLODInfo* LODInfo);
    };
 
    TArray<FSkeletalMeshObjectLOD> LODs;
 
    FSkeletalMeshUpdateHandle UpdateHandle;
 
    Nanite::FMaterialAudit NaniteMaterials;
    bool bHasValidMaterials = false;
    uint32 LastRayTracingBoneTransformUpdate = INDEX_NONE;
 
    struct
    {
        const USkinnedAsset* SkinnedAsset = nullptr;
        int32 LODIndex = -1;
        TConstArrayView<FBoneReference> BonesToRemove;
 
    } BonesToRemoveCache; // GameThread Only
 
    friend class FSkeletalMeshUpdatePacketNanite;
};
 
 
class FInstancedSkeletalMeshObjectNanite : public FSkeletalMeshObject
{
public:
    FInstancedSkeletalMeshObjectNanite(
        const FInstancedSkinnedMeshSceneProxyDesc& InMeshDesc,
        FSkeletalMeshRenderData* InRenderData,
        ERHIFeatureLevel::Type InFeatureLevel);
 
    virtual void InitResources(const FSkinnedMeshSceneProxyDesc& InMeshDesc) override;
    virtual void ReleaseResources() override;
 
    virtual void Update(
        int32 LODIndex,
        const FSkinnedMeshSceneProxyDynamicData& InDynamicData,
        const FPrimitiveSceneProxy* InSceneProxy,
        const USkinnedAsset* InSkinnedAsset,
        const FMorphTargetWeightMap& InActiveMorphTargets,
        const TArray<float>& MorphTargetWeights,
        EPreviousBoneTransformUpdateMode PreviousBoneTransformUpdateMode,
        const FExternalMorphWeightData& InExternalMorphWeightData) override
    {}
 
    virtual FSkinningSceneExtensionProxy* CreateSceneExtensionProxy(const USkinnedAsset* InSkinnedAsset, bool bAllowScaling) override;
 
    virtual const FVertexFactory* GetSkinVertexFactory(const FSceneView* View, int32 LODIndex, int32 ChunkIdx, ESkinVertexFactoryMode VFMode) const override
    {
        return nullptr;
    }
 
    virtual const FVertexFactory* GetStaticSkinVertexFactory(int32 LODIndex, int32 ChunkIdx, ESkinVertexFactoryMode VFMode) const override
    {
        check(LODs.IsValidIndex(LODIndex));
        return &LODs[LODIndex].VertexFactory;
    }
 
    virtual TArray<FTransform>* GetComponentSpaceTransforms() const override { return nullptr; }
 
    virtual TConstArrayView<FMatrix44f> GetReferenceToLocalMatrices() const override { return {}; }
 
    virtual TConstArrayView<FMatrix44f> GetPrevReferenceToLocalMatrices() const override { return {}; }
 
    virtual int32 GetLOD() const override { return 0; }
 
    virtual bool HaveValidDynamicData() const override { return false; }
 
    virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
 
    virtual void UpdateSkinWeightBuffer(const TArrayView<const FSkelMeshComponentLODInfo> InLODInfo) override {}
 
    virtual bool IsNaniteMesh() const override { return true; }
    virtual const Nanite::FMaterialAudit* GetNaniteMaterials() const override { return &NaniteMaterials; }
 
#if RHI_RAYTRACING
    // TODO: Support skinning in ray tracing (currently representing with static geometry)
    virtual const FRayTracingGeometry* GetStaticRayTracingGeometry() const override;
#endif
 
private:
    struct FSkeletalMeshObjectLOD
    {
        FSkeletalMeshRenderData* RenderData;
        FLocalVertexFactory VertexFactory;
        int32 LODIndex;
        bool bInitialized = false;
        bool bStaticRayTracingGeometryInitialized = false;
 
        FSkeletalMeshObjectLOD(ERHIFeatureLevel::Type InFeatureLevel, FSkeletalMeshRenderData* InRenderData, int32 InLOD);
 
        void InitResources(const FSkelMeshComponentLODInfo* InLODInfo);
        void ReleaseResources();
    };
 
    TObjectPtr<UTransformProviderData> TransformProvider;
    TArray<FSkeletalMeshObjectLOD> LODs;
    Nanite::FMaterialAudit NaniteMaterials;
};