Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Rendering > FSkinWeightDataVertexBuffer

Light Theme

Dark Theme

FSkinWeightDataVertexBuffer

A vertex buffer storing bone index/weight data.

Windows

MacOS

Linux

Inheritance Hierarchy

FRenderResource

FVertexBuffer

FSkinWeightDataVertexBuffer

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Rendering/SkinWeightVertexBuffer.h
Include	#include "Rendering/SkinWeightVertexBuffer.h"

Syntax

class FSkinWeightDataVertexBuffer : public FVertexBuffer

Remarks

A vertex buffer storing bone index/weight data.

Variables

		Name	Description
	FShaderResource...	SRVValue	Guaranteed only to be valid if the vertex buffer is valid

Constructors

	Name	Description
	FSkinWeightDataVertexBuffer()	Default constructor.
	FSkinWeightDataVertexBuffer ( const FSkinWeightDataVertexBuffer&... )	Constructor (copy)

Destructors

	Name	Description
	~FSkinWeightDataVertexBuffer()	Destructor.

Functions

	Name	Description
void	CleanUp()	Delete existing resources
void	CopyDataFromBuffer ( const TArrayView< const FSkinWeight... )
void	CopyMetaData ( const FSkinWeightDataVertexBuffer&... )
FVertexBuffe...	CreateRHIBuffer_Async()
FVertexBuffe...	CreateRHIBuffer_RenderThread()	Create an RHI vertex buffer with CPU data.
uint32	GetBoneIndex ( uint32 VertexWeightOffset, uint32 VertexInfluenceCount, uint32 InfluenceIndex )
uint32	GetBoneIndexByteSize()
GPUSkinBoneI...	GetBoneInfluenceType()
uint8	GetBoneWeight ( uint32 VertexWeightOffset, uint32 VertexInfluenceCount, uint32 InfluenceIndex )
uint32	GetConstantInfluencesBoneWeightsOffset()
uint32	GetConstantInfluencesVertexStride()
uint32	GetMaxBoneInfluences()
bool	GetNeedsCPUAccess()
uint32	GetNumBones()
uint32	GetNumVertices()
bool	GetRigidWeightBone ( uint32 VertexWeightOffset, uint32 VertexInfluenceCount, int32& OutBoneIndex )
FRHIShaderRe...	GetSRV()
bool	GetVariableBonesPerVertex()
uint32	GetVertexDataSize()
FSkinWeightI...	GetWeightData()
void	Init ( uint32 InNumBones, uint32 InNumVertices )
void	InitRHIForStreaming ( FRHIVertexBuffer* Intermediate..., TRHIResourceUpdateBatcher< MaxNumUp... )	Similar to Init/ReleaseRHI but only update existing SRV so references to the SRV stays valid
bool	IsWeightDataValid()
void	ReleaseRHIForStreaming ( TRHIResourceUpdateBatcher< MaxNumUp... )
void	ResetVertexBoneWeights ( uint32 VertexWeightOffset, uint32 VertexInfluenceCount )
void	SerializeMetaData ( FArchive& Ar )
void	SetBoneIndex ( uint32 VertexWeightOffset, uint32 VertexInfluenceCount, uint32 InfluenceIndex, uint32 BoneIndex )
void	SetBoneWeight ( uint32 VertexWeightOffset, uint32 VertexInfluenceCount, uint32 InfluenceIndex, uint8 BoneWeight )
void	SetMaxBoneInfluences ( uint32 InMaxBoneInfluences )	Set if this will have extra streams for bone indices & weights.
void	SetNeedsCPUAccess ( bool bInNeedsCPUAccess )	Set if the CPU needs access to this vertex buffer
void	SetUse16BitBoneIndex ( bool bInUse16BitBoneIndex )
bool	Use16BitBoneIndex()

Overridden from FRenderResource

	Name	Description
FString	GetFriendlyName()
void	InitRHI()	Initializes the RHI resources used by this resource.
void	ReleaseRHI()	Releases the RHI resources used by this resource.

Operators

		Name	Description
	FSkinWeightD...	operator= ( const FSkinWeightDataVertexBuffer&... )	Assumes that vertex buffer will be rebuilt

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss