UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TGPUSkinAPEXClothVertexFactory< BoneInfluenceType > Class Template Reference

#include <GPUSkinVertexFactory.h>

+ Inheritance diagram for TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >:

Public Member Functions

FShaderResourceViewRHIRef GetClothBuffer () override
 
const FShaderResourceViewRHIRef GetClothBuffer () const override
 
uint32 GetClothIndexOffset (uint32 VertexIndex, uint32 LODBias=0) const override
 
 TGPUSkinAPEXClothVertexFactory (const FGPUBaseSkinVertexFactory::FInitializer &Initializer, uint32 NumInfluencesPerVertex)
 
virtual void SetData (FRHICommandListBase &RHICmdList, const FGPUSkinDataType *InData) override
 
virtual FGPUBaseSkinVertexFactoryGetVertexFactory () override
 
virtual const FGPUBaseSkinVertexFactoryGetVertexFactory () const override
 
virtual FGPUBaseSkinAPEXClothVertexFactoryGetClothVertexFactory () override
 
virtual FGPUBaseSkinAPEXClothVertexFactory const * GetClothVertexFactory () const override
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
- Public Member Functions inherited from FGPUBaseSkinAPEXClothVertexFactory
 FGPUBaseSkinAPEXClothVertexFactory (uint32 InNumInfluencesPerVertex)
 
virtual ~FGPUBaseSkinAPEXClothVertexFactory ()
 
ClothShaderTypeGetClothShaderData ()
 
const ClothShaderTypeGetClothShaderData () const
 
- Public Member Functions inherited from TGPUSkinVertexFactory< BoneInfluenceType >
 TGPUSkinVertexFactory (const FInitializer &Initializer)
 
- Public Member Functions inherited from FGPUBaseSkinVertexFactory
 FGPUBaseSkinVertexFactory (const FInitializer &Initializer)
 
 FGPUBaseSkinVertexFactory (ERHIFeatureLevel::Type InFeatureLevel, uint32 InNumBones, uint32 InNumVertices, uint32 InBaseVertexIndex, bool bInUsedForPassthroughVertexFactory)
 
virtual ~FGPUBaseSkinVertexFactory ()
 
FShaderDataTypeGetShaderData ()
 
const FShaderDataTypeGetShaderData () const
 
void SetData (const FGPUSkinDataType *InData)
 
uint32 GetBoneBufferSize () const
 
uint32 GetNumBones () const
 
uint32 GetBoneOffset () const
 
uint32 GetNumVertices () const
 
uint32 GetBaseVertexIndex () const
 
void UpdateMorphState (FRHICommandListBase &RHICmdList, bool bUseMorphTarget)
 
const class FMorphVertexBufferGetMorphVertexBuffer (bool bPrevious) const
 
uint32 GetMorphVertexBufferUpdatedFrameNumber () const
 
virtual GPUSkinBoneInfluenceType GetBoneInfluenceType () const
 
virtual uint32 GetNumBoneInfluences () const
 
virtual bool Use16BitBoneIndex () const
 
virtual const FShaderResourceViewRHIRef GetPositionsSRV () const
 
virtual const FShaderResourceViewRHIRef GetTangentsSRV () const
 
virtual const FShaderResourceViewRHIRef GetTextureCoordinatesSRV () const
 
virtual const FShaderResourceViewRHIRef GetColorComponentsSRV () const
 
virtual uint32 GetNumTexCoords () const
 
virtual const uint32 GetColorIndexMask () const
 
virtual bool IsMorphTarget () const
 
virtual FShaderResourceViewRHIRef GetTriangleSortingPositionSRV () const override
 
void UpdateUniformBuffer (FRHICommandListBase &RHICmdList)
 
FRHIUniformBufferGetUniformBuffer () const
 
const FVertexStreamComponentGetPositionStreamComponent () const
 
const FVertexStreamComponentGetTangentStreamComponent (int Index) const
 
void CopyDataTypeForLocalVertexFactory (FLocalVertexFactory::FDataType &OutDestData) const
 
void GetOverrideVertexStreams (FVertexInputStreamArray &VertexStreams) const
 
bool IsReadyForStaticMeshCaching () const
 
void MarkUniformBufferDirty ()
 
bool IsUniformBufferValid () const
 
