Update API

Scott Duensing 2022-07-09 23:17:41 +00:00
parent d35f5616df
commit cce66bfe6a

254
API.md

@ -1,121 +1,163 @@
The Singe API is broken into several categories: The Singe API is broken into several categories:
* Color <details><summary>Color</summary>
* colorBackground <ul>
* colorForeground <li>colorBackground</li>
<li>colorForeground</li>
</ul>
</details>
* Controller <details><summary>Controller</summary>
* controllerGetAxis <ul>
<li>controllerGetAxis</li>
</ul>
</details>
* Debug <details><summary>Debug</summary>
* debugPrint <ul>
<li>debugPrint</li>
</ul>
</details>
* Disc <details><summary>Disc</summary>
* discAudio <ul>
* discChangeSpeed <li>discAudio</li>
* discGetFrame <li>discChangeSpeed</li>
* discGetHeight <li>discGetFrame</li>
* discGetState <li>discGetHeight</li>
* discGetWidth <li>discGetState</li>
* discPause <li>discGetWidth</li>
* discPauseAtFrame <li>discPause</li>
* discPlay <li>discPauseAtFrame</li>
* discSearch <li>discPlay</li>
* discSearchBlanking <li>discSearch</li>
* discSetFPS <li>discSearchBlanking</li>
* discSkipBackward <li>discSetFPS</li>
* discSkipBlanking <li>discSkipBackward</li>
* discSkipForward <li>discSkipBlanking</li>
* discSkipToFrame <li>discSkipForward</li>
* discStepBackward <li>discSkipToFrame</li>
* discStepForward <li>discStepBackward</li>
* discStop <li>discStepForward</li>
<li>discStop</li>
</ul>
</details>
* Font <details><summary>Font</summary>
* fontLoad <ul>
* fontPrint <li>fontLoad</li>
* fontQuality <li>fontPrint</li>
* fontSelect <li>fontQuality</li>
* fontToSprite <li>fontSelect</li>
* fontUnload <li>fontToSprite</li>
<li>fontUnload</li>
</ul>
</details>
* Keyboard <details><summary>Keyboard</summary>
* keyboardGetMode <ul>
* keyboardSetMode <li>keyboardGetMode</li>
<li>keyboardSetMode</li>
</ul>
</details>
* Mouse <details><summary>Mouse</summary>
* mouseEnable <ul>
* mouseDisable <li>mouseEnable</li>
* mouseGetPosition <li>mouseDisable</li>
* mouseHowMany <li>mouseGetPosition</li>
* mouseSetCaptured <li>mouseHowMany</li>
* mouseSetMode <li>mouseSetCaptured</li>
<li>mouseSetMode</li>
</ul>
</details>
* Overlay <details><summary>Overlay</summary>
* overlayBox <ul>
* overlayCircle <li>overlayBox</li>
* overlayClear <li>overlayCircle</li>
* overlayEllipse <li>overlayClear</li>
* overlayGetHeight <li>overlayEllipse</li>
* overlayGetWidth <li>overlayGetHeight</li>
* overlayLine <li>overlayGetWidth</li>
* overlayPlot <li>overlayLine</li>
* overlayPrint <li>overlayPlot</li>
* overlaySetResolution <li>overlayPrint</li>
<li>overlaySetResolution</li>
</ul>
</details>
* Script <details><summary>Script</summary>
* scriptExecute <ul>
* scriptPush <li>scriptExecute</li>
<li>scriptPush</li>
</ul>
</details>
* Singe <details><summary>Singe</summary>
* singeDisablePauseKey <ul>
* singeEnablePauseKey <li>singeDisablePauseKey</li>
* singeGetDataPath <li>singeEnablePauseKey</li>
* singeGetScriptPath <li>singeGetDataPath</li>
* singeGetWidth <li>singeGetScriptPath</li>
* singeScreenshot <li>singeGetWidth</li>
* singeSetGameName <li>singeScreenshot</li>
* singeSetPauseFlag <li>singeSetGameName</li>
* singeQuit <li>singeSetPauseFlag</li>
* singeVersion <li>singeQuit</li>
* singeWantsCrosshairs <li>singeVersion</li>
<li>singeWantsCrosshairs</li>
</ul>
</details>
* Sound <details><summary>Sound</summary>
* soundFullStop <ul>
* soundGetVolume <li>soundFullStop</li>
* soundIsPlaying <li>soundGetVolume</li>
* soundLoad <li>soundIsPlaying</li>
* soundPause <li>soundLoad</li>
* soundPlay <li>soundPause</li>
* soundResume <li>soundPlay</li>
* soundSetVolume <li>soundResume</li>
* soundStop <li>soundSetVolume</li>
* soundUnload <li>soundStop</li>
<li>soundUnload</li>
</ul>
</details>
* Sprite <details><summary>Sprite</summary>
* spriteDraw <ul>
* spriteGetHeight <li>spriteDraw</li>
* spriteGetWidth <li>spriteGetHeight</li>
* spriteLoad <li>spriteGetWidth</li>
* spriteUnload <li>spriteLoad</li>
<li>spriteUnload</li>
</ul>
</details>
* Video <details><summary>Video</summary>
* videoDraw <ul>
* videoGetFrame <li>videoDraw</li>
* videoGetFrameCount <li>videoGetFrame</li>
* videoGetHeight <li>videoGetFrameCount</li>
* videoGetVolume <li>videoGetHeight</li>
* videoGetWidth <li>videoGetVolume</li>
* videoIsPlaying <li>videoGetWidth</li>
* videoLoad <li>videoIsPlaying</li>
* videoPause <li>videoLoad</li>
* videoPlay <li>videoPause</li>
* videoSeek <li>videoPlay</li>
* videoSetVolume <li>videoSeek</li>
* videoUnload <li>videoSetVolume</li>
<li>videoUnload</li>
</ul>
</details>
* VLDP <details><summary>VLDP</summary>
* vldpGetHeight <ul>
* vldpGetPixel <li>vldpGetHeight</li>
* vldpGetWidth <li>vldpGetPixel</li>
* vldpSetVerbose <li>vldpGetWidth</li>
<li>vldpSetVerbose</li>
</ul>
</details>