Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
MultiFixedPoolDecalSystemClass Class Reference

#include <decalsys.h>

Inherits DecalSystemClass.

Classes

class  LogicalDecalClass
 
class  LogicalDecalPoolClass
 

Public Member Functions

 MultiFixedPoolDecalSystemClass (uint32 num_pools, const uint32 *pool_sizes)
 
 MultiFixedPoolDecalSystemClass (const MultiFixedPoolDecalSystemClass &that)
 
virtual ~MultiFixedPoolDecalSystemClass (void)
 
virtual DecalGeneratorClass * Lock_Decal_Generator (void)
 
virtual void Unlock_Decal_Generator (DecalGeneratorClass *generator)
 
virtual void Decal_Mesh_Destroyed (uint32 id, DecalMeshClass *mesh)
 
void Clear_Decal_Slot (uint32 pool_id, uint32 slot_id)
 
void Clear_Pool (uint32 pool_id)
 
void Clear_All_Decals (void)
 
- Public Member Functions inherited from DecalSystemClass
 DecalSystemClass (void)
 
virtual ~DecalSystemClass (void)
 

Protected Member Functions

virtual uint32 Generate_Decal_Id (void)
 
LogicalDecalClass & find_logical_decal (uint32 pool_id, uint32 slot_id)
 
LogicalDecalClass & find_logical_decal (uint32 decal_id)
 

Static Protected Member Functions

static uint32 encode_decal_id (uint32 pool_id, uint32 slot_id)
 
static void decode_decal_id (uint32 decal_id, uint32 &pool_id, uint32 &slot_id)
 
- Static Protected Member Functions inherited from DecalSystemClass
static uint32 Generate_Unique_Global_Decal_Id (void)
 

Protected Attributes

uint32 Generator_PoolID
 
uint32 Generator_SlotID
 
LogicalDecalPoolClass * Pools
 
uint32 PoolCount
 

Additional Inherited Members

- Static Protected Attributes inherited from DecalSystemClass
static uint32 DecalIDGenerator = 0
 

Detailed Description

MultiFixedPoolDecalSystemClass: This is for decal systems which use several fixed-size decal pools (If more than one pool is used, it is usually to have separate pools for several different classes of decals). Note that here the decal IDs are a combination of the pool and slot ids. (decal ids only have to be unique within a given decal system)

Definition at line 216 of file decalsys.h.

Constructor & Destructor Documentation

◆ MultiFixedPoolDecalSystemClass() [1/2]

MultiFixedPoolDecalSystemClass::MultiFixedPoolDecalSystemClass ( uint32 num_pools,
const uint32 * pool_sizes )

Definition at line 297 of file decalsys.cpp.

◆ MultiFixedPoolDecalSystemClass() [2/2]

MultiFixedPoolDecalSystemClass::MultiFixedPoolDecalSystemClass ( const MultiFixedPoolDecalSystemClass & that)

Definition at line 314 of file decalsys.cpp.

◆ ~MultiFixedPoolDecalSystemClass()

MultiFixedPoolDecalSystemClass::~MultiFixedPoolDecalSystemClass ( void )
virtual

Definition at line 330 of file decalsys.cpp.

Member Function Documentation

◆ Clear_All_Decals()

void MultiFixedPoolDecalSystemClass::Clear_All_Decals ( void )

Definition at line 384 of file decalsys.cpp.

◆ Clear_Decal_Slot()

void MultiFixedPoolDecalSystemClass::Clear_Decal_Slot ( uint32 pool_id,
uint32 slot_id )

Definition at line 368 of file decalsys.cpp.

◆ Clear_Pool()

void MultiFixedPoolDecalSystemClass::Clear_Pool ( uint32 pool_id)

Definition at line 374 of file decalsys.cpp.

◆ Decal_Mesh_Destroyed()

void MultiFixedPoolDecalSystemClass::Decal_Mesh_Destroyed ( uint32 id,
DecalMeshClass * mesh )
virtual

Reimplemented from DecalSystemClass.

Definition at line 356 of file decalsys.cpp.

◆ decode_decal_id()

static void MultiFixedPoolDecalSystemClass::decode_decal_id ( uint32 decal_id,
uint32 & pool_id,
uint32 & slot_id )
inlinestaticprotected

Definition at line 270 of file decalsys.h.

◆ encode_decal_id()

static uint32 MultiFixedPoolDecalSystemClass::encode_decal_id ( uint32 pool_id,
uint32 slot_id )
inlinestaticprotected

Definition at line 269 of file decalsys.h.

◆ find_logical_decal() [1/2]

MultiFixedPoolDecalSystemClass::LogicalDecalClass & MultiFixedPoolDecalSystemClass::find_logical_decal ( uint32 decal_id)
protected

Definition at line 407 of file decalsys.cpp.

◆ find_logical_decal() [2/2]

MultiFixedPoolDecalSystemClass::LogicalDecalClass & MultiFixedPoolDecalSystemClass::find_logical_decal ( uint32 pool_id,
uint32 slot_id )
protected

Definition at line 396 of file decalsys.cpp.

◆ Generate_Decal_Id()

virtual uint32 MultiFixedPoolDecalSystemClass::Generate_Decal_Id ( void )
inlineprotectedvirtual

Reimplemented from DecalSystemClass.

Definition at line 255 of file decalsys.h.

◆ Lock_Decal_Generator()

DecalGeneratorClass * MultiFixedPoolDecalSystemClass::Lock_Decal_Generator ( void )
virtual

Reimplemented from DecalSystemClass.

Definition at line 340 of file decalsys.cpp.

◆ Unlock_Decal_Generator()

void MultiFixedPoolDecalSystemClass::Unlock_Decal_Generator ( DecalGeneratorClass * generator)
virtual

Reimplemented from DecalSystemClass.

Definition at line 348 of file decalsys.cpp.

Member Data Documentation

◆ Generator_PoolID

uint32 MultiFixedPoolDecalSystemClass::Generator_PoolID
protected

Definition at line 256 of file decalsys.h.

◆ Generator_SlotID

uint32 MultiFixedPoolDecalSystemClass::Generator_SlotID
protected

Definition at line 257 of file decalsys.h.

◆ PoolCount

uint32 MultiFixedPoolDecalSystemClass::PoolCount
protected

Definition at line 300 of file decalsys.h.

◆ Pools

LogicalDecalPoolClass* MultiFixedPoolDecalSystemClass::Pools
protected

Definition at line 299 of file decalsys.h.

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