CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

csRenderMeshHolderMultiple Class Reference

Helper class to retrieve an unused array of csRenderMesh*. More...

#include <cstool/rendermeshholder.h>

List of all members.

Public Member Functions

 csRenderMeshHolderMultiple (bool deleteMeshes=true)
 Construct a new render mesh array holder.
csDirtyAccessArray< csRenderMesh * > & GetUnusedMeshes (uint frameNumber)
 Retrieve an unused array of csRenderMesh*.
void Clear ()
 Instruct the mesh holder to throw away all currently used csRenderMesh* arrays, effectively using clean arrays on subsequent calls when an unused array is needed.

Public Attributes

bool deleteMeshes
 Whether to delete the rendermeshes contained in the managed arrays.


Detailed Description

Helper class to retrieve an unused array of csRenderMesh*.

Manages a list of csRenderMesh* array and returns one whose first contained csRenderMesh has it's inUse member set to false (the assumption is that when one mesh is unused, all are).

Definition at line 71 of file rendermeshholder.h.


Constructor & Destructor Documentation

csRenderMeshHolderMultiple::csRenderMeshHolderMultiple bool  deleteMeshes = true  ) 
 

Construct a new render mesh array holder.

Parameters:
deleteMeshes Whether to delete the contained rendermeshes.


Member Function Documentation

void csRenderMeshHolderMultiple::Clear  ) 
 

Instruct the mesh holder to throw away all currently used csRenderMesh* arrays, effectively using clean arrays on subsequent calls when an unused array is needed.

Remarks:
The arrays are *not* immediately deleted, this is delayed until they really aren't used any more (determined by the frame number). This has to be considered if manual mesh deletion was enabled.

csDirtyAccessArray<csRenderMesh*>& csRenderMeshHolderMultiple::GetUnusedMeshes uint  frameNumber  ) 
 

Retrieve an unused array of csRenderMesh*.

Parameters:
frameNumber Current frame number - used to determine unused meshes.


Member Data Documentation

bool csRenderMeshHolderMultiple::deleteMeshes
 

Whether to delete the rendermeshes contained in the managed arrays.

Definition at line 81 of file rendermeshholder.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1