Difference between revisions of "Gb.update"

From Gamebuino Wiki
Jump to: navigation, search
m (Example: added right parenthesis)
(Changed title depth)
Line 1: Line 1:
 
{{DISPLAYTITLE:gb.update}}
 
{{DISPLAYTITLE:gb.update}}
 
__NOTOC__
 
__NOTOC__
= Description =
+
== Description ==
 
Returns true and updates everything (display, sound, batter monitor, etc.) at a fixed frequency (20 times per second by default).
 
Returns true and updates everything (display, sound, batter monitor, etc.) at a fixed frequency (20 times per second by default).
  
 
It should be used in a specific conditional structure, see "Syntax".
 
It should be used in a specific conditional structure, see "Syntax".
  
= Syntax =
+
== Syntax ==
 
<pre>
 
<pre>
 
while(1){
 
while(1){
Line 15: Line 15:
 
</pre>
 
</pre>
  
= Parameters =
+
== Parameters ==
 
none
 
none
  
= Returns =
+
== Returns ==
 
boolean: true if enough time has elapsed since the last frame (20 frames per second = 50ms per frame).
 
boolean: true if enough time has elapsed since the last frame (20 frames per second = 50ms per frame).
  
= Example =
+
== Example ==
 
<pre>
 
<pre>
 
#include <SPI.h>
 
#include <SPI.h>
Line 46: Line 46:
 
</pre>
 
</pre>
  
= See also =
+
== See also ==
 
*[[gb.begin]]
 
*[[gb.begin]]
 
*[[gb.setFrameRate]]
 
*[[gb.setFrameRate]]

Revision as of 2014-05-18T09:57:06


Description

Returns true and updates everything (display, sound, batter monitor, etc.) at a fixed frequency (20 times per second by default).

It should be used in a specific conditional structure, see "Syntax".

Syntax

while(1){
  if(gb.update()){
    //your game here
  }
}

Parameters

none

Returns

boolean: true if enough time has elapsed since the last frame (20 frames per second = 50ms per frame).

Example

#include <SPI.h>
#include <Gamebuino.h>
Gamebuino gb;

void setup(){
  gb.begin(F("Example game"));

  while(1){ //loops forever
    if(gb.update()){ //update everything
    
      //put your game here. I will run at a fixed frequency (20 times per second by default)

      if(gb.buttons.pressed(BTN_C)) //break out of the loop if C is pressed
        break;
    }
  }
}

void loop(){

}

See also