git.y1.nz

commit b278b3556913f95e15017a8309b226849b7fbe40
parent 6400fa1586158c04338d942c3f9805f39846ce7a
Author: bbbbbr <reg+github@roughhousing.com>
Date:   Wed,  8 Sep 2021 23:20:41 -0700

Merge pull request #253 from bbbbbr/docs_4_0_5

Docs: add descriptions for DEVICE_* constants
Diffstat:
M
gbdk-lib/include/gb/hardware.h
23
+++++++++++------------

1 file changed, 11 insertions(+), 12 deletions(-)
diff --git a/gbdk-lib/include/gb/hardware.h b/gbdk-lib/include/gb/hardware.h
@@ -361,17 +361,16 @@ __REG IE_REG;           /** Interrupt enable */
 
 #define OAMF_PALMASK 0b00000111
 
-#define DEVICE_SCREEN_X_OFFSET 0
-#define DEVICE_SCREEN_Y_OFFSET 0
-#define DEVICE_SCREEN_WIDTH 20
-#define DEVICE_SCREEN_HEIGHT 18
-#define DEVICE_SCREEN_BUFFER_WIDTH 32
-#define DEVICE_SCREEN_BUFFER_HEIGHT 32
-#define DEVICE_SCREEN_MAP_ENTRY_SIZE 1
-#define DEVICE_SPRITE_PX_OFFSET_X 8
-#define DEVICE_SPRITE_PX_OFFSET_Y 16
-#define DEVICE_SCREEN_PX_WIDTH (DEVICE_SCREEN_WIDTH * 8)
-#define DEVICE_SCREEN_PX_HEIGHT (DEVICE_SCREEN_HEIGHT * 8)
-
+#define DEVICE_SCREEN_X_OFFSET 0        /**< Offset of visible screen (in tile units) from left edge of hardware map */
+#define DEVICE_SCREEN_Y_OFFSET 0        /**< Offset of visible screen (in tile units) from top edge of hardware map */
+#define DEVICE_SCREEN_WIDTH 20          /**< Width of visible screen in tile units */
+#define DEVICE_SCREEN_HEIGHT 18         /**< Height of visible screen in tile units */
+#define DEVICE_SCREEN_BUFFER_WIDTH 32   /**< Width of hardware map buffer in tile units */
+#define DEVICE_SCREEN_BUFFER_HEIGHT 32  /**< Height of hardware map buffer in tile units */
+#define DEVICE_SCREEN_MAP_ENTRY_SIZE 1  /**< Number of bytes per hardware map entry */
+#define DEVICE_SPRITE_PX_OFFSET_X 8     /**< Offset of sprite X coordinate origin (in pixels) from left edge of visible screen */
+#define DEVICE_SPRITE_PX_OFFSET_Y 16    /**< Offset of sprite Y coordinate origin (in pixels) from top edge of visible screen */
+#define DEVICE_SCREEN_PX_WIDTH (DEVICE_SCREEN_WIDTH * 8)   /**< Width of visible screen in pixels */
+#define DEVICE_SCREEN_PX_HEIGHT (DEVICE_SCREEN_HEIGHT * 8) /**< Height of visible screen in pixels */
 
 #endif

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.