Navigation
API > API/Runtime > API/Runtime/Engine
A container for skin weights data vertex buffer and lookup vertex buffer.
| Name | FSkinWeightVertexBuffer |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Rendering/SkinWeightVertexBuffer.h |
| Include Path | #include "Rendering/SkinWeightVertexBuffer.h" |
Syntax
class FSkinWeightVertexBuffer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSkinWeightVertexBuffer
(
const FSkinWeightVertexBuffer& Other |
Constructor (copy) | Rendering/SkinWeightVertexBuffer.h | |
| Default constructor. | Rendering/SkinWeightVertexBuffer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSkinWeightVertexBuffer() |
Destructor. | Rendering/SkinWeightVertexBuffer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataVertexBuffer | FSkinWeightDataVertexBuffer | Skin weights for skinning | Rendering/SkinWeightVertexBuffer.h | |
| LookupVertexBuffer | FSkinWeightLookupVertexBuffer | Skin weights lookup buffer | Rendering/SkinWeightVertexBuffer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginInitResources() |
Rendering/SkinWeightVertexBuffer.h | ||
void BeginReleaseResources() |
Rendering/SkinWeightVertexBuffer.h | ||
void CleanUp() |
Delete existing resources | Rendering/SkinWeightVertexBuffer.h | |
void CopyMetaData
(
const FSkinWeightVertexBuffer& Other |
Rendering/SkinWeightVertexBuffer.h | ||
void CopySkinWeightRawDataFromBuffer
(
const uint8* InSkinWeightData, |
Rendering/SkinWeightVertexBuffer.h | ||
FSkinWeightRHIInfo CreateRHIBuffer
(
FRHICommandListBase& RHICmdList |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetBoneIndex
(
uint32 VertexIndex, |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetBoneIndexAndWeightByteSize() |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetBoneIndexByteSize() |
Rendering/SkinWeightVertexBuffer.h | ||
GPUSkinBoneInfluenceType GetBoneInfluenceType() |
Rendering/SkinWeightVertexBuffer.h | ||
uint16 GetBoneWeight
(
uint32 VertexIndex, |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetBoneWeightByteSize() |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetConstantInfluencesBoneWeightsOffset() |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetConstantInfluencesVertexStride() |
Rendering/SkinWeightVertexBuffer.h | ||
const FSkinWeightDataVertexBuffer * GetDataVertexBuffer () |
Rendering/SkinWeightVertexBuffer.h | ||
| Rendering/SkinWeightVertexBuffer.h | |||
const FSkinWeightLookupVertexBuffer * GetLookupVertexBuffer() |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetMaxBoneInfluences() |
Rendering/SkinWeightVertexBuffer.h | ||
bool GetNeedsCPUAccess() |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetNumVertices() |
Rendering/SkinWeightVertexBuffer.h | ||
bool GetRigidWeightBone
(
uint32 VertexIndex, |
Rendering/SkinWeightVertexBuffer.h | ||
void GetSkinWeights
(
TArray< FSkinWeightInfo >& OutVertices |
Rendering/SkinWeightVertexBuffer.h | ||
bool GetVariableBonesPerVertex() |
Rendering/SkinWeightVertexBuffer.h | ||
uint32 GetVertexDataSize() |
Rendering/SkinWeightVertexBuffer.h | ||
void GetVertexInfluenceOffsetCount
(
uint32 VertexIndex, |
Rendering/SkinWeightVertexBuffer.h | ||
FSkinWeightInfo GetVertexSkinWeights
(
uint32 VertexIndex |
Rendering/SkinWeightVertexBuffer.h | ||
void Init
(
const TArray< FSoftSkinVertex >& InVertices |
Init from another skin weight buffer | Rendering/SkinWeightVertexBuffer.h | |
void InitRHIForStreaming
(
const FSkinWeightRHIInfo& RHIInfo, |
Similar to Init/ReleaseRHI but only update existing SRV so references to the SRV stays valid | Rendering/SkinWeightVertexBuffer.h | |
void RebuildLookupVertexBuffer () |
Should only be called for legacy meshes or meshes that don't really have a LookupVertexBuffer, for example created in realtime. | Rendering/SkinWeightVertexBuffer.h | |
void ReleaseResources() |
Rendering/SkinWeightVertexBuffer.h | ||
void ReleaseRHIForStreaming
(
FRHIResourceReplaceBatcher& Batcher |
Rendering/SkinWeightVertexBuffer.h | ||
void ResetVertexBoneWeights
(
uint32 VertexIndex |
Rendering/SkinWeightVertexBuffer.h | ||
void SerializeMetaData
(
FArchive& Ar |
Rendering/SkinWeightVertexBuffer.h | ||
void SetBoneIndex
(
uint32 VertexIndex, |
Rendering/SkinWeightVertexBuffer.h | ||
void SetBoneWeight
(
uint32 VertexIndex, |
Rendering/SkinWeightVertexBuffer.h | ||
void SetMaxBoneInfluences
(
uint32 InMaxBoneInfluences |
Rendering/SkinWeightVertexBuffer.h | ||
void SetNeedsCPUAccess
(
bool bInNeedsCPUAccess |
Rendering/SkinWeightVertexBuffer.h | ||
void SetOwnerName
(
const FName& OwnerName |
SetOwnerName should be called before BeginInitResources for the owner name to be successfully tracked. | Rendering/SkinWeightVertexBuffer.h | |
void SetUse16BitBoneIndex
(
bool bInUse16BitBoneIndex |
Rendering/SkinWeightVertexBuffer.h | ||
void SetUse16BitBoneWeight
(
bool bInUse16BitBoneWeight |
Rendering/SkinWeightVertexBuffer.h | ||
bool Use16BitBoneIndex() |
Rendering/SkinWeightVertexBuffer.h | ||
bool Use16BitBoneWeight() |
Rendering/SkinWeightVertexBuffer.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSkinWeightVertexBuffer & operator=
(
const TArray< FSkinWeightInfo >& InWeights |
Assignment operator for assigning array of weights to this buffer | Rendering/SkinWeightVertexBuffer.h | |
FSkinWeightVertexBuffer & operator=
(
const FSkinWeightVertexBuffer& Other |
Assignment. Assumes that vertex buffer will be rebuilt | Rendering/SkinWeightVertexBuffer.h |