#include <SkeletalMeshVertexClothBuffer.h>

Inheritance diagram for FSkeletalMeshVertexClothBuffer:

Public Member Functions
ENGINE_API	FSkeletalMeshVertexClothBuffer ()

virtual ENGINE_API	~FSkeletalMeshVertexClothBuffer ()

ENGINE_API FSkeletalMeshVertexClothBuffer &	operator= (const FSkeletalMeshVertexClothBuffer &Other)

ENGINE_API	FSkeletalMeshVertexClothBuffer (const FSkeletalMeshVertexClothBuffer &Other)

void	CleanUp ()

void	ClearMetaData ()

ENGINE_API void	Init (const TArray< FMeshToMeshVertData > &InMappingData, const TArray< FClothBufferIndexMapping > &InClothIndexMapping)

void	SerializeMetaData (FArchive &Ar)

virtual void	InitRHI (FRHICommandListBase &RHICmdList) override

virtual void	ReleaseRHI () override

virtual FString	GetFriendlyName () const override

FMeshToMeshVertData &	MappingData (uint32 VertexIndex)

const FMeshToMeshVertData &	MappingData (uint32 VertexIndex) const

uint32	GetNumVertices () const

uint32	GetStride () const

uint32	GetVertexDataSize () const

FShaderResourceViewRHIRef	GetSRV () const

const TArray< FClothBufferIndexMapping > &	GetClothIndexMapping () const

FBufferRHIRef	CreateRHIBuffer (FRHICommandListBase &RHICmdList)

void	InitRHIForStreaming (FRHIBuffer *IntermediateBuffer, FRHIResourceReplaceBatcher &Batcher)

void	ReleaseRHIForStreaming (FRHIResourceReplaceBatcher &Batcher)

ENGINE_API void	SetMetadata (const TArray< FClothBufferIndexMapping > &ClothIndexMapping, uint32 Stride, uint32 NumVertices)

Public Member Functions inherited from FVertexBuffer
RENDERCORE_API	FVertexBuffer ()

RENDERCORE_API	FVertexBuffer (const FVertexBuffer &)

RENDERCORE_API FVertexBuffer &	operator= (const FVertexBuffer &Other)

virtual RENDERCORE_API	~FVertexBuffer ()

const FBufferRHIRef &	GetRHI () const

RENDERCORE_API void	SetRHI (const FBufferRHIRef &BufferRHI)

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 FRenderResource &	operator= (const FRenderResource &Other)

RENDERCORE_API FRenderResource &	operator= (FRenderResource &&Other)

virtual RENDERCORE_API	~FRenderResource ()

virtual RENDERCORE_API void	InitResource (FRHICommandListBase &RHICmdList)

virtual RENDERCORE_API void	ReleaseResource ()

RENDERCORE_API void	UpdateRHI (FRHICommandListBase &RHICmdList)

bool	IsInitialized () const

int32	GetListIndex () const

EInitPhase	GetInitPhase () const

void	SetOwnerName (FName InOwnerName)

FName	GetOwnerName () const

void	SetResourceName (FName InResourceName)

FName	GetResourceName () const

Friends
ENGINE_API friend FArchive &	operator<< (FArchive &Ar, FSkeletalMeshVertexClothBuffer &VertexBuffer)

Additional Inherited Members
Public Types inherited from FRenderResource
enum class	EInitPhase : uint8 { Pre , Default , MAX }

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)

Public Attributes inherited from FVertexBuffer
FBufferRHIRef	VertexBufferRHI

Public Attributes inherited from FRenderResource
ERenderResourceState	ResourceState = ERenderResourceState::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 FRenderResource
static RENDERCORE_API FRHICommandListBase &	GetImmediateCommandList ()

Detailed Description

A vertex buffer for holding skeletal mesh clothing information only. This buffer sits along side the other skeletal mesh buffers per LOD

Constructor & Destructor Documentation

◆ FSkeletalMeshVertexClothBuffer() [1/2]

FSkeletalMeshVertexClothBuffer::FSkeletalMeshVertexClothBuffer ( )

Constructor

◆ ~FSkeletalMeshVertexClothBuffer()

FSkeletalMeshVertexClothBuffer::~FSkeletalMeshVertexClothBuffer ( )

virtual

Destructor

◆ FSkeletalMeshVertexClothBuffer() [2/2]

FSkeletalMeshVertexClothBuffer::FSkeletalMeshVertexClothBuffer ( const FSkeletalMeshVertexClothBuffer & Other )

Constructor (copy)

Copy Constructor

Member Function Documentation

◆ CleanUp()

void FSkeletalMeshVertexClothBuffer::CleanUp ( )

Delete existing resources

◆ ClearMetaData()

void FSkeletalMeshVertexClothBuffer::ClearMetaData ( )

◆ CreateRHIBuffer()

FBufferRHIRef FSkeletalMeshVertexClothBuffer::CreateRHIBuffer ( FRHICommandListBase & RHICmdList )

