Difference between revisions of "Reference"
From Gamebuino Wiki
(→display: added setFont()) |
(→sound: updated to the new sound library) |
||
| Line 45: | Line 45: | ||
== sound == | == sound == | ||
| − | + | Play & Stop | |
| − | |||
| − | Play | ||
<code> | <code> | ||
| − | * [[gb.sound. | + | * [[gb.sound.playTrack]](sound, channel) |
| + | * [[gb.sound.stopTrack]](''channel'') | ||
| + | * [[gb.sound.setTrackLooping]](channel, true/false) | ||
* [[gb.sound.isPlaying]](channel) | * [[gb.sound.isPlaying]](channel) | ||
| − | |||
| − | |||
| − | |||
</code> | </code> | ||
| − | + | Build-in sounds | |
<code> | <code> | ||
| − | * [[gb.sound. | + | * [[gb.sound.playOK]]() |
| − | * [[gb.sound. | + | * [[gb.sound.playCancel]]() |
| + | * [[gb.sound.playTick]]() | ||
</code> | </code> | ||
| − | + | Misc | |
<code> | <code> | ||
| − | * [[gb.sound. | + | * [[gb.sound.setVolume]](volume, ''channel'') |
| − | * [[gb.sound. | + | * [[gb.sound.getVolume]](''channel'') |
| − | * [[gb.sound. | + | * [[gb.sound.setInstruments]](instruments, channel) |
| + | * [[gb.sound.prescaler]] | ||
</code> | </code> | ||
Revision as of 2014-06-24T17:46:04
Here is listed and explained all Gamebuino specific functions (the Gamebuino Library).
See Arduino Reference for general purpose/basic functions and data types.
Note: Arguments in italic are optional.
core
- gb.begin
- gb.titleScreen(F("name"), logo)
- gb.update()
- gb.setFrameRate(fps)
- gb.frameCount
- gb.pickRandomSeed()
User interface :
- gb.changeGame()
- gb.getDefaultName(string) //10 char
- gb.menu(menu, length)
- gb.keyboard(string, length)
- gb.popup(F("text"), duration)
- gb.adjustVolume()
Perfomance monitor :
buttons
- gb.buttons.pressed(button)
- gb.buttons.released(button)
- gb.buttons.held(button, duration)
- gb.buttons.repeat(button, period)
- gb.buttons.timeHeld(button)
buttons:
BTN_A, BTN_B, BTN_C, BTN_UP, BTN_RIGHT, BTN_DOWN, BTN_LEFT
sound
Play & Stop
- gb.sound.playTrack(sound, channel)
- gb.sound.stopTrack(channel)
- gb.sound.setTrackLooping(channel, true/false)
- gb.sound.isPlaying(channel)
Build-in sounds
Misc
- gb.sound.setVolume(volume, channel)
- gb.sound.getVolume(channel)
- gb.sound.setInstruments(instruments, channel)
- gb.sound.prescaler
battery
- gb.battery.voltage
- gb.battery.level
- gb.battery.show = true/false
backlight
- gb.backlight.set(brightness)
- gb.backlight.automatic = true/false
- gb.backlight.backlightValue
- gb.backlight.ambientLight
The following should be set using SETTINGS.HEX
- gb.backlight.backlightMin = 0 to 255
- gb.backlight.backlightMax = 0 to 255
- gb.backlight.ambientLightMin = 0 to 1024
- gb.backlight.ambientLightMax = 0 to 1024
display
General :
- gb.display.setContrast(value)
- gb.display.clear()
- gb.display.update()
- gb.display.fillScreen(color)
- gb.display.persistence = true/false
- gb.setColor(color, background)
Pixels :
- gb.display.drawPixel(x, y)
- gb.display.getPixel(x, y)
Lines :
- gb.display.drawLine(x0, y0, x1, y1)
- gb.display.drawFastVLine(x, y, h)
- gb.display.drawFastHLine(x, y, w)
Rectangles :
- gb.display.drawRect(x, y, w, h)
- gb.display.fillRect(x, y, w, h)
- gb.display.drawRoundRect(x, y, w, h, r)
- gb.display.fillRoundRect(x, y, w, h, r)
Circles :
- gb.display.drawCircle(x, y, r)
- gb.display.fillCircle(x, y, r)
- gb.display.drawCircleHelper(x, y, r, corner)
- gb.display.fillCircleHelper(x, y, r, corner)
Triangles :
- gb.display.drawTriangle(x0, y0, x1, y1, x2, y2)
- gb.display.fillTriangle(x0, y0, x1, y1, x2, y2)
Bitmaps :
- gb.display.drawBitmap(x, y, bitmap, rotation, flip)
rotation: NOROT, ROTCCW, ROT180, ROTCW
flip: FLIPH, FLIPV, FLIPVH
Text :
- gb.display.drawChar(x, y, char, size)
- gb.display.print(text)
- gb.display.setCursor(x, y)
- gb.display.setFont(font)
- gb.display.setTextSize(size)
- gb.display.setTextWrap(true/false)
useful constants: LCDWIDTH, LCDHEIGHT, FONTWIDTH, FONTHEIGHT
