The SGADE Documentation

the SGADE The Socrates Gameboy Advance Development Engine

The SGADE is a development library for the Nintendo Gameboy Advance. It's free for all uses and is distributed without guarantees. For more information visit the SGADE page.


Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

SoBkgFont Struct Reference
[SoBkgFont]

Background font structure. More...

#include <SoBkgFont.h>


Data Fields

u16 m_FirstChar
 First valid character in the font.

u16 m_NumChars
 Number of valid characters in the font.

u16 m_TileOffset
 Offset added to each mapped index.

u16m_CharMap
 character remapping data


Detailed Description

Background font structure.

A single SoBkgFont instance represents a mapping from ASCII characters to tile indices in a TileSet. Note that there is no requirement that the tiles be either 16 or 256 color. This allows the same font mapping to be used with both 16 and 256 color tile sets -- though to do this care must be taken to ensure that the font indices are valid in both tile sets.

All the members are private. Use the methods instead.

Todo:
Create a variable size extension to this (width only or width/height)


Field Documentation

u16* SoBkgFont::m_CharMap
 

character remapping data

For internal use only.

u16 SoBkgFont::m_FirstChar
 

First valid character in the font.

For internal use only.

u16 SoBkgFont::m_NumChars
 

Number of valid characters in the font.

For internal use only.

u16 SoBkgFont::m_TileOffset
 

Offset added to each mapped index.

For internal use only.


The documentation for this struct was generated from the following file:
Copyright 2002 by the SGADE authors. See SoLicense.h or Visit the SGADE page for more information.