Fix/clarify blit directionality

Author: runer112

examples/gfx_sprite_keys/src/main.c

@@ -24,7 +24,7 @@ void draw_sprite(int x, int y) {
     /* Draw a bunch of different styled sprites on the screen */
     gfx_Sprite(ubuntu, x, y);
 
-    /* Draw to the screen */
+    /* Copy the buffer to the screen */
     gfx_BlitBuffer(); // This is the same as gfx_Blit(gfx_buffer)
 }
 

src/graphx/graphx.asm

@@ -1777,13 +1777,13 @@ smcByte _Color
 gfx_Blit:
 ; Copies the buffer image to the screen and vice versa
 ; Arguments:
-;  arg0 : Buffer to copy to (screen = 0, buffer = 1)
+;  arg0 : Buffer to copy from (screen = 0, buffer = 1)
 ; Returns:
 ;  None
 	pop	iy			; iy = return vector
 	ex	(sp),hl
-	ld	a,l			; a = buffer to blit to
-	call	_CheckBlit		; determine which buffer to blit
+	ld	a,l			; a = buffer to blit from
+	call	_CheckBlit		; determine blit buffers
 	ld	bc,LcdSize
 _Blit_Ldir:
 	ldir				; just do it
@@ -1793,14 +1793,14 @@ _Blit_Ldir:
 gfx_BlitLines:
 ; Copies the buffer image to the screen and vice versa line wise
 ; Arguments:
-;  arg0 : Buffer to copy to (screen = 0, buffer = 1)
+;  arg0 : Buffer to copy from (screen = 0, buffer = 1)
 ;  arg1 : Y coordinate
 ;  arg2 : Number of lines to copy
 ; Returns:
 ;  None
 	pop	iy			; iy = return vector
 	pop	bc
-	ld	a,c			; a = buffer to blit to
+	ld	a,c			; a = buffer to blit from
 	pop	de			; e = number of lines to copy
 	ex	(sp),hl			; l = y coordinate
 	push	de
@@ -1814,7 +1814,7 @@ gfx_BlitLines:
 	mlt	hl
 	add	hl,hl			; hl -> offset to start at
 	push	hl
-	call	_CheckBlit		; determine which buffer to blit
+	call	_CheckBlit		; determineblit buffers
 	pop	bc
 	add	hl,bc
 	ex	de,hl
@@ -1827,7 +1827,7 @@ gfx_BlitLines:
 gfx_BlitRectangle:
 ; Copies the buffer image to the screen and vice versa rectangularly
 ; Arguments:
-;  arg0 : Buffer to copy to (screen = 0, buffer = 1)
+;  arg0 : Buffer to copy from (screen = 0, buffer = 1)
 ;  arg1 : X coordinate
 ;  arg2 : Y coordinate
 ;  arg3 : Width
@@ -1843,8 +1843,8 @@ gfx_BlitRectangle:
 	add	hl,hl
 	add	hl,de			; hl = amount to increment
 	push	hl			; save amount to increment
-	ld	a,(iy+3)
-	call	_CheckBlit		; determine which buffer to blit
+	ld	a,(iy+3)		; a = buffer to blit from
+	call	_CheckBlit		; determine blit buffers
 	pop	bc
 	add	hl,bc
 	ex	de,hl

src/graphx/graphx.h

@@ -726,8 +726,8 @@ void gfx_SetDraw(uint8_t location);
  * @brief Different locations routines can be drawn to
  */
 typedef enum {
-    gfx_screen = 0, /**< Draw to screen */
-    gfx_buffer      /**< Draw to buffer */
+    gfx_screen = 0, /**< Screen */
+    gfx_buffer      /**< Buffer */
 } gfx_draw_location_t;
 
 /**
@@ -784,34 +784,34 @@ void gfx_Wait(void);
  * Copies the input buffer to the opposite buffer
  *
  * No clipping is performed; as it is a copy not a draw
- * @param location gfx_screen - copies screen to buffer
- * @param location gfx_buffer - copies buffer to screen
+ * @param src drawing location to copy from
+ * @see gfx_draw_location_t
  */
-void gfx_Blit(uint8_t location);
+void gfx_Blit(uint8_t src);
 
 /**
  * Copies lines from the input buffer to the opposite buffer
  *
  * No clipping is performed; as it is a copy not a draw
- * @param location gfx_screen - copies screen to buffer
- * @param location gfx_buffer - copies buffer to screen
+ * @param src drawing location to copy from
  * @param y_loc Y Location to begin copying at
  * @param num_lines Number of lines to copy
+ * @see gfx_draw_location_t
  */
-void gfx_BlitLines(uint8_t location, uint8_t y_loc, uint8_t num_lines);
+void gfx_BlitLines(uint8_t src, uint8_t y_loc, uint8_t num_lines);
 
 /**
  * Copies a rectangle from the input buffer to the opposite buffer
  *
  * No clipping is performed; as it is a copy not a draw
- * @param location gfx_screen - copies screen to buffer
- * @param location gfx_buffer - copies buffer to screen
+ * @param src drawing location to copy from
  * @param x X coordinate
  * @param y Y coordinate
  * @param width Width of rectangle
  * @param height Height of rectangle
+ * @see gfx_draw_location_t
  */
-void gfx_BlitRectangle(uint8_t location, uint24_t x, uint8_t y, uint24_t width, uint24_t height);
+void gfx_BlitRectangle(uint8_t src, uint24_t x, uint8_t y, uint24_t width, uint24_t height);
 
 /**
  * Copies the screen to the buffer