Navigation
API > API/Runtime > API/Runtime/Engine
A vertex buffer for holding skeletal mesh clothing information only. This buffer sits along side the other skeletal mesh buffers per LOD
| Name | FSkeletalMeshVertexClothBuffer |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Rendering/SkeletalMeshVertexClothBuffer.h |
| Include Path | #include "Rendering/SkeletalMeshVertexClothBuffer.h" |
Syntax
class FSkeletalMeshVertexClothBuffer : public FVertexBuffer
Inheritance Hierarchy
- FRenderResource → FVertexBuffer → FSkeletalMeshVertexClothBuffer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSkeletalMeshVertexClothBuffer
(
const FSkeletalMeshVertexClothBuffer& Other |
Constructor (copy)Copy Constructor | Rendering/SkeletalMeshVertexClothBuffer.h | |
| Constructor | Rendering/SkeletalMeshVertexClothBuffer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSkeletalMeshVertexClothBuffer() |
Destructor | Rendering/SkeletalMeshVertexClothBuffer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClothIndexMapping | TArray< FClothBufferIndexMapping > | The Cloth deformer mapping to the simulation LODs. | Rendering/SkeletalMeshVertexClothBuffer.h | |
| Data | uint8 * | The cached vertex data pointer. | Rendering/SkeletalMeshVertexClothBuffer.h | |
| NumVertices | uint32 | The cached number of vertices. | Rendering/SkeletalMeshVertexClothBuffer.h | |
| Stride | uint32 | The cached vertex stride. | Rendering/SkeletalMeshVertexClothBuffer.h | |
| VertexBufferSRV | FShaderResourceViewRHIRef | Rendering/SkeletalMeshVertexClothBuffer.h | ||
| VertexData | FSkeletalMeshVertexDataInterface * | The vertex data storage type | Rendering/SkeletalMeshVertexClothBuffer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CleanUp() |
Delete existing resources | Rendering/SkeletalMeshVertexClothBuffer.h | |
void ClearMetaData() |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
FBufferRHIRef CreateRHIBuffer
(
FRHICommandListBase& RHICmdList |
Create an RHI vertex buffer with CPU data. | Rendering/SkeletalMeshVertexClothBuffer.h | |
const TArray< FClothBufferIndexMapping > & GetClothIndexMapping() |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
uint32 GetNumVertices() |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
FShaderResourceViewRHIRef GetSRV() |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
uint32 GetStride() |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
uint32 GetVertexDataSize() |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
void Init
(
const TArray< FMeshToMeshVertData >& InMappingData, |
Initializes the buffer with the given vertices. Initializes the buffer with the given vertices. | Rendering/SkeletalMeshVertexClothBuffer.h | |
void InitRHIForStreaming
(
FRHIBuffer* IntermediateBuffer, |
Similar to Init/ReleaseRHI but only update existing SRV so references to the SRV stays valid | Rendering/SkeletalMeshVertexClothBuffer.h | |
FMeshToMeshVertData & MappingData
(
uint32 VertexIndex |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
const FMeshToMeshVertData & MappingData
(
uint32 VertexIndex |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
void ReleaseRHIForStreaming
(
FRHIResourceReplaceBatcher& Batcher |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
void SerializeMetaData
(
FArchive& Ar |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
void SetMetadata
(
const TArray< FClothBufferIndexMapping >& ClothIndexMapping, |
Rendering/SkeletalMeshVertexClothBuffer.h |
Overridden from FRenderResource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetFriendlyName() |
Rendering/SkeletalMeshVertexClothBuffer.h | ||
virtual void InitRHI
(
FRHICommandListBase& RHICmdList |
Initialize the RHI resource for this vertex buffer | Rendering/SkeletalMeshVertexClothBuffer.h | |
virtual void ReleaseRHI() |
Release the RHI resource for this vertex buffer | Rendering/SkeletalMeshVertexClothBuffer.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSkeletalMeshVertexClothBuffer & operator=
(
const FSkeletalMeshVertexClothBuffer& Other |
Assignment. Assumes that vertex buffer will be rebuilt | Rendering/SkeletalMeshVertexClothBuffer.h |