MeshStagingBuffer

Scaleform::Render::MeshStagingBuffer

Declaration

class MeshStagingBuffer;

Description

MeshStagingBuffer acts as a short term cache that stores the generated meshes before they are instanced and copied into the Vertex/Index buffers. Typically the staging buffer will accumulate all of the meshes in the Batch before they are uploaded into the vertex buffers.

Meshes in the buffer can be pinned to ensure that they are not swapped out. There is a limit on the total size of the pinned items, which should correspond to the maximum total mesh size for the largest allowed batch in BatchProcessor.

PCs have a large mesh staging buffer; consoles, however, can get away with a smaller one since they can copy mesh data directly from the primitive instead.

Methods

Method	Description
GetBufferSize	Returns the size of the buffer for the cached meshes.
Initialize	Initializes the buffer for cached meshes.
MeshStagingBuffer	MeshStagingBuffer constructor.
~MeshStagingBuffer	Releases the meshes from the staging buffer.
AllocateMesh	Allocates buffer space for meshes and initializes it with the mesh.
Reset	Resets the mesh buffer, by removing the cached meshes from the buffer.
GetBuffer	Returns the buffer set aside for the cached meshes.
IsCached	Determines whether the mesh is in the MeshStagingBuffer.
PinMesh	Pins a mesh so that it cannot be swapped out by future Generate call.
UnpinMesh	Unpins the pinned meshes in the buffer.

File

Render_MeshCache.h