- Public Member Functions inherited from FVertexFactory
 FVertexFactory (ERHIFeatureLevel::Type InFeatureLevel)
 
virtual RENDERCORE_API ~FVertexFactory ()
 
virtual FVertexFactoryTypeGetType () const
 
RENDERCORE_API void GetStreams (ERHIFeatureLevel::Type InFeatureLevel, EVertexInputStreamType VertexStreamType, FVertexInputStreamArray &OutVertexStreams) const
 
RENDERCORE_API void OffsetInstanceStreams (uint32 InstanceOffset, EVertexInputStreamType VertexStreamType, FVertexInputStreamArray &VertexStreams) const
 
FVertexDeclarationRHIRefGetDeclaration ()
 
void SetDeclaration (FVertexDeclarationRHIRef &NewDeclaration)
 
const FVertexDeclarationRHIRefGetDeclaration (EVertexInputStreamType InputStreamType) const
 
virtual bool SupportsPositionOnlyStream () const
 
virtual bool SupportsPositionAndNormalOnlyStream () const
 
bool SupportsNullPixelShader () const
 
bool SupportsTriangleSorting () const
 
virtual bool RendersPrimitivesAsCameraFacingSprites () const
 
bool NeedsDeclaration () const
 
bool SupportsManualVertexFetch (const FStaticFeatureLevel InFeatureLevel) const
 
int32 GetPrimitiveIdStreamIndex (const FStaticFeatureLevel InFeatureLevel, EVertexInputStreamType InputStreamType) const
 
bool SupportsGPUScene (const FStaticFeatureLevel InFeatureLevel) const
 
- Public Member Functions inherited from FRenderResource
RENDERCORE_API FRenderResource ()
 
RENDERCORE_API FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
 
RENDERCORE_API FRenderResource (const FRenderResource &)
 
RENDERCORE_API FRenderResource (FRenderResource &&)
 
RENDERCORE_API FRenderResourceoperator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResourceoperator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
virtual RENDERCORE_API void InitResource (FRHICommandListBase &RHICmdList)
 
virtual RENDERCORE_API void ReleaseResource ()
 
RENDERCORE_API void UpdateRHI (FRHICommandListBase &RHICmdList)
 
virtual FString GetFriendlyName () const
 
bool IsInitialized () const
 
int32 GetListIndex () const
 
EInitPhase GetInitPhase () const
 
void SetOwnerName (FName InOwnerName)
 
FName GetOwnerName () const
 
void SetResourceName (FName InResourceName)
 
FName GetResourceName () const
 

Static Public Member Functions

static TGPUSkinAPEXClothVertexFactory(ERHIFeatureLevel::Type InFeatureLevel, uint32 InNumBones, uint32 InNumVertices, uint32 InBaseVertexIndex, uint32 InNumInfluencesPerVertex, bool bInUsedForPassthroughVertexFactory) bool ShouldCompilePermutation (const FVertexFactoryShaderPermutationParameters &Parameters)
 
- Static Public Member Functions inherited from FGPUBaseSkinAPEXClothVertexFactory
static bool IsClothEnabled (EShaderPlatform Platform)
 
- Static Public Member Functions inherited from TGPUSkinVertexFactory< BoneInfluenceType >
static TGPUSkinVertexFactory(ERHIFeatureLevel::Type InFeatureLevel, uint32 InNumBones, uint32 InNumVertices, uint32 InBaseVertexIndex, bool bInUsedForPassthroughVertexFactory) PRAGMA_DISABLE_DEPRECATION_WARNINGS bool ShouldCompilePermutation (const FVertexFactoryShaderPermutationParameters &Parameters)
 
static void GetPSOPrecacheVertexFetchElements (EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList &Elements)
 
static void GetVertexElements (ERHIFeatureLevel::Type FeatureLevel, EVertexInputStreamType InputStreamType, FGPUSkinDataType &GPUSkinData, FVertexDeclarationElementList &Elements)
 
- Static Public Member Functions inherited from FGPUBaseSkinVertexFactory
static ENGINE_API int32 GetMinimumPerPlatformMaxGPUSkinBonesValue ()
 
static ENGINE_API int32 GetMaxGPUSkinBones (const class ITargetPlatform *TargetPlatform=nullptr)
 
