Difference between revisions of "Reference"

From Gamebuino Wiki
Jump to: navigation, search
(core)
m ("Library" link removed)
 
(48 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
The Reference lists and explains all the functions of the [[Library]].
+
Here is listed and explained all Gamebuino specific functions, part of the Gamebuino Library (see [[Getting started]] to install it).
  
Arguments in ''italic'' are optional.
+
See [http://arduino.cc/en/Reference/HomePage Arduino Reference] for general purpose/basic functions and data types.
<div style="float:left;width:38em;margin-right:2em;">
 
  
== core ==
+
Note: Arguments in ''italic'' are optional.
 +
<div style="float:left;width:480px;margin-right:10px;">
 +
 
 +
== Core ==
 
<code>
 
<code>
* [[gb.begin]](''F("name")'', ''logo'')
+
* [[gb.begin]]()
 +
* [[gb.titleScreen]](''F("name")'', ''logo'')
 
* [[gb.update]]()
 
* [[gb.update]]()
 
* [[gb.setFrameRate]](fps)
 
* [[gb.setFrameRate]](fps)
 +
* [[gb.pickRandomSeed]]()
 +
* [[gb.changeGame]]()
 
* [[gb.frameCount]]
 
* [[gb.frameCount]]
 +
* [[gb.getDefaultName]](string) //10 char
 
</code>
 
</code>
 
User interface :
 
User interface :
 
<code>
 
<code>
* [[gb.changeGame]]()
 
 
* [[gb.menu]](menu, length)
 
* [[gb.menu]](menu, length)
* [[gb.keyboard]](text, length)
+
* [[gb.keyboard]](string, length)
* [[gb.popup]](F("text"))
+
* [[gb.popup]](F("text"), duration)
* [[gb.adjustVolume]]()
+
</code>
 +
Physics:
 +
<code>
 +
* [[gb.collidePointRect]](x1,y1,x2,y2,w,h)
 +
* [[gb.collideRectRect]](x1,y1,w1,h1,x2,y2,w2,h2)
 +
* [[gb.collideBitmapBitmap]](x1, y1, b1, x2, y2, b2)
 
</code>
 
</code>
 
Perfomance monitor :
 
Perfomance monitor :
 
<code>
 
<code>
 
* [[gb.getCpuLoad]]()
 
* [[gb.getCpuLoad]]()
* [[gb.freeRam]]()
+
* [[gb.getFreeRam]]()
 
* [[gb.frameDurationMicros]]
 
* [[gb.frameDurationMicros]]
 
</code>
 
</code>
  
== buttons ==
+
== Buttons ==
 
<code>
 
<code>
 
* [[gb.buttons.pressed]](button)
 
* [[gb.buttons.pressed]](button)
Line 34: Line 44:
 
* [[gb.buttons.repeat]](button, period)
 
* [[gb.buttons.repeat]](button, period)
 
* [[gb.buttons.timeHeld]](button)
 
* [[gb.buttons.timeHeld]](button)
button:
+
buttons:
  
 
BTN_A, BTN_B, BTN_C, BTN_UP, BTN_RIGHT, BTN_DOWN, BTN_LEFT
 
BTN_A, BTN_B, BTN_C, BTN_UP, BTN_RIGHT, BTN_DOWN, BTN_LEFT
 
</code>
 
</code>
  
== sound ==
+
== Sound ==
Play :
+
* [[Sound]] : overall explanation of how the sound library works
<code>
+
 
* [[gb.sound.play]](sound)
+
Tracks<code>
 +
* [[gb.sound.playTrack]](track, channel)
 +
* [[gb.sound.stopTrack]](''channel'')
 +
* [[gb.sound.changePatternSet]](patternSet, channel)
 +
</code>Pattern<code>
 +
* [[gb.sound.playPattern]](sound, channel)
 +
* [[gb.sound.stopPattern]](''channel'')
 +
* [[gb.sound.setPatternLooping]](boolean, channel)
 
* [[gb.sound.isPlaying]](channel)
 
* [[gb.sound.isPlaying]](channel)
* [[gb.sound.stop]](''channel'')
+
</code>Notes & commands<code>
* [[gb.sound.setLooping]](channel, true/false)
+
* [[gb.sound.playNote]](pitch, duration, channel)
* [[gb.sound.prescaler]]
+
* [[gb.sound.command]](command, X, Y, channel)
 +
* [[gb.sound.changeInstrumentSet]](instrumentSet, channel)
 
</code>
 
</code>
  
Volume :
+
Build-in sounds
 
<code>
 
<code>
* [[gb.sound.setVolume]](volume, ''channel'')
+
* [[gb.sound.playOK]]()
* [[gb.sound.getVolume]](''channel'')
+
* [[gb.sound.playCancel]]()
 +
* [[gb.sound.playTick]]()
 
</code>
 
</code>
  
Build-in sounds :
+
Misc
 
<code>
 
<code>
* [[gb.sound.playOK]]()
+
* [[gb.sound.setVolume]](volume, ''channel'')
* [[gb.sound.playCancel]]()
+
* [[gb.sound.getVolume]](''channel'')
* [[gb.sound.playTick]]()
+
* [[gb.sound.setInstruments]](instruments, channel)
 +
* [[gb.sound.prescaler]]
 
</code>
 
</code>
  
== battery ==
+
== Battery ==
 
<code>
 
<code>
 
* [[gb.battery.voltage]]
 
* [[gb.battery.voltage]]
Line 69: Line 89:
 
</code>
 
</code>
  
== backlight ==
+
== Backlight ==
 
<code>
 
<code>
 
* [[gb.backlight.set]](brightness)
 
* [[gb.backlight.set]](brightness)
Line 75: Line 95:
 
* [[gb.backlight.backlightValue]]
 
* [[gb.backlight.backlightValue]]
 
* [[gb.backlight.ambientLight]]
 
* [[gb.backlight.ambientLight]]
 +
 +
The following should be set using SETTINGS.HEX
 
* [[gb.backlight.backlightMin]] = 0 to 255
 
* [[gb.backlight.backlightMin]] = 0 to 255
 
* [[gb.backlight.backlightMax]] = 0 to 255
 
* [[gb.backlight.backlightMax]] = 0 to 255
Line 81: Line 103:
 
</code>
 
</code>
  
</div><div style="float:left;width:38em;margin-right:0em;">
+
</div><div style="float:left;width:480px;margin-right:0;">
 +
 
 +
== Display ==
 +
Useful constants: <code>LCDWIDTH, LCDHEIGHT, gb.display.fontWidth, gb.display.fontHeight</code>
  
== display ==
 
 
General :
 
General :
 
<code>
 
<code>
* [[gb.display.setContrast]](50 to 70)
 
 
* [[gb.display.clear]]()
 
* [[gb.display.clear]]()
 
* [[gb.display.update]]()
 
* [[gb.display.update]]()
 
* [[gb.display.fillScreen]](color)
 
* [[gb.display.fillScreen]](color)
* [[gb.display.persistance]] = true/false
+
* [[gb.display.setColor]](color, ''background'')
* [[gb.setColor]](color, ''background'')
+
* [[gb.display.persistence]] = true/false
 
</code>
 
</code>
  
Line 120: Line 143:
 
* [[gb.display.fillCircle]](x, y, r)
 
* [[gb.display.fillCircle]](x, y, r)
 
* [[gb.display.drawCircleHelper]](x, y, r, corner)
 
* [[gb.display.drawCircleHelper]](x, y, r, corner)
* [[gb.display.fillCircleHelper]](x, y, r, corner)
+
* [[gb.display.fillCircleHelper]](x, y, r, corner, delta)
 
</code>
 
</code>
  
 
Triangles :
 
Triangles :
 
<code>
 
<code>
* [[gb.display.drawTriangle]](x0, y0, x1, y1, x2, y2)
+
* [[gb.display.drawTriangle]](x0,y0,x1,y1,x2,y2)
* [[gb.display.fillTriangle]](x0, y0, x1, y1, x2, y2)
+
* [[gb.display.fillTriangle]](x0,y0,x1,y1,x2,y2)
 
</code>
 
</code>
  
 
Bitmaps :
 
Bitmaps :
 
<code>
 
<code>
* [[gb.display.drawBitmap]](x, y, bitmap, ''rotation, flip'')
+
* [[gb.display.drawBitmap]](x,y,bitmap,''rotation'',''flip'')
 
 
rotation: NOROT, ROTCCW, ROT180, ROTCW
 
 
 
flip: FLIPH, FLIPV, FLIPVH
 
 
</code>
 
</code>
 +
* rotation: <code>NOROT, ROTCCW, ROT180, ROTCW</code>
 +
* flip: <code>NOFLIP, FLIPH, FLIPV, FLIPVH</code>
  
 
Text :
 
Text :
 
<code>
 
<code>
 +
* [[gb.display.print]](text or numbers)
 +
* [[gb.display.println]](text or numbers)
 
* [[gb.display.drawChar]](x, y, char, size)
 
* [[gb.display.drawChar]](x, y, char, size)
* [[gb.display.print]](text)
+
* [[gb.display.setFont]](font)
* [[gb.display.setCursor]](x, y)
+
* [[gb.display.cursorX]] = x
* [[gb.display.setTextSize]](size)
+
* [[gb.display.cursorY]] = y
* [[gb.display.setTextWrap]](true/false)
+
* [[gb.display.fontSize]] = size
 +
* [[gb.display.textWrap]] = true/false
 
</code>
 
</code>
  
 +
Advanced :
 +
<code>
 +
* [[gb.display.getBuffer]]()
 +
* [[gb.display.getBitmapPixel]](bitmap, x, y)
 +
</code>
  
 
</div>
 
</div>

Latest revision as of 2014-09-06T12:22:52

Here is listed and explained all Gamebuino specific functions, part of the Gamebuino Library (see Getting started to install it).

See Arduino Reference for general purpose/basic functions and data types.

Note: Arguments in italic are optional.

Core

User interface :

Physics:

Perfomance monitor :

Buttons

buttons:

BTN_A, BTN_B, BTN_C, BTN_UP, BTN_RIGHT, BTN_DOWN, BTN_LEFT

Sound

  • Sound : overall explanation of how the sound library works

Tracks

Pattern

Notes & commands

Build-in sounds

Misc

Battery

Backlight

The following should be set using SETTINGS.HEX

Display

Useful constants: LCDWIDTH, LCDHEIGHT, gb.display.fontWidth, gb.display.fontHeight

General :

Pixels :

Lines :

Rectangles :

Circles :

Triangles :

Bitmaps :

  • rotation: NOROT, ROTCCW, ROT180, ROTCW
  • flip: NOFLIP, FLIPH, FLIPV, FLIPVH

Text :

Advanced :