1. Home
  2. Documentation
  3. API
  4. ParamTableManager Class Reference

ParamTableManager Class Reference

#include <ParamTableManager.h>

Inheritance diagram for ParamTableManager:
Object

# Public Member Functions

void reset ()
 Reset the animation coordinator factory's state.
uint32 configure (int32 availableBgmapSegmentsForParamTable)
uint32 allocate (BgmapSprite bgmapSprite)
void free (BgmapSprite bgmapSprite)
void defragment (bool deferred)
uint32 getParamTableEnd ()

# Static Public Member Functions

static void print (int32 x, int32 y)

# Protected Attributes

uint32 size
 Total size of param table.
uint32 usedBytes
 Number of used bytes.
VirtualList bgmapSprites
 List of sprites with allocated param tables.
ParamTableFreeData paramTableFreeData
 Struct used to keep track of the next free block in param table space.
BgmapSprite previouslyMovedBgmapSprite
uint32 paramTableBase
uint32 paramTableEnd

# Additional Inherited Members

- Private Member Functions inherited from Object
void constructor ()
 Class' constructor.
const void * getVTable ()
bool mutateTo (const void *targetClass)
- Static Private Member Functions inherited from Object
static Object getCast (void *object, ClassPointer targetClassGetClassMethod, ClassPointer baseClassGetClassMethod)
- Private Attributes inherited from Object
void * vTable
 Pointer to the class's virtual table.

# Detailed Description

Class ParamTableManager

Inherits from Object

Manages param table space allocating and releasing blocks in it.

Definition at line 96 of file ParamTableManager.h.

# Member Function Documentation

# allocate()

secure uint32 ParamTableManager::allocate ( BgmapSprite bgmapSprite)

Allocate a param table for the provided sprite

Parameters
bgmapSpriteSprite for which a param table will be allocated

Definition at line 126 of file ParamTableManager.c.

# configure()

secure uint32 ParamTableManager::configure ( int32 availableBgmapSegmentsForParamTable)

Retrieve the param table displacement in bytes used to keep track of the start address of param table space.

Parameters
availableBgmapSegmentsForParamTableNumber of available BGMAP segments for the param tables
Returns
Displacement in bytes to keep track of the start address of param table space

Definition at line 94 of file ParamTableManager.c.

# defragment()

secure void ParamTableManager::defragment ( bool deferred)

Defragment param table space.

Parameters
deferredFlag to defragment param table memory over time

Definition at line 236 of file ParamTableManager.c.

# free()

secure void ParamTableManager::free ( BgmapSprite bgmapSprite)

Free the param table allocated for the provided sprite.

Parameters
bgmapSpriteSprite whose param table has to be freed

Definition at line 199 of file ParamTableManager.c.

# getParamTableEnd()

uint32 ParamTableManager::getParamTableEnd ( )

Retrieve the address where the param table ends.

Returns
Address where the param table ends

Definition at line 290 of file ParamTableManager.c.

# print()

static void ParamTableManager::print ( int32 x,
int32 y )
static

Print the information about param table space usage.

Parameters
xScreen x coordinate where to print
yScreen y coordinate where to print

Definition at line 40 of file ParamTableManager.c.

# reset()

secure void ParamTableManager::reset ( )

Reset the animation coordinator factory's state.

Definition at line 70 of file ParamTableManager.c.

# Member Data Documentation

# bgmapSprites

VirtualList ParamTableManager::bgmapSprites
protected

List of sprites with allocated param tables.

Definition at line 107 of file ParamTableManager.h.

# paramTableBase

uint32 ParamTableManager::paramTableBase
protected

Definition at line 117 of file ParamTableManager.h.

# paramTableEnd

uint32 ParamTableManager::paramTableEnd
protected

Definition at line 120 of file ParamTableManager.h.

# paramTableFreeData

ParamTableFreeData ParamTableManager::paramTableFreeData
protected

Struct used to keep track of the next free block in param table space.

Definition at line 110 of file ParamTableManager.h.

# previouslyMovedBgmapSprite

BgmapSprite ParamTableManager::previouslyMovedBgmapSprite
protected

Cache of the last sprite whose param table was moved during the defragmentation of param table space

Definition at line 114 of file ParamTableManager.h.

# size

uint32 ParamTableManager::size
protected

Total size of param table.

Definition at line 101 of file ParamTableManager.h.

# usedBytes

uint32 ParamTableManager::usedBytes
protected

Number of used bytes.

Definition at line 104 of file ParamTableManager.h.


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