UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FVertexBuffer Class Reference

#include <RenderResource.h>

+ Inheritance diagram for FVertexBuffer:

Public Member Functions

RENDERCORE_API FVertexBuffer ()
 
RENDERCORE_API FVertexBuffer (const FVertexBuffer &)
 
RENDERCORE_API FVertexBuffer & operator= (const FVertexBuffer &Other)
 
virtual RENDERCORE_API ~FVertexBuffer ()
 
virtual RENDERCORE_API void ReleaseRHI () override
 
virtual RENDERCORE_API FString GetFriendlyName () const override
 
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 void InitRHI (FRHICommandListBase &RHICmdList)
 
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
 

Public Attributes

FBufferRHIRef VertexBufferRHI
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 

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)
 
- 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 resource

Constructor & Destructor Documentation

◆ FVertexBuffer() [1/2]

FVertexBuffer::FVertexBuffer ( )
default

◆ FVertexBuffer() [2/2]

FVertexBuffer::FVertexBuffer ( const FVertexBuffer &  )
default

◆ ~FVertexBuffer()

FVertexBuffer::~FVertexBuffer ( )
virtualdefault

Member Function Documentation

◆ GetFriendlyName()

FString FVertexBuffer::GetFriendlyName ( ) const
overridevirtual
Returns
The resource's friendly name. Typically a UObject name.

Reimplemented from FRenderResource.

Reimplemented in FMorphVertexBuffer, TSlateElementVertexBuffer< VertexType >, TSlateElementVertexBuffer< UE::Math::TVector4 >, FSlateStencilClipVertexBuffer, FColorVertexBuffer, FPositionVertexBuffer, FSkeletalMeshVertexClothBuffer, FSkinWeightLookupVertexBuffer, and FSkinWeightDataVertexBuffer.

◆ GetRHI()

const FBufferRHIRef & FVertexBuffer::GetRHI ( ) const
inline

◆ operator=()

FVertexBuffer & FVertexBuffer::operator= ( const FVertexBuffer &  Other)
default

◆ ReleaseRHI()

void FVertexBuffer::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 FRenderResource.

Reimplemented in TSlateElementVertexBuffer< VertexType >, TSlateElementVertexBuffer< UE::Math::TVector4 >, FSlateStencilClipVertexBuffer, FSubUVBoundingGeometryBuffer, FDefaultGeometryCacheVertexBuffer, FDummyTangentBuffer, FParticleTileVertexBuffer, FGPUParticleVertexBuffer, FNullSubUVCutoutVertexBuffer, FMorphVertexBuffer, FParticleScratchVertexBuffer, FColorVertexBuffer, FPositionVertexBuffer, FSkeletalMeshVertexClothBuffer, FSkinWeightLookupVertexBuffer, FSkinWeightDataVertexBuffer, FBoneMapVertexBuffer, FNullColorVertexBuffer, FNullVertexBuffer, FVertexBufferWithSRV, and FPrimitiveIdDummyBuffer.

◆ SetRHI()

void FVertexBuffer::SetRHI ( const FBufferRHIRef &  BufferRHI)

Member Data Documentation

◆ VertexBufferRHI

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