Mini font (MINIFONT)


Defines

#define MINIFONTnibbles(src)   (1548)
 The size of a MINIFONT in nibbles.

Functions

bool isMINIFONT (SatAddr src)
 is object a Mini font (MINIFONT)?
SatAddr MINIFONTitem (SatAddr src, int ch)
 Return the Saturn address of a character's MINIFONT entry.
int MINIFONTgetId (SatAddr src)
 Get the minifont ID number.
bool MINIFONTsetId (SatAddr src, int id)
 Set the MINIFONT id.
SatAddr makeMINIFONT ()
 create a new MINIFONT object in TEMPOB. The contents of the minifont are undefined

Detailed Description

A MINIFONT maps ASCII characters to 6-nibble graphical representations. See chapter 56.16 in "Saturn Assembly Language Programming" for details.

Define Documentation

#define MINIFONTnibbles ( src   )     (1548)

The size of a MINIFONT in nibbles.

Parameters:
src Saturn address of the MINIFONT. Although unnecessary, the parameter is included for consistency
Returns:
Always returns 1558


Function Documentation

bool isMINIFONT ( SatAddr  src  ) 

is object a Mini font (MINIFONT)?

Parameters:
src Saturn address of an object
Returns:
true if the object at src is a MINIFONT

SatAddr makeMINIFONT (  ) 

create a new MINIFONT object in TEMPOB. The contents of the minifont are undefined

Returns:
the Saturn address of the new MINIFONT

int MINIFONTgetId ( SatAddr  src  ) 

Get the minifont ID number.

Parameters:
src The Saturn address of a minifont
Returns:
The ID number for the minifont, or -1 if src isn't a MINIFONT

SatAddr MINIFONTitem ( SatAddr  src,
int  ch 
)

Return the Saturn address of a character's MINIFONT entry.

This returns the address of the 6-nibble minifont entry corresponding to ASCII char ch. Once you have the entry, you can read or change it with sat_peek() and sat_poke()

Parameters:
src The Saturn address of the MINIFONT
ch The ASCII character
Returns:
Saturn address of the 6-nibble minifont entry. If src isn't a MINIFONT or if ch is not an ASCII character, then it returns 0

bool MINIFONTsetId ( SatAddr  src,
int  id 
)

Set the MINIFONT id.

Parameters:
src The Saturn address of a minifont
id The new ID number. id must be between 0 and 0xff
Returns:
true on success, or false if src isn't a MINIFONT or if id is out of range.


Generated on Sat Apr 3 16:38:31 2010 for HPObjects by  doxygen 1.5.0