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