PrimitiveBatch

Scaleform::Render::PrimitiveBatch

Declaration

class PrimitiveBatch : public ListNode<PrimitiveBatch>;

Description

PrimitiveBatch is a set of consecutive meshes.

Data Members

Data Member	Description
LargeMesh	Large meshes have size that is past the threshold and hence cannot be batched; they can, however, be instanced.
Type	Flag bit for the type of rendering performed.
pFormat	Destination vertex format applied to the contents of this buffer.
MeshNode	A node representing mesh cache item.

Enumerations

Enumeration	Description
BatchType	An enumeration indicating the batch type of rendering performed.

Methods

Method	Description
CalcMeshSizes	Calculates the total vertex and index count in the batch.
ClearCacheItem	Clears the mesh data from the buffer.
Create	Creates a batch of primitives.
GetCacheItem	Obtains the mesh data from the buffer.
GetMeshCount	Retrieves the count of meshes in the primitive that owns the current batch.
GetMeshes_InstanceAdjusted	Returns the meshes whose batching/instancing size has been adjusted.
GetMeshIndex	Retrieves the index of the meshes in the primitive that owns the current batch.
GetNext	Returns pointer to the next node or the next mesh batch in the PrimitiveBatch.
GetPrev	Returns a pointer to the previous node or the previous mesh batch in the PrimitiveBatch.
GetPrimitive	Returns the primitive that owns the batch.
Init	Called by Create instead of constructor for initializing.
IsInstanced	Determines whether the meshes are instanced meshes or not.
IsVirtual	Determines whether the meshes are virtual meshes or not.
RemoveAndFree	Removes the current batch of primitives and frees its data.
SetCacheItem	Sets the mesh data in the buffer.

File

Render_Primitive.h