git.y1.nz

commit f907f23c7ce0c2cf0b23ee1bc00b48fed32fc06e
parent 60ce3c8441fbbc8ef34a01873ffd1184d5ae5501
Author: bbbbbr <reg+github@roughhousing.com>
Date:   Wed, 23 Jun 2021 19:49:00 -0700

Merge pull request #205 from bbbbbr/docs_misc2

Docs: add note about removal of drawing ISRs via mode switch
Diffstat:
M
gbdk-lib/include/gb/drawing.h
5
+++--

1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/gbdk-lib/include/gb/drawing.h b/gbdk-lib/include/gb/drawing.h
@@ -9,7 +9,8 @@
     in APA mode - use gprintf() and wrtchr() instead.
 
     Note: Using drawing.h will cause it's custom VBL and LCD ISRs
-    (`drawing_vbl` and `drawing_lcd`) to be installed.
+    (`drawing_vbl` and `drawing_lcd`) to be installed. Changing
+    the mode (`mode(M_TEXT_OUT);`) will cause them to be de-installed.
 
     The valid coordinate ranges are from (x,y) 0,0 to 159,143.
     There is no built-in clipping, so drawing outside valid
@@ -19,7 +20,7 @@
 
     __Important note for the drawing API :__
 
-        The Game Boy graphics hardware is not well suited to frame-buffer
+    The Game Boy graphics hardware is not well suited to frame-buffer
     style graphics such as the kind provided in `drawing.h`.
     Due to that, __most drawing functions (rectangles, circles, etc) will
     be slow__ . When possible it's much faster and more efficient

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