diff --git a/docs/toolboxref.html b/docs/toolboxref.html index c159bb7..731fc90 100644 --- a/docs/toolboxref.html +++ b/docs/toolboxref.html @@ -1272,6 +1272,37 @@ style: toolref

Word spriteID;

Word vBuffAddr;

+
+
Sprite Descriptor
+

+ The sprite descriptor is a subset of the full sprite bitfield. Only the starting Tile Index and + the size bits are used. +

+

+ When a sprite has a size greater than 8x8, the horizontal tiles are taken from the next tile index + and the vertical tiles are taken from tileID + 32. This is why tile sheets should be saved + with a width of 256 pixels. +

+ + + + + + + + + + +
1514131211109876543210
+ + + + + + + +
Bits 0-8tileIndexThe index of a tile in the current Tile Set that defines the top-left part of the sprite
Bit 9-10ReservedMust be zero.
Bits 11-12fSpriteSizeSets the size of the sprite
  • 00 - 8x8
  • 01 - 8x16
  • 10 - 16x8
  • 11 - 16x16
Bit 13-15ReservedMust be zero.
+
@@ -1360,6 +1391,37 @@ style: toolref

Word y;

Word vBuffAddr;

+
+
Sprite Descriptor
+

+ The sprite descriptor defines the rendering properties of a sprite. +

+

+ When a sprite has a size greater than 8x8, the horizontal tiles are taken from the next tile index + and the vertical tiles are taken from tileID + 32. This is why tile sheets should be saved + with a width of 256 pixels. +

+ + + + + + + + + +
1514131211109876543210
+ + + + + + + + + +
Bits 0-8tileIndexThe index of a tile in the current Tile Set that defines the top-left part of the sprite
Bit 9fSpriteHorzFlipFlips the sprite horizontally.
Bit 10fSpriteVertFlipFlips the sprite vertically.
Bits 11-12fSpriteSizeSets the size of the sprite
  • 00 - 8x8
  • 01 - 8x16
  • 10 - 16x8
  • 11 - 16x16
Bit 13fSpriteHideWhen set, does not render the sprite.
Bit 14-15ReservedMust be zero.
+
@@ -1933,7 +1995,9 @@ style: toolref

$19XX

GTEGetBG0TileMapInfo

-

+

+ Returns information about the current BG0 tile map. +

Parameters
@@ -2021,7 +2085,9 @@ style: toolref

$1AXX

GTEGetScreenInfo

-

+

+ Returns information about the current position and size of the play field. +

Parameters
@@ -2119,7 +2185,10 @@ style: toolref

$1BXX

GTESetBG1Origin

-

+

+ Sets the coordinate of the upper-left corner of the playfield within the secondary background buffer. The coordiate values + are unsigned, so transitioning from 0 to -1 will result in a discontinuous jump in the background position. +

Parameters
@@ -2135,6 +2204,18 @@ style: toolref + + + xpos + + + + + + ypos + + + @@ -2169,13 +2250,19 @@ style: toolref
C
+

extern pascal void GTESetBG1Origin(x, y)

+

Word x;

+

Word y;

$1CXX

GTEGetTileAt

-

+

+ Returns the tile at a local coordinate poiint. The primary use of this function is to lookup + a Tile ID using a sprite's coordinates. +

Parameters
previous contents
Word—Unsigned horizontal position
Word—Unsigned vertical position
@@ -2191,6 +2278,21 @@ style: toolref + + + + + + + + + + + + + + + @@ -2212,6 +2314,11 @@ style: toolref + + + + + @@ -2225,6 +2332,9 @@ style: toolref
C
+

extern pascal Word GTEGetTileAt(x, y)

+

Word x;

+

Word y;

@@ -2679,7 +2789,9 @@ style: toolref

$25XX

GTEFillTileStore

-

+

+ Fills the entire Tile Store with a specific Tile ID value. +

Parameters
previous contents
wordspaceWord—Space for result
xWord—Local play field horizontal coordinate
yWord—Local play field vertical coordinate
previous contents
TileIDWord—Tile ID at the play field coordinates.
@@ -2695,6 +2807,11 @@ style: toolref + + + + + @@ -2729,62 +2846,30 @@ style: toolref
C
+

extern pascal void GTEFillTileStore(tileID)

+

Word tileID;

$26XX

GTERefresh

-

+

+ Forces a refresh of the play field. This is implemented by adding all of the visible tiles to the dirty tile + queue which will force them to be redrawn on the next call to GTERender(). +

Parameters
-
previous contents
tileIDWord—Tile ID to store into the tile store memory.
- - - - - - - - - - - - - - - - - - -
Stack before call
previous contents
SP
- - - - - - - - - - - - - - - - - - - - -
Stack after call
previous contents
SP
+

+ The stack is not affected by this call. There are no input or output parameters. +

Errors
C
+

extern pascal void GTERefresh()