SkeletalMeshDeformerHelpers.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "RenderGraphResources.h"
 
class FRDGBuffer;
class FRDGExternalAccessQueue;
class FRHIShaderResourceView;
class FSkeletalMeshObject;
 
class FSkeletalMeshDeformerHelpers
{
public:
    static constexpr uint32 PosBufferBytesPerElement = 4;
    static constexpr uint32 PosBufferElementMultiplier= 3;
    static constexpr uint32 TangentBufferBytesPerElement = 8;
    static constexpr uint32 TangentBufferElementMultiplier= 2;
    static constexpr uint32 ColorBufferBytesPerElement = 4;
    
#pragma region GetInternals
 
    ENGINE_API static FRHIShaderResourceView* GetBoneBufferForReading(
        FSkeletalMeshObject const* InMeshObject,
        int32 InLodIndex,
        int32 InSectionIndex,
        bool bInPreviousFrame);
 
    ENGINE_API static FRHIShaderResourceView* GetMorphTargetBufferForReading(
        FSkeletalMeshObject const* InMeshObject,
        int32 InLodIndex,
        int32 InSectionIndex,
        uint32 InFrameNumber,
        bool bInPreviousFrame);
 
    struct FClothBuffers
    {
        int32 ClothInfluenceBufferOffset = 0;
        FRHIShaderResourceView* ClothInfluenceBuffer = nullptr;
        FRHIShaderResourceView* ClothSimulatedPositionAndNormalBuffer = nullptr;
        FMatrix44f ClothToLocal = FMatrix44f::Identity;
    };
 
    ENGINE_API static FClothBuffers GetClothBuffersForReading(
        FSkeletalMeshObject const* InMeshObject,
        int32 InLodIndex,
        int32 InSectionIndex,
        uint32 InFrameNumber,
        bool bInPreviousFrame);
 
    ENGINE_API static FRDGBuffer* GetAllocatedPositionBuffer(FRDGBuilder& GraphBuilder, FSkeletalMeshObject* InMeshObject, int32 InLodIndex);
 
    ENGINE_API static FRDGBuffer* GetAllocatedTangentBuffer(FRDGBuilder& GraphBuilder, FSkeletalMeshObject* InMeshObject, int32 InLodIndex);
 
    ENGINE_API static FRDGBuffer* GetAllocatedColorBuffer(FRDGBuilder& GraphBuilder, FSkeletalMeshObject* InMeshObject, int32 InLodIndex);
 
    ENGINE_API static int32 GetIndexOfFirstAvailableSection(FSkeletalMeshObject* InMeshObject, int32 InLodIndex);
    
#pragma endregion GetInternals
 
#pragma region SetInternals
 
    ENGINE_API static FRDGBuffer* AllocateVertexFactoryPositionBuffer(FRDGBuilder& GraphBuilder, FRDGExternalAccessQueue& ExternalAccesQueue, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, TCHAR const* InBufferName);
 
    ENGINE_API static FRDGBuffer* AllocateVertexFactoryTangentBuffer(FRDGBuilder& GraphBuilder, FRDGExternalAccessQueue& ExternalAccesQueue, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, TCHAR const* InBufferName);
 
    ENGINE_API static FRDGBuffer* AllocateVertexFactoryColorBuffer(FRDGBuilder& GraphBuilder, FRDGExternalAccessQueue& ExternalAccesQueue, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, TCHAR const* InBufferName);
 
    ENGINE_API static void UpdateVertexFactoryBufferOverrides(FRHICommandListBase& RHICmdList, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, bool bInvalidatePreviousPosition);
    ENGINE_API static void UpdateVertexFactoryBufferOverrides(FRDGBuilder& GraphBuilder, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, bool bInvalidatePreviousPosition);
 
    ENGINE_API static void ResetVertexFactoryBufferOverrides(FSkeletalMeshObject* InMeshObject, int32 InLodIndex);
 
#pragma endregion SetInternals
 
#pragma region Deprecated
 
    UE_DEPRECATED(5.6, "AllocateVertexFactoryPositionBuffer requires a FRDGExternalAccessQueue.")
    ENGINE_API static FRDGBuffer* AllocateVertexFactoryPositionBuffer(FRDGBuilder& GraphBuilder, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, bool bInLodJustChanged, TCHAR const* InBufferName);
 
    UE_DEPRECATED(5.6, "AllocateVertexFactoryTangentBuffer requires a FRDGExternalAccessQueue.")
    ENGINE_API static FRDGBuffer* AllocateVertexFactoryTangentBuffer(FRDGBuilder& GraphBuilder, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, TCHAR const* InBufferName);
 
    UE_DEPRECATED(5.6, "AllocateVertexFactoryColorBuffer requires a FRDGExternalAccessQueue.")
    ENGINE_API static FRDGBuffer* AllocateVertexFactoryColorBuffer(FRDGBuilder& GraphBuilder, FSkeletalMeshObject* InMeshObject, int32 InLodIndex, TCHAR const* InBufferName);
 
    UE_DEPRECATED(5.6, "UpdateVertexFactoryBufferOverrides requires a bInvalidatePreviousPosition flag.")
    ENGINE_API static void UpdateVertexFactoryBufferOverrides(FRHICommandListBase& RHICmdList, FSkeletalMeshObject* InMeshObject, int32 InLodIndex);
 
    UE_DEPRECATED(5.4, "UpdateVertexFactoryBufferOverrides requires a command list.")
    ENGINE_API static void UpdateVertexFactoryBufferOverrides(FSkeletalMeshObject* InMeshObject, int32 InLodIndex);
 
#pragma endregion Deprecated
};