From 011f5c041991160e4c3b6a63397d3671e8b4e0a4 Mon Sep 17 00:00:00 2001 From: Lucas Scharenbroich Date: Mon, 6 Mar 2023 15:14:22 -0600 Subject: [PATCH] Doc updates --- docs/toolboxref.html | 118 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 106 insertions(+), 12 deletions(-) diff --git a/docs/toolboxref.html b/docs/toolboxref.html index 988b373..3f80e4c 100644 --- a/docs/toolboxref.html +++ b/docs/toolboxref.html @@ -89,7 +89,11 @@ style: toolref GTECreateSpriteStamp - Creates a sprite stamp from the tile set + Creates a sprite stamp from the tile set + + + GTECompilepriteStamp + Created a compiled sprite from a sprite stamp GTEAddSprite @@ -794,12 +798,12 @@ style: toolref width - Word—Width of the playfield in pixels. Must be even. + Word—Width of the playfield in bytes. Must be even. height - Word—Height of the playfield in pixels. + Word—Height of the playfield in scanlines. @@ -1424,6 +1428,90 @@ style: toolref +
+

$2DXX

+

GTECompileSpriteStamp

+

+ Creates a compiled sprite in a special compilation buffer from an existing sprite stamp. The return value + is an address token that can be passed into the AddSprite function in place of the vBuffAddr parameter as + long as the `SPRITE_COMPILED` flag is set. +

+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Stack before call
previous contents
wordspaceWord—Space for result
spriteIdentWord—sprite identifier word
vBuffAddrWord—Location in the sprite vitual buffer.
←SP
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Stack after call
previous contents
addrWord—Location in the sprite compilation buffer.
←SP
+
+
+
Errors
+

None

+
+
+
C
+

extern pascal Word GTECompileSpriteStamp(spriteIdent, vBuffAddr)

+

Word spriteIdent;

+

Word vBuffAddr;

+
+
+

$10XX

GTEAddSprite

@@ -1451,9 +1539,19 @@ style: toolref previous contents - spriteDescriptor + spriteSlot - Word—Sprite descriptor word that is used to set the status bits. + Word—The slot to assign the sprite to. There are 16 slots and sprites in lower slots are drawn above the sprites in higher slots. + + + spriteFlags + + Word—Sprite flags that define the sprite's properties. + + + vBuffAddr + + Word—Sprite address in the VBUFF space, or a compiled sprite address x @@ -1465,11 +1563,6 @@ style: toolref Word—Signed vertical sprite position on the playfield. - - spriteSlot - - Word—The slot to assign the sprite to. There are 16 slots and sprites in lower slots are drawn above the sprites in higher slots. - ← @@ -1505,11 +1598,12 @@ style: toolref
C
-

extern pascal void GTEAddSprite(spriteDescriptor, x, y, spriteSlot)

+

extern pascal void GTEAddSprite(spriteSlot, spriteFlags, vBuffAddr, x, y)

+

Word spriteSlot;

Word spriteDescriptor;

+

Word vBuffAddr;

Word x;

Word y;

-

Word spriteSlot;

Sprite Descriptor