CharSetManager Class Reference
#include <CharSetManager.h>
# Public Member Functions | |
| void | reset () |
| Empties internal virtual list of registered fonts. | |
| void | clearDRAM () |
| Erase the contents of CHAR memory space. | |
| void | loadCharSets (const CharSetSpec **charSetSpecs) |
| CharSet | getCharSet (const CharSetSpec *charSetSpec) |
| bool | releaseCharSet (CharSet charSet) |
| void | writeCharSets () |
| Write graphical data to VRAM. | |
| void | defragment (bool deferred) |
| int32 | getTotalUsedChars () |
| int32 | getTotalFreeChars () |
| int32 | getTotalCharSets () |
# Static Public Member Functions | |
| static void | print (int32 x, int32 y) |
# Protected Attributes | |
| VirtualList | charSets |
| Allocated char sets with a block in CHAR memory allocated to them. | |
| uint16 | freedOffset |
| Start offset in CHAR space when free memory starts. | |
# 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 CharSetManager
Inherits from Object
Manages char sets and CHAR memory allocation.
Definition at line 35 of file CharSetManager.h.
# Member Function Documentation
# clearDRAM()
| secure void CharSetManager::clearDRAM | ( | ) |
Erase the contents of CHAR memory space.
Definition at line 69 of file CharSetManager.c.
# defragment()
| secure void CharSetManager::defragment | ( | bool | deferred | ) |
Defragment CHAR space.
- Returns
- True if memory was defragmented; false otherwise
Definition at line 156 of file CharSetManager.c.
# getCharSet()
| CharSet CharSetManager::getCharSet | ( | const CharSetSpec * | charSetSpec | ) |
Retrieve a char set initialized with the provided spec.
- Parameters
-
charSetSpec Spec to use to initilize the desired char set
- Returns
- Char set initialized with the provided spec
Definition at line 92 of file CharSetManager.c.
# getTotalCharSets()
| int32 CharSetManager::getTotalCharSets | ( | ) |
Return the total number of char sets.
- Returns
- Total number of char sets
Definition at line 212 of file CharSetManager.c.
# getTotalFreeChars()
| int32 CharSetManager::getTotalFreeChars | ( | ) |
Return the total number of free CHARs in CHAR space.
- Returns
- Total number of free CHARs in CHAR space
Definition at line 205 of file CharSetManager.c.
# getTotalUsedChars()
| int32 CharSetManager::getTotalUsedChars | ( | ) |
Return the total number of used CHARs in CHAR space.
- Returns
- Total number of used CHARs in CHAR space
Definition at line 195 of file CharSetManager.c.
# loadCharSets()
| secure void CharSetManager::loadCharSets | ( | const CharSetSpec ** | charSetSpecs | ) |
Load char sets in function of the provided array of specs.
- Parameters
-
charSetSpecs Array of char set specs in function of which to load char sets
Definition at line 76 of file CharSetManager.c.
# print()
Print the manager's status.
- Parameters
-
x Screen x coordinate where to print y Screen y coordinate where to print
Definition at line 37 of file CharSetManager.c.
# releaseCharSet()
Release a char set.
- Parameters
-
charSet Char set to release
- Returns
- True if the char set is successfully deleted; false otherwise
Definition at line 128 of file CharSetManager.c.
# reset()
| secure void CharSetManager::reset | ( | ) |
Empties internal virtual list of registered fonts.
Definition at line 57 of file CharSetManager.c.
# writeCharSets()
| secure void CharSetManager::writeCharSets | ( | ) |
Write graphical data to VRAM.
Definition at line 317 of file CharSetManager.c.
# Member Data Documentation
# charSets
|
protected |
Allocated char sets with a block in CHAR memory allocated to them.
Definition at line 40 of file CharSetManager.h.
# freedOffset
|
protected |
Start offset in CHAR space when free memory starts.
Definition at line 43 of file CharSetManager.h.
The documentation for this class was generated from the following files:
- VUEngine-Core/source/Component/VisualComponent/Sprite/Texture/CharSet/CharSetManager.h
- VUEngine-Core/source/Component/VisualComponent/Sprite/Texture/CharSet/CharSetManager.c