Difference between revisions of "Reference"
From Gamebuino Wiki
(→core) |
|||
| Line 6: | Line 6: | ||
== core == | == core == | ||
| + | <code> | ||
* [[gb.begin]](''F("name")'', ''logo'') | * [[gb.begin]](''F("name")'', ''logo'') | ||
* [[gb.update]]() | * [[gb.update]]() | ||
* [[gb.setFrameRate]](fps) | * [[gb.setFrameRate]](fps) | ||
* [[gb.frameCount]] | * [[gb.frameCount]] | ||
| + | </code> | ||
User interface : | User interface : | ||
| + | <code> | ||
* [[changeGame()]] | * [[changeGame()]] | ||
* [[gb.menu]](menu, length) | * [[gb.menu]](menu, length) | ||
| Line 16: | Line 19: | ||
* [[gb.popup]](F("text")) | * [[gb.popup]](F("text")) | ||
* [[gb.adjustVolume]]() | * [[gb.adjustVolume]]() | ||
| + | </code> | ||
Perfomance monitor : | Perfomance monitor : | ||
| + | <code> | ||
* [[gb.getCpuLoad]]() | * [[gb.getCpuLoad]]() | ||
* [[gb.freeRam]]() | * [[gb.freeRam]]() | ||
* [[gb.frameDurationMicros]] | * [[gb.frameDurationMicros]] | ||
| + | </code> | ||
== buttons == | == buttons == | ||
| − | + | <code> | |
* [[gb.buttons.pressed]]() | * [[gb.buttons.pressed]]() | ||
* [[gb.buttons.released]]() | * [[gb.buttons.released]]() | ||
| Line 28: | Line 34: | ||
* [[gb.buttons.repeat]]() | * [[gb.buttons.repeat]]() | ||
* [[gb.buttons.timeHeld]]() | * [[gb.buttons.timeHeld]]() | ||
| + | </code> | ||
== sound == | == sound == | ||
Play : | Play : | ||
| + | <code> | ||
* [[gb.sound.play]]() | * [[gb.sound.play]]() | ||
* [[gb.sound.isPlaying]]() | * [[gb.sound.isPlaying]]() | ||
* [[gb.sound.stop]]() | * [[gb.sound.stop]]() | ||
* [[gb.sound.setLooping]]() | * [[gb.sound.setLooping]]() | ||
| + | </code> | ||
Volume : | Volume : | ||
| + | <code> | ||
* [[gb.sound.setGlobalVolume]]() | * [[gb.sound.setGlobalVolume]]() | ||
* [[gb.sound.getGlobalVolume]]() | * [[gb.sound.getGlobalVolume]]() | ||
* [[gb.sound.setChannelVolume]]() | * [[gb.sound.setChannelVolume]]() | ||
* [[gb.sound.getChannelVolume]]() | * [[gb.sound.getChannelVolume]]() | ||
| + | </code> | ||
Build-in sounds : | Build-in sounds : | ||
| + | <code> | ||
* [[gb.sound.playOK]]() | * [[gb.sound.playOK]]() | ||
* [[gb.sound.playCancel]]() | * [[gb.sound.playCancel]]() | ||
* [[gb.sound.playTick]]() | * [[gb.sound.playTick]]() | ||
| + | </code> | ||
== battery == | == battery == | ||
| − | + | <code> | |
* [[gb.battery.getVoltage]]() | * [[gb.battery.getVoltage]]() | ||
* [[gb.battery.getLevel]]() | * [[gb.battery.getLevel]]() | ||
* [[gb.battery.display]]() | * [[gb.battery.display]]() | ||
| + | </code> | ||
== backlight == | == backlight == | ||
| − | + | <code> | |
* [[gb.backlight.set]]() | * [[gb.backlight.set]]() | ||
* [[gb.backlight.setAuto]]() | * [[gb.backlight.setAuto]]() | ||
| + | </code> | ||
</div><div style="float:left;width:20em;margin-right:2em;"> | </div><div style="float:left;width:20em;margin-right:2em;"> | ||
| Line 62: | Line 77: | ||
== display == | == display == | ||
General : | General : | ||
| + | <code> | ||
* [[gb.display.setContrast]]() | * [[gb.display.setContrast]]() | ||
* [[gb.display.clear]]() | * [[gb.display.clear]]() | ||
| Line 67: | Line 83: | ||
* [[gb.display.fillScreen]]() | * [[gb.display.fillScreen]]() | ||
* [[gb.display.persistance]] | * [[gb.display.persistance]] | ||
| + | </code> | ||
Pixels : | Pixels : | ||
| + | <code> | ||
* [[gb.display.drawPixel]]() | * [[gb.display.drawPixel]]() | ||
* [[gb.display.getPixel]]() | * [[gb.display.getPixel]]() | ||
| + | </code> | ||
Lines : | Lines : | ||
| + | <code> | ||
* [[gb.display.drawLine]]() | * [[gb.display.drawLine]]() | ||
* [[gb.display.drawFastVLine]]() | * [[gb.display.drawFastVLine]]() | ||
* [[gb.display.drawFastHLine]]() | * [[gb.display.drawFastHLine]]() | ||
| + | </code> | ||
Rectangles : | Rectangles : | ||
| + | <code> | ||
* [[gb.display.drawRect]]() | * [[gb.display.drawRect]]() | ||
* [[gb.display.fillRect]]() | * [[gb.display.fillRect]]() | ||
* [[gb.display.drawRoundRect]]() | * [[gb.display.drawRoundRect]]() | ||
* [[gb.display.fillRoundRect]]() | * [[gb.display.fillRoundRect]]() | ||
| + | </code> | ||
Circles : | Circles : | ||
| + | <code> | ||
* [[gb.display.drawCircle]]() | * [[gb.display.drawCircle]]() | ||
* [[gb.display.drawCircleHelper]]() | * [[gb.display.drawCircleHelper]]() | ||
* [[gb.display.fillCircle]]() | * [[gb.display.fillCircle]]() | ||
* [[gb.display.fillCircleHelper]]() | * [[gb.display.fillCircleHelper]]() | ||
| + | </code> | ||
Triangles : | Triangles : | ||
| + | <code> | ||
* [[gb.display.drawTriangle]]() | * [[gb.display.drawTriangle]]() | ||
* [[gb.display.fillTriangle]]() | * [[gb.display.fillTriangle]]() | ||
| + | </code> | ||
Bitmaps : | Bitmaps : | ||
| + | <code> | ||
* [[gb.display.drawBitmap]]() | * [[gb.display.drawBitmap]]() | ||
* [[gb.display.setBitmapColor]]() | * [[gb.display.setBitmapColor]]() | ||
| + | </code> | ||
Text : | Text : | ||
| + | <code> | ||
* [[gb.display.drawChar]]() | * [[gb.display.drawChar]]() | ||
* [[gb.display.print]]() | * [[gb.display.print]]() | ||
| Line 104: | Line 134: | ||
* [[gb.display.setTextSize]]() | * [[gb.display.setTextSize]]() | ||
* [[gb.display.setTextWrap]]() | * [[gb.display.setTextWrap]]() | ||
| + | </code> | ||
</div> | </div> | ||
Revision as of 2014-04-20T10:47:48
The Reference lists and explains all the functions of the Library.
Arguments in italic are optional.
core
- gb.begin(F("name"), logo)
- gb.update()
- gb.setFrameRate(fps)
- gb.frameCount
User interface :
- changeGame()
- gb.menu(menu, length)
- gb.keyboard(text, length)
- gb.popup(F("text"))
- gb.adjustVolume()
Perfomance monitor :
buttons
- gb.buttons.pressed()
- gb.buttons.released()
- gb.buttons.held()
- gb.buttons.repeat()
- gb.buttons.timeHeld()
sound
Play :
Volume :
- gb.sound.setGlobalVolume()
- gb.sound.getGlobalVolume()
- gb.sound.setChannelVolume()
- gb.sound.getChannelVolume()
Build-in sounds :
battery
backlight
display
General :
- gb.display.setContrast()
- gb.display.clear()
- gb.display.update()
- gb.display.fillScreen()
- gb.display.persistance
Pixels :
Lines :
Rectangles :
Circles :
- gb.display.drawCircle()
- gb.display.drawCircleHelper()
- gb.display.fillCircle()
- gb.display.fillCircleHelper()
Triangles :
Bitmaps :
Text :
- gb.display.drawChar()
- gb.display.print()
- gb.display.setCursor()
- gb.display.setTextColor()
- gb.display.setTextSize()
- gb.display.setTextWrap()