Create an RHI vertex buffer with CPU data. CPU data may be discarded after creation (see TResourceArray::Discard)

◆ GetClothIndexMapping()

const TArray< FClothBufferIndexMapping > & FSkeletalMeshVertexClothBuffer::GetClothIndexMapping ( ) const

inline

◆ GetFriendlyName()

FString FSkeletalMeshVertexClothBuffer::GetFriendlyName ( ) const

overridevirtual

Returns: text description for the resource type

Reimplemented from FVertexBuffer.

◆ GetNumVertices()

uint32 FSkeletalMeshVertexClothBuffer::GetNumVertices ( ) const

inline

Returns: number of vertices in this vertex buffer

◆ GetSRV()

FShaderResourceViewRHIRef FSkeletalMeshVertexClothBuffer::GetSRV ( ) const

inline

◆ GetStride()

uint32 FSkeletalMeshVertexClothBuffer::GetStride ( ) const

inline

Returns: cached stride for vertex data type for this vertex buffer

◆ GetVertexDataSize()

uint32 FSkeletalMeshVertexClothBuffer::GetVertexDataSize ( ) const

inline

Returns: total size of data in resource array

◆ Init()

void FSkeletalMeshVertexClothBuffer::Init	(	const TArray< FMeshToMeshVertData > &	InMappingData,
		const TArray< FClothBufferIndexMapping > &	InClothIndexMapping
	)

Initializes the buffer with the given vertices.

Parameters

InVertices	- The vertices to initialize the buffer with.
InClothIndexMapping	- The cloth deformer mapping data offset for a specific section/LODBias.

Initializes the buffer with the given vertices.

Parameters

InVertices - The vertices to initialize the buffer with.

◆ InitRHI()

void FSkeletalMeshVertexClothBuffer::InitRHI ( FRHICommandListBase & RHICmdList )

overridevirtual

Initialize the RHI resource for this vertex buffer

Reimplemented from FRenderResource.

◆ InitRHIForStreaming()

void FSkeletalMeshVertexClothBuffer::InitRHIForStreaming	(	FRHIBuffer *	IntermediateBuffer,
		FRHIResourceReplaceBatcher &	Batcher
	)

Similar to Init/ReleaseRHI but only update existing SRV so references to the SRV stays valid

◆ MappingData() [1/2]

FMeshToMeshVertData & FSkeletalMeshVertexClothBuffer::MappingData ( uint32 VertexIndex )

inline

◆ MappingData() [2/2]

const FMeshToMeshVertData & FSkeletalMeshVertexClothBuffer::MappingData ( uint32 VertexIndex ) const

inline

◆ operator=()

FSkeletalMeshVertexClothBuffer & FSkeletalMeshVertexClothBuffer::operator= ( const FSkeletalMeshVertexClothBuffer & Other )

Assignment. Assumes that vertex buffer will be rebuilt

◆ ReleaseRHI()

void FSkeletalMeshVertexClothBuffer::ReleaseRHI ( )

overridevirtual

Release the RHI resource for this vertex buffer

Reimplemented from FVertexBuffer.

◆ ReleaseRHIForStreaming()

void FSkeletalMeshVertexClothBuffer::ReleaseRHIForStreaming ( FRHIResourceReplaceBatcher & Batcher )

◆ SerializeMetaData()

void FSkeletalMeshVertexClothBuffer::SerializeMetaData ( FArchive & Ar )

◆ SetMetadata()

void FSkeletalMeshVertexClothBuffer::SetMetadata	(	const TArray< FClothBufferIndexMapping > &	ClothIndexMapping,
		uint32	Stride,
		uint32	NumVertices
	)

Friends And Related Symbol Documentation

◆ operator<<

ENGINE_API friend FArchive & operator<<	(	FArchive &	Ar,
		FSkeletalMeshVertexClothBuffer &	VertexBuffer
	)

friend

Serializer for this class

Parameters

Ar	- archive to serialize to
B	- data to serialize

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

Engine/Source/Runtime/Engine/Public/Rendering/SkeletalMeshVertexClothBuffer.h
Engine/Source/Runtime/Engine/Private/Rendering/SkeletalMeshVertexClothBuffer.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FSkeletalMeshVertexClothBuffer() [1/2]

◆ ~FSkeletalMeshVertexClothBuffer()

◆ FSkeletalMeshVertexClothBuffer() [2/2]

Member Function Documentation

◆ CleanUp()

◆ ClearMetaData()

◆ CreateRHIBuffer()

◆ GetClothIndexMapping()

◆ GetFriendlyName()

◆ GetNumVertices()

◆ GetSRV()

◆ GetStride()

◆ GetVertexDataSize()

◆ Init()

◆ InitRHI()

◆ InitRHIForStreaming()

◆ MappingData() [1/2]

◆ MappingData() [2/2]

◆ operator=()

◆ ReleaseRHI()

◆ ReleaseRHIForStreaming()

◆ SerializeMetaData()

◆ SetMetadata()

Friends And Related Symbol Documentation

◆ operator<<