http://legacy.gamebuino.com/wiki/api.php?action=feedcontributions&user=Tiash&feedformat=atom
Gamebuino Wiki - User contributions [en]
2024-03-29T09:49:51Z
User contributions
MediaWiki 1.29.1
http://legacy.gamebuino.com/wiki/index.php?title=Reference&diff=685
Reference
2014-07-29T13:04:34Z
<p>Tiash: /* display */</p>
<hr />
<div>__NOTOC__<br />
Here is listed and explained all Gamebuino specific functions (the Gamebuino [[Library]]).<br />
<br />
See [http://arduino.cc/en/Reference/HomePage Arduino Reference] for general purpose/basic functions and data types.<br />
<br />
Note: Arguments in ''italic'' are optional.<br />
<div style="float:left;width:480px;margin-right:10px;"><br />
<br />
== core ==<br />
<code><br />
* [[gb.begin]]()<br />
* [[gb.update]]()<br />
* [[gb.setFrameRate]](fps)<br />
* [[gb.pickRandomSeed]]()<br />
* [[gb.changeGame]]()<br />
* [[gb.frameCount]]<br />
</code><br />
User interface :<br />
<code><br />
* [[gb.titleScreen]](''F("name")'', ''logo'')<br />
* [[gb.menu]](menu, length)<br />
* [[gb.keyboard]](string, length)<br />
* [[gb.popup]](F("text"), duration)<br />
* [[gb.getDefaultName]](string) //10 char<br />
</code><br />
Perfomance monitor :<br />
<code><br />
* [[gb.getCpuLoad]]()<br />
* [[gb.getFreeRam]]()<br />
* [[gb.frameDurationMicros]]<br />
</code><br />
<br />
== buttons ==<br />
<code><br />
* [[gb.buttons.pressed]](button)<br />
* [[gb.buttons.released]](button)<br />
* [[gb.buttons.held]](button, duration)<br />
* [[gb.buttons.repeat]](button, period)<br />
* [[gb.buttons.timeHeld]](button)<br />
buttons:<br />
<br />
BTN_A, BTN_B, BTN_C, BTN_UP, BTN_RIGHT, BTN_DOWN, BTN_LEFT<br />
</code><br />
<br />
== sound ==<br />
For an overall explanation of how the sound library works, see [[Sound]].<br />
<br />
Tracks<code><br />
* [[gb.sound.playTrack]](track, channel)<br />
* [[gb.sound.stopTrack]](''channel'')<br />
* [[gb.sound.changePatternSet]](patternSet, channel)<br />
</code>Pattern<code><br />
* [[gb.sound.playPattern]](sound, channel)<br />
* [[gb.sound.stopPattern]](''channel'')<br />
* [[gb.sound.setPatternLooping]](boolean, channel)<br />
* [[gb.sound.isPlaying]](channel)<br />
</code>Notes & commands<code><br />
* [[gb.sound.playNote]](pitch, duration, channel)<br />
* [[gb.sound.command]](command, X, Y, channel)<br />
* [[gb.sound.changeInstrumentSet]](instrumentSet, channel)<br />
</code><br />
<br />
Build-in sounds<br />
<code><br />
* [[gb.sound.playOK]]()<br />
* [[gb.sound.playCancel]]()<br />
* [[gb.sound.playTick]]()<br />
</code><br />
<br />
Misc<br />
<code><br />
* [[gb.sound.setVolume]](volume, ''channel'')<br />
* [[gb.sound.getVolume]](''channel'')<br />
* [[gb.sound.setInstruments]](instruments, channel)<br />
* [[gb.sound.prescaler]]<br />
</code><br />
<br />
== battery ==<br />
<code><br />
* [[gb.battery.voltage]]<br />
* [[gb.battery.level]]<br />
* [[gb.battery.show]] = true/false<br />
</code><br />
<br />
== backlight ==<br />
<code><br />
* [[gb.backlight.set]](brightness)<br />
* [[gb.backlight.automatic]] = true/false<br />
* [[gb.backlight.backlightValue]]<br />
* [[gb.backlight.ambientLight]]<br />
<br />
The following should be set using SETTINGS.HEX<br />
* [[gb.backlight.backlightMin]] = 0 to 255<br />
* [[gb.backlight.backlightMax]] = 0 to 255<br />
* [[gb.backlight.ambientLightMin]] = 0 to 1024<br />
* [[gb.backlight.ambientLightMax]] = 0 to 1024<br />
</code><br />
<br />
</div><div style="float:left;width:480px;margin-right:0;"><br />
<br />
== display ==<br />
General :<br />
<code><br />
* [[gb.display.clear]]()<br />
* [[gb.display.update]]()<br />
* [[gb.display.fillScreen]](color)<br />
* [[gb.display.setColor]](color, ''background'')<br />
* [[gb.display.persistence]] = true/false<br />
</code><br />
<br />
Pixels :<br />
<code><br />
* [[gb.display.drawPixel]](x, y)<br />
* [[gb.display.getPixel]](x, y)<br />
</code><br />
<br />
Lines :<br />
<code><br />
* [[gb.display.drawLine]](x0, y0, x1, y1)<br />
* [[gb.display.drawFastVLine]](x, y, h)<br />
* [[gb.display.drawFastHLine]](x, y, w)<br />
</code><br />
<br />
Rectangles :<br />
<code><br />
* [[gb.display.drawRect]](x, y, w, h)<br />
* [[gb.display.fillRect]](x, y, w, h)<br />
* [[gb.display.drawRoundRect]](x, y, w, h, r)<br />
* [[gb.display.fillRoundRect]](x, y, w, h, r)<br />
</code><br />
<br />
Circles :<br />
<code><br />
* [[gb.display.drawCircle]](x, y, r)<br />
* [[gb.display.fillCircle]](x, y, r)<br />
* [[gb.display.drawCircleHelper]](x, y, r, corner)<br />
* [[gb.display.fillCircleHelper]](x, y, r, corner)<br />
</code><br />
<br />
Triangles :<br />
<code><br />
* [[gb.display.drawTriangle]](x0,y0,x1,y1,x2,y2)<br />
* [[gb.display.fillTriangle]](x0,y0,x1,y1,x2,y2)<br />
</code><br />
<br />
Bitmaps :<br />
<code><br />
* [[gb.display.drawBitmap]](x,y,bitmap,''rotation'',''flip'')<br />
</code><br />
* rotation: <code>NOROT, ROTCCW, ROT180, ROTCW</code><br />
* flip: <code>NOFLIP, FLIPH, FLIPV, FLIPVH</code><br />
<br />
Text :<br />
<code><br />
* [[gb.display.print]](text or numbers)<br />
* [[gb.display.drawChar]](x, y, char, size)<br />
* [[gb.display.setFont]](font)<br />
* [[gb.display.cursorX]] = x<br />
* [[gb.display.cursorY]] = y<br />
* [[gb.display.fontSize]] = size<br />
* [[gb.display.textWrap]] = true/false<br />
</code><br />
Useful constants: <code>LCDWIDTH, LCDHEIGHT, gb.display.fontWidth, gb.display.fontHeight</code><br />
<br />
</div></div>
Tiash