From d5eacce55f03b51783a86e46fdecec0e67c7caca Mon Sep 17 00:00:00 2001 From: Lucas Scharenbroich Date: Mon, 27 Jun 2022 20:19:41 -0500 Subject: [PATCH] Update function list --- docs/_config.yml | 6 +++--- docs/toolboxref.markdown | 29 +++++++++++++++++++++++++++-- 2 files changed, 30 insertions(+), 5 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 47f4509..731b7b7 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -21,11 +21,11 @@ title: Generic Tile Engine for the Apple IIgs email: lscharen@gmail.com description: >- # this means to ignore newlines until "baseurl:" - high-performance library for writing tile-based games for the Apple IIgs personal computer in 65816 assembly langugage. Unlock the full, 16-bit potential of the last machine of the Apple ][ line. + A high-performance library for writing tile-based games for the Apple IIgs personal computer in 65816 assembly langugage. Unlock the full, 16-bit potential of the last machine of the Apple ][ line. baseurl: "" # the subpath of your site, e.g. /blog url: "" # the base hostname & protocol for your site, e.g. http://example.com -twitter_username: jekyllrb -github_username: jekyll +twitter_username: lscharen +github_username: lscharen # Build settings theme: minima diff --git a/docs/toolboxref.markdown b/docs/toolboxref.markdown index 6a02f46..eb67878 100644 --- a/docs/toolboxref.markdown +++ b/docs/toolboxref.markdown @@ -69,14 +69,39 @@ permalink: /tool-ref/ Tile Routines GTELoadTileSetCopies a tileset into the GTE tileset memory - GTESetTileAssigns a tile to a tile map index + GTESetTileAssigns a tile to a tile store + GTEGetTileAtRetrieves the tile ID stored in the tile store + GTECopyTileToDynamicCopies a tile from the tileset memory into the managed dynamic tile memory. Changing the dynamic tile data will result in all of the tiles updating + on the next call the GTERender() + GTEGetTileDataAddrReturns the base address of the tiledata memory + GTEFillTileStoreFills the entire tile store with a tile ID. Primary Background Routines GTESetBG0OriginSets the upper-left origin point in the primary background GTERenderDraws the current scene to the graphics screen + GTEGetBG0TileMapInfoReturns a record describing the number of tiles in the primary tilemap and a pointer to the tilemap data. + GTESetBG0TileMapInfoDefines a tile map for the primary background + GTERefreshForces all of the tiles in the tile store to be refreshed on the next render. + + Secondary Background Routines + GTESetBG1OriginSets the upper-left origin point in the secondary background + GTECopyPicToBG1Copies an uncompressed pixel image into the secondard background buffer + GTESetBG1TileMapInfoDefines a tile map for the secondary background + + Timer Routines + GTEAddTimerAdd a timer callback that is fired after a designated number of VBL ticks + GTERemoveTimerRemoves an active timer + GTEStartScriptRegisters a GTE script to be handled in the background + + Overlay Routines + GTESetOverlayRegisters an overlay routine to be integrated into the renderer. Typically used for status bars or messages. + GTEClearOverlayRemoves the current overlay from the renderer Functions affecting the global state GTESetScreenModeSets the playing field's port rectangle to a pre-defined size, or a specified width and height + GTESetPaletteCopies a palette to the Super HiRes palette memory + GTEBindSCBArrayTakes an array of SCB bytes and binds them to either the Primary or Secondary background's vertical position + GTEGetScreenInfoReturns a records describing the origin, width and height of the playfield on the physical graphics screen. Misc. Functions GTEReadControlReads the keyboard and returns key events in a gamepad structure @@ -363,7 +388,7 @@ GTE Tool Set routines

GTEGetAddress

- Returns the address of an internal GTE Tool Set array. + Returns the address of an internal GTE Tool Set array.