FGlobalDynamicVertexBuffer Class Reference

#include <GlobalRenderResources.h>

Public Types
using	FAllocation = FGlobalDynamicVertexBufferAllocation

Public Member Functions
	FGlobalDynamicVertexBuffer ()=default
	FGlobalDynamicVertexBuffer (FRHICommandListBase &InRHICmdList)
	~FGlobalDynamicVertexBuffer ()
void	Init (FRHICommandListBase &InRHICmdList)
RENDERCORE_API FAllocation	Allocate (uint32 SizeInBytes)
RENDERCORE_API void	Commit ()
void	GarbageCollect ()
RENDERCORE_API bool	IsRenderAlarmLoggingEnabled () const

Detailed Description

A system for dynamically allocating GPU memory for vertices.

Member Typedef Documentation

FAllocation

using FGlobalDynamicVertexBuffer::FAllocation = FGlobalDynamicVertexBufferAllocation

Constructor & Destructor Documentation

FGlobalDynamicVertexBuffer() [1/2]

FGlobalDynamicVertexBuffer::FGlobalDynamicVertexBuffer ( )

default

FGlobalDynamicVertexBuffer() [2/2]

FGlobalDynamicVertexBuffer::FGlobalDynamicVertexBuffer ( FRHICommandListBase &  InRHICmdList )

inline

~FGlobalDynamicVertexBuffer()

FGlobalDynamicVertexBuffer::~FGlobalDynamicVertexBuffer ( )

inline

Member Function Documentation

Allocate()

FGlobalDynamicVertexBuffer::FAllocation FGlobalDynamicVertexBuffer::Allocate

(

uint32

SizeInBytes

)

Allocates space in the global vertex buffer.

Parameters

SizeInBytes

- The amount of memory to allocate in bytes.

Returns

An FAllocation with information regarding the allocated memory.

Commit()

void FGlobalDynamicVertexBuffer::Commit

(

)

Commits allocated memory to the GPU. WARNING: Once this buffer has been committed to the GPU, allocations remain valid only until the next call to Allocate!

GarbageCollect()

void FGlobalDynamicVertexBuffer::GarbageCollect ( )

inline

Init()

void FGlobalDynamicVertexBuffer::Init ( FRHICommandListBase &  InRHICmdList )

inline

IsRenderAlarmLoggingEnabled()

bool FGlobalDynamicVertexBuffer::IsRenderAlarmLoggingEnabled

(

)

const

Returns true if log statements should be made because we exceeded GMaxVertexBytesAllocatedPerFrame

---

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

• Engine/Source/Runtime/RenderCore/Public/GlobalRenderResources.h
• Engine/Source/Runtime/RenderCore/Private/GlobalRenderResources.cpp