static ENGINE_API bool UseUnlimitedBoneInfluences (uint32 MaxBoneInfluences, const ITargetPlatform *TargetPlatform=nullptr)
 
static ENGINE_API bool GetUnlimitedBoneInfluences (const ITargetPlatform *TargetPlatform=nullptr)
 
static ENGINE_API int32 GetBoneInfluenceLimitForAsset (int32 AssetProvidedLimit, const ITargetPlatform *TargetPlatform=nullptr)
 
static ENGINE_API bool GetAlwaysUseDeformerForUnlimitedBoneInfluences (EShaderPlatform Platform)
 
- Static Public Member Functions inherited from FVertexFactory
static void ModifyCompilationEnvironment (const FVertexFactoryShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
static void ValidateCompiledResult (const FVertexFactoryType *Type, EShaderPlatform Platform, const FShaderParameterMap &ParameterMap, TArray< FString > &OutErrors)
 
static void GetPSOPrecacheVertexFetchElements (EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList &Elements)
 
- Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void ReleaseRHIForAllResources ()
 
static RENDERCORE_API void InitPreRHIResources ()
 
static RENDERCORE_API void ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
 
static RENDERCORE_API FName SetScopeName (FName Name)
 

Protected Attributes

FGPUSkinAPEXClothDataTypeClothDataPtr = nullptr
 
- Protected Attributes inherited from FGPUBaseSkinAPEXClothVertexFactory
ClothShaderType ClothShaderData
 
- Protected Attributes inherited from FGPUBaseSkinVertexFactory
FShaderDataType ShaderData
 
TUniquePtr< FGPUSkinDataTypeData
 
FUniformBufferRHIRef UniformBuffer
 
TRefCountPtr< FRHIStreamSourceSlotMorphDeltaBufferSlot
 
int32 MorphDeltaStreamIndex = -1
 
- Protected Attributes inherited from FVertexFactory
FVertexStreamList Streams
 
bool bNeedsDeclaration = true
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 
- Static Public Attributes inherited from FGPUBaseSkinVertexFactory
static const uint32 GHardwareMaxGPUSkinBones = 65536
 
- Protected Types inherited from FVertexFactory
typedef TArray< FVertexStream, TInlineAllocator< 8 > > FVertexStreamList
 
- Protected Member Functions inherited from TGPUSkinVertexFactory< BoneInfluenceType >
virtual void AddVertexElements (FVertexDeclarationElementList &OutElements) override
 
- Protected Member Functions inherited from FVertexFactory
void SetPrimitiveIdStreamIndex (const FStaticFeatureLevel InFeatureLevel, EVertexInputStreamType InputStreamType, int32 StreamIndex)
 
RENDERCORE_API bool AddPrimitiveIdStreamElement (EVertexInputStreamType InputStreamType, FVertexDeclarationElementList &Elements, uint8 AttributeIndex, uint8 AttributeIndex_Mobile)
 
FVertexElement AccessStreamComponent (const FVertexStreamComponent &Component, uint8 AttributeIndex)
 
RENDERCORE_API FVertexElement AccessStreamComponent (const FVertexStreamComponent &Component, uint8 AttributeIndex, EVertexInputStreamType InputStreamType)
 
RENDERCORE_API void InitDeclaration (const FVertexDeclarationElementList &Elements, EVertexInputStreamType StreamType=EVertexInputStreamType::Default)
 
- Protected Member Functions inherited from FRenderResource
void SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
 
const FStaticFeatureLevel GetFeatureLevel () const
 
bool HasValidFeatureLevel () const
 
template<typename T >
FBufferRHIRef CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
 
void SetInitPhase (EInitPhase InInitPhase)
 
- Static Protected Member Functions inherited from TGPUSkinVertexFactory< BoneInfluenceType >
static void GetVertexElements (ERHIFeatureLevel::Type FeatureLevel, EVertexInputStreamType InputStreamType, FGPUSkinDataType &GPUSkinData, FVertexDeclarationElementList &Elements, FVertexStreamList &InOutStreams, int32 &OutMorphDeltaStreamIndex)
 
- Static Protected Member Functions inherited from FVertexFactory
template<typename VertexStreamListType >
static FVertexElement AccessStreamComponent (const FVertexStreamComponent &Component, uint8 AttributeIndex, VertexStreamListType &InOutStreams)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 

Constructor & Destructor Documentation

◆ TGPUSkinAPEXClothVertexFactory()

template<GPUSkinBoneInfluenceType BoneInfluenceType>
TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::TGPUSkinAPEXClothVertexFactory ( const FGPUBaseSkinVertexFactory::FInitializer Initializer,
uint32  NumInfluencesPerVertex 
)
inline

Member Function Documentation

◆ GetClothBuffer() [1/2]

template<GPUSkinBoneInfluenceType BoneInfluenceType>
const FShaderResourceViewRHIRef TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::GetClothBuffer ( ) const
inlineoverridevirtual

◆ GetClothBuffer() [2/2]

template<GPUSkinBoneInfluenceType BoneInfluenceType>
FShaderResourceViewRHIRef TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::GetClothBuffer ( )
inlineoverridevirtual

Get buffer containing cloth influences.

Reimplemented from FGPUBaseSkinAPEXClothVertexFactory.

◆ GetClothIndexOffset()

template<GPUSkinBoneInfluenceType BoneInfluenceType>
uint32 TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::GetClothIndexOffset ( uint32  VertexIndex,
uint32  LODBias = 0 
) const
inlineoverridevirtual

Get offset from vertex index to cloth influence index at a given vertex index. The offset will be constant for all vertices in the same section.

Reimplemented from FGPUBaseSkinAPEXClothVertexFactory.

◆ GetClothVertexFactory() [1/2]

template<GPUSkinBoneInfluenceType BoneInfluenceType>
virtual FGPUBaseSkinAPEXClothVertexFactory const * TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::GetClothVertexFactory ( ) const
inlineoverridevirtual

Reimplemented from FGPUBaseSkinVertexFactory.

◆ GetClothVertexFactory() [2/2]

template<GPUSkinBoneInfluenceType BoneInfluenceType>
virtual FGPUBaseSkinAPEXClothVertexFactory * TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::GetClothVertexFactory ( )
inlineoverridevirtual

Cloth vertex factory access.

Reimplemented from FGPUBaseSkinVertexFactory.

◆ GetVertexFactory() [1/2]

template<GPUSkinBoneInfluenceType BoneInfluenceType>
virtual const FGPUBaseSkinVertexFactory * TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::GetVertexFactory ( ) const
inlineoverridevirtual

◆ GetVertexFactory() [2/2]

template<GPUSkinBoneInfluenceType BoneInfluenceType>
virtual FGPUBaseSkinVertexFactory * TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::GetVertexFactory ( )
inlineoverridevirtual

◆ InitRHI()

template<GPUSkinBoneInfluenceType BoneInfluenceType>
void TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::InitRHI ( FRHICommandListBase RHICmdList)
overridevirtual

Creates declarations for each of the vertex stream components and initializes the device resource

Reimplemented from TGPUSkinVertexFactory< BoneInfluenceType >.

◆ ReleaseRHI()

template<GPUSkinBoneInfluenceType BoneInfluenceType>
void TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::ReleaseRHI ( )
overridevirtual

Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from TGPUSkinVertexFactory< BoneInfluenceType >.

◆ SetData()

template<GPUSkinBoneInfluenceType BoneInfluenceType>
void TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::SetData ( FRHICommandListBase RHICmdList,
const FGPUSkinDataType InData 
)
overridevirtual

An implementation of the interface used by TSynchronizedResource to update the resource with new data from the game thread.

Parameters
InData- new stream component data

Reimplemented from FGPUBaseSkinVertexFactory.

◆ ShouldCompilePermutation()

template<GPUSkinBoneInfluenceType BoneInfluenceType>
bool TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::ShouldCompilePermutation ( const FVertexFactoryShaderPermutationParameters Parameters)
static

Destructor takes care of the Data pointer. Since FGPUBaseSkinVertexFactory does not know the real type of the Data, delete the data here instead.

Member Data Documentation

◆ ClothDataPtr

template<GPUSkinBoneInfluenceType BoneInfluenceType>
FGPUSkinAPEXClothDataType* TGPUSkinAPEXClothVertexFactory< BoneInfluenceType >::ClothDataPtr = nullptr
protected

Alias pointer to TUniquePtr<FGPUSkinDataType> Data of FGPUBaseSkinVertexFactory. Note memory isn't managed through this pointer.


The documentation for this class was generated from the following files: