-
Notifications
You must be signed in to change notification settings - Fork 2
Tool Reference
Lucas Scharenbroich edited this page Jun 7, 2022
·
4 revisions
<style>
h2 { font-family: helvetica, sans-serif; }
</style>
To introduce you to the capabilities of the GTE Tool Set the routines are grouped by function and briefly described in Table 1. These routines are described in detail later where they are separated into housekeeping routines (discussed in routine number order) and the rest of the GTE Tool Set routines (discussed in alphabetical order).
| Table 1 | ||
|---|---|---|
| GTE Tool Set routines and their functions | ||
| Routine | Description | |
| Housekeeping Routines | ||
| GTEBootInit | Initializes the GTE Tool Set; called only by the Tool Locator — must not be called by an application | |
| GTEStartUp | Starts up the GTE Tool Set for use by an application | |
| GTEShutDown | Shuts down the GTE Tool Set when an application quits | |
| GTEVersion | Returns the version number of the GTE Tool Set | |
| GTEReset | Resets the GTE Tool Set; called only when the system is reset — must not be called by an application | |
| GTEStatus | Indicates whether the GTE Tool Set is active | |
| Sprite Routines | ||
| GTENewSprite | Creates a sprite from a bitmap and an optional mask | |
| GTEDisposeSprite | Deallocates the memory for a sprite | |
| Tile Routines | ||
| GTENewTile | Creates a tile from a bitmap and an optional mask | |
| GTEDisposeTile | Deallocates the memory for a tile | |
| GTESetTile | Assigns a compiled tile to a tile map index | |
| GTEGetTile | Returns the tile assigned to a tile map index | |
| Primary Background Routines | ||
| GTESetBG0TileMap | Sets the tile map for the primary background | |
| GTESetBG0Origin | Sets the upper-left origin point in the primary background | |
| GTERefreshBG0 | Redraw a subset of the visible tiles on the primary background | |
| GTESetBG0FringeMap | Set the fringe map for the primary background. Fringe tiles are drawn on top of the tile map | |
| GTECopyToBG0 | Copy a pixel image to the primary background | |
| Secondary Background Routines | ||
| GTESetBG1TileMap | Sets the tile map for background #1 | |
| GTESetBG1FringeMap | Set the fringe map for the secondary background. Fringe tiles are drawn on top of the tile map | |
| Functions affecting the global state | ||
| GTESetFieldRect | Sets the playing field's port rectangle to the specificed rectangle | |
| GTEGetFieldRect | Returns the playing field's port rectangle | |
| GTESetBGColor | Set the transparent color index. Pass -1 for no transparency. | |
| Misc. Functions | ||
| GTEGetAddress | Returns a pointer to a user-visible internal table | |
| GTEToolNum | Returns the tool number assigned to GTE | |