Gb.h - Revision history

Caseyweederman: /* Important functions: */ Link to the set_sprite_prop page

2016-06-19T08:56:09Z

‎Important functions:: Link to the set_sprite_prop page

Caseyweederman: set_sprite_data correction

2016-06-11T06:43:20Z

set_sprite_data correction

Caseyweederman: Adding to category

2016-06-03T14:30:10Z

Adding to category

Caseyweederman: Added a couple of functions.

2016-06-03T14:24:07Z

Added a couple of functions.

Caseyweederman: A couple of errors fixed

2016-06-03T14:12:48Z

A couple of errors fixed

Caseyweederman: gb.h function overview page started with brief descriptions and an example

2016-06-03T14:10:59Z

gb.h function overview page started with brief descriptions and an example

New page

<code>gb/gb.h</code> handles basic inputs and drawing background and sprites to the screen.

== Important definitions: ==

<code>J_START</code>, <code>J_SELECT</code>, <code>J_B</code>, <code>J_A</code>, <code>J_DOWN</code>, <code>J_UP</code>, <code>J_LEFT</code>, and <code>J_RIGHT</code> are keyed to these specific hardware inputs, and can be checked with the <code>joypad()</code> function.

== Important functions: ==
<code>delay(UINT16 d)()</code> waits for the specified number of milliseconds.

<code>joypad(void)</code> checks the input buttons of the Game Boy and returns the state of each button.

<code>set_sprite_data(UINT8 first_tile, UINT8 nb_tiles, unsigned char *data)</code> feeds a tile as described in array <code>data</code> into sprite data, starting at <code>first_tile</code> and writing for <code>nb_tiles</code> number of tiles.

<code>set_sprite_tile(UINT8 nb, UINT8 tile)</code> displays tile number <code>tile</code> of sprite number <code>nb</code>.

<code>move_sprite( UINT8 nb, UINT8 x, UINT8 y)</code> moves sprite number <code>nb</code> to position <code>x</code>, <code>y</code> on the screen.

<code>SHOW_SPRITES</code> turns on the sprite layer.


<div class="toccolours mw-collapsible mw-collapsed">
Example:
<div class="mw-collapsible-content">
<pre>
#include <gb/gb.h> //include the main GBDK library header
//This example successfully compiles under GBDK version 2.96a
//and draws a rudimentary check mark when the start button is pressed.

unsigned char Check[] = //A simple sprite to load, made in GBTD
{
0x00,0x00,0x01,0x01,0x02,0x02,0x44,0x44,
0x28,0x28,0x10,0x10,0x00,0x00,0x00,0x00
};

int main(){ //the main and required function
while(1){ //loop forever
if(joypad() & J_START){ //If joypad() indicates that Start is pressed...
set_sprite_data(0, 1, Check); //Turn the array into sprite number 0
set_sprite_tile(0, 0); //Draw sprite number 0 to the screen
move_sprite(0, 80, 80); //Move sprite number 0 to the middle of the screen
SHOW_SPRITES; //Turn on the sprite layer
}
}

} //end of main function

</pre>
</div>
</div>

@@ Line 14: / Line 14: @@
 <code>set_sprite_tile(UINT8 nb, UINT8 tile)</code> sets active sprite tile number <code>nb</code> to a sprite set with <code>set_sprite_data</code>.
-<code>set_sprite_prop(UINT8 nb, UINT8 prop)</code> sets various properties of the tile, like where the sprite is drawn relative to other layers and which way it is facing.
+<code>[[GBDK set sprite prop|set_sprite_prop(UINT8 nb, UINT8 prop)]]</code> sets various properties of the tile, like where the sprite is drawn relative to other layers and which way it is facing. The properties are stored in binary, see the [[GBDK set sprite prop|set_sprite_prop tutorial]] on how to combine and revert properties.
 <code>move_sprite( UINT8 nb, UINT8 x, UINT8 y)</code> moves sprite number <code>nb</code> to position <code>x</code>, <code>y</code> on the screen. Note: Everything before 8, 16 is invisible.

← Older revision		Revision as of 14:30, 3 June 2016
Line 52:		Line 52:
	</div>		</div>
	</div>		</div>
		+	[[Category:GBDK]]

@@ Line 14: / Line 14: @@
 <code>set_sprite_tile(UINT8 nb, UINT8 tile)</code> displays tile number <code>tile</code> of sprite number <code>nb</code>.
-<code>move_sprite( UINT8 nb, UINT8 x, UINT8 y)</code> moves sprite number <code>nb</code> to position <code>x</code>, <code>y</code> on the screen.
+<code>set_sprite_prop(UINT8 nb, UINT8 prop)</code> sets various properties of the tile, like where the sprite is drawn relative to other layers and which way it is facing.
 <code>SHOW_SPRITES;</code> turns on the sprite layer.

@@ Line 12: / Line 12: @@
 <code>set_sprite_data(UINT8 first_tile, UINT8 nb_tiles, unsigned char *data)</code> feeds a tile as described in array <code>data</code> into sprite data, starting at <code>first_tile</code> and writing for <code>nb_tiles</code> number of tiles.
-<code>set_sprite_tile(UINT8 nb, UINT8 tile)</code> displays tile number <code>tile</code> of sprite number <code>nb</code>.
+<code>set_sprite_tile(UINT8 nb, UINT8 tile)</code> sets active sprite tile number <code>nb</code> to a sprite set with <code>set_sprite_data</code>.
 <code>set_sprite_prop(UINT8 nb, UINT8 prop)</code> sets various properties of the tile, like where the sprite is drawn relative to other layers and which way it is facing.
@@ Line 41: / Line 41: @@
      if(joypad() & J_START){ //If joypad() indicates that Start is pressed...
      	set_sprite_data(0, 1, Check); //Turn the array into sprite number 0
-     	set_sprite_tile(0, 0); //Draw tile 0 of sprite number 0 to the screen
+     	set_sprite_tile(0, 0); //Draw sprite number 0 into tile number 0
      	move_sprite(0, 80, 80); //Move sprite number 0 to the middle of the screen
      	SHOW_SPRITES; //Turn on the sprite layer

@@ Line 6: / Line 6: @@
 == Important functions: ==
-<code>delay(UINT16 d)()</code> waits for the specified number of milliseconds.
+<code>delay(UINT16 d)</code> waits for the specified number of milliseconds.
 <code>joypad(void)</code> checks the input buttons of the Game Boy and returns the state of each button.
@@ Line 16: / Line 16: @@
 <code>move_sprite( UINT8 nb, UINT8 x, UINT8 y)</code> moves sprite number <code>nb</code> to position <code>x</code>, <code>y</code> on the screen.
-<code>SHOW_SPRITES</code> turns on the sprite layer.
+<code>SHOW_SPRITES;</code> turns on the sprite layer.
-<!-- Honestly this code block could be a transclusion and stored elsewhere -->
+<!-- Honestly this code block could be stored elsewhere and transcluded -->
 <div class="toccolours mw-collapsible mw-collapsed">
 Example:
@@ Line 37: / Line 37: @@
      if(joypad() & J_START){ //If joypad() indicates that Start is pressed...
      	set_sprite_data(0, 1, Check); //Turn the array into sprite number 0
-     	set_sprite_tile(0, 0); //Draw sprite number 0 to the screen
+     	set_sprite_tile(0, 0); //Draw tile 0 of sprite number 0 to the screen
      	move_sprite(0, 80, 80); //Move sprite number 0 to the middle of the screen
      	SHOW_SPRITES; //Turn on the sprite layer