FGlobalDynamicIndexBuffer Class Reference

#include <GlobalRenderResources.h>

Public Types
using	FAllocation = FGlobalDynamicIndexBufferAllocation
using	FAllocationEx = FGlobalDynamicIndexBufferAllocationEx

Public Member Functions
	FGlobalDynamicIndexBuffer ()=default
	FGlobalDynamicIndexBuffer (FRHICommandListBase &InRHICmdList)
	~FGlobalDynamicIndexBuffer ()
void	Init (FRHICommandListBase &InRHICmdList)
RENDERCORE_API FAllocation	Allocate (uint32 NumIndices, uint32 IndexStride)
template<typename IndexType >
FAllocationEx	Allocate (uint32 NumIndices)
RENDERCORE_API void	Commit ()

Detailed Description

A system for dynamically allocating GPU memory for indices.

Member Typedef Documentation

FAllocation

using FGlobalDynamicIndexBuffer::FAllocation = FGlobalDynamicIndexBufferAllocation

FAllocationEx

using FGlobalDynamicIndexBuffer::FAllocationEx = FGlobalDynamicIndexBufferAllocationEx

Constructor & Destructor Documentation

FGlobalDynamicIndexBuffer() [1/2]

FGlobalDynamicIndexBuffer::FGlobalDynamicIndexBuffer ( )

default

FGlobalDynamicIndexBuffer() [2/2]

FGlobalDynamicIndexBuffer::FGlobalDynamicIndexBuffer ( FRHICommandListBase &  InRHICmdList )

inline

~FGlobalDynamicIndexBuffer()

FGlobalDynamicIndexBuffer::~FGlobalDynamicIndexBuffer ( )

inline

Member Function Documentation

Allocate() [1/2]

template<typename IndexType >

FAllocationEx FGlobalDynamicIndexBuffer::Allocate ( uint32  NumIndices )

inline

Helper function to allocate.

Parameters

NumIndices

- The number of indices to allocate.

Returns

an FAllocation with information regarding the allocated memory.

Allocate() [2/2]

FGlobalDynamicIndexBuffer::FAllocation FGlobalDynamicIndexBuffer::Allocate	(	uint32	NumIndices,
		uint32	IndexStride
	)

Allocates space in the global index buffer.

Parameters

NumIndices	- The number of indices to allocate.
IndexStride	- The size of an index (2 or 4 bytes).

Returns

An FAllocation with information regarding the allocated memory.

Commit()

void FGlobalDynamicIndexBuffer::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!

Init()

void FGlobalDynamicIndexBuffer::Init ( FRHICommandListBase &  InRHICmdList )

inline

---

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