Docs: Added getScreenBuffer/setScreenBuffer to Lua reference
This commit is contained in:
Sour
parent
d318bae66d
commit
e2d753fbe6
4 changed files with 48 additions and 3 deletions
|
|
@ -5,10 +5,21 @@ pre: ""
|
|||
chapter: false
|
||||
---
|
||||
|
||||
## Changes between 0.9.4 and 0.9.5 ##
|
||||
|
||||
### New features ###
|
||||
|
||||
* New functions:
|
||||
|
||||
* **<kbd>[getScreenBuffer](/apireference/drawing.html#getscreenbuffer)</kbd>**
|
||||
* **<kbd>[setScreenBuffer](/apireference/drawing.html#setscreenbuffer)</kbd>**
|
||||
|
||||
## Changes between 0.9.3 and 0.9.4 ##
|
||||
|
||||
### New features ###
|
||||
|
||||
* New functions:
|
||||
|
||||
* **<kbd>[getLogWindowLog](/apireference/misc.html#getlogwindowlog)</kbd>**
|
||||
* **<kbd>[getRomInfo](/apireference/misc.html#getrominfo)</kbd>**
|
||||
* **<kbd>[getScriptDataFolder](/apireference/misc.html#getscriptdatafolder)</kbd>**
|
||||
|
|
|
|||
|
|
@ -133,3 +133,32 @@ y - *Integer* Y position
|
|||
**Description**
|
||||
Returns the color (in ARGB format) of the PPU's output for the specified location.
|
||||
|
||||
|
||||
## getScreenBuffer ##
|
||||
|
||||
**Syntax**
|
||||
|
||||
emu.getScreenBuffer()
|
||||
|
||||
**Return value**
|
||||
*Array* 32-bit integers in ARGB format
|
||||
|
||||
**Description**
|
||||
Returns an array of ARGB values for the entire screen (256px by 240px) - can be used with [emu.setScreenBuffer()](#setscreenbuffer) to alter the frame.
|
||||
|
||||
|
||||
## setScreenBuffer ##
|
||||
|
||||
**Syntax**
|
||||
|
||||
emu.setScreenBuffer(screenBuffer)
|
||||
|
||||
**Parameters**
|
||||
screenBuffer - *Array* An array of 32-bit integers in ARGB format
|
||||
|
||||
**Return value**
|
||||
*None*
|
||||
|
||||
**Description**
|
||||
Replaces the current frame with the contents of the specified array.
|
||||
|
||||
|
|
|
|||
|
|
@ -109,8 +109,10 @@ Available shortcuts:
|
|||
* **Load State**: Load the game's state from the currently selected slot.
|
||||
* **Save State - Slot X**: Save the game's state to the matching slot.
|
||||
* **Load State - Slot X**: Load the game's state from the matching slot.
|
||||
* **Load State - Auto Save Slot**: Load the game's state from the auto save slot.
|
||||
* **Save State to File**: Save the game's state to a user-specified file.
|
||||
* **Load State from File**: Load the game's state from a user-specified file.
|
||||
* **Load Last Session**: Restores the game to the state it was the last time you stopped playing it.
|
||||
|
||||
## Folders and File Associations ##
|
||||
|
||||
|
|
|
|||
|
|
@ -481,15 +481,18 @@ namespace Mesen.GUI.Debugger
|
|||
new List<string> {"func","emu.resume","emu.resume()","","","Resumes execution after breaking."},
|
||||
new List<string> {"func","emu.rewind","emu.rewind(seconds)","seconds - *Integer* The number of seconds to rewind","","Instantly rewinds the emulation by the number of seconds specified.\n Note: this can only be called from within a 'StartFrame' event callback."},
|
||||
|
||||
new List<string> {"func","emu.getScreenBuffer","emu.getScreenBuffer()","", "*Array* 32-bit integers in ARGB format", "Returns an array of ARGB values for the entire screen (256px by 240px) - can be used with emu.setScreenBuffer() to alter the frame."},
|
||||
new List<string> {"func","emu.setScreenBuffer","emu.setScreenBuffer(screenBuffer)", "screenBuffer - *Array* An array of 32-bit integers in ARGB format", "","Replaces the current frame with the contents of the specified array."},
|
||||
|
||||
new List<string> {"func","emu.saveSavestate","emu.saveSavestate()","","*String* A string containing a binary blob representing the emulation's current state.","Creates a savestate and returns it as a binary string. (The savestate is not saved on disk)\n Note: this can only be called from within a “startFrame” event callback or “cpuExec” memory callback."},
|
||||
new List<string> {"func","emu.loadSavestate","emu.loadSavestate(savestate)","savestate - *String* A binary blob representing a savestate, as returned by saveSavestate()","","Loads the specified savestate.\nNote: this can only be called from within a “startFrame” event callback or “cpuExec” memory callback."},
|
||||
new List<string> {"func","emu.saveSavestateAsync","emu.saveSavestateAsync()","slotNumber - *Integer* A slot number to which the savestate data will be stored (slotNumber must be >= 0)","","Queues a save savestate request. As soon at the emulator is able to process the request, it will be saved into the specified slot.\nThis API is asynchronous because save states can only be taken in-between 2 CPU instructions, not in the middle of an instruction. When called while the CPU is in-between 2 instructions (e.g: inside the callback of an cpuExec or startFrame event), the save state will be taken immediately and its data will be available via getSavestateData right after the call to saveSavestateAsync.\nThe savestate can be loaded by calling the loadSavestateAsync function."},
|
||||
new List<string> {"func","emu.loadSavestateAsync","emu.loadSavestateAsync()","slotNumber - *Integer* The slot number to load the savestate data from (must be a slot number that was used in a preceding saveSavestateAsync call)","*Boolean* Returns true if the slot number was valid.","Queues a load savestate request. As soon at the emulator is able to process the request, the savestate will be loaded from the specified slot.\nThis API is asynchronous because save states can only be loaded in-between 2 CPU instructions, not in the middle of an instruction. When called while the CPU is in-between 2 instructions (e.g: inside the callback of an cpuExec or startFrame event), the savestate will be loaded immediately."},
|
||||
new List<string> {"func","emu.saveSavestateAsync","emu.saveSavestateAsync()","slotNumber - *Integer* A slot number to which the savestate data will be stored (slotNumber must be >= 0)","","Queues a save savestate request. As soon at the emulator is able to process the request, it will be saved into the specified slot.\nThis API is asynchronous because save states can only be taken in-between 2 CPU instructions, not in the middle of an instruction.\nWhen called while the CPU is in-between 2 instructions (e.g: inside the callback of an cpuExec or startFrame event),\nthe save state will be taken immediately and its data will be available via getSavestateData right after the call to saveSavestateAsync.\nThe savestate can be loaded by calling the loadSavestateAsync function."},
|
||||
new List<string> {"func","emu.loadSavestateAsync","emu.loadSavestateAsync()","slotNumber - *Integer* The slot number to load the savestate data from (must be a slot number that was used in a preceding saveSavestateAsync call)","*Boolean* Returns true if the slot number was valid.","Queues a load savestate request. As soon at the emulator is able to process the request, the savestate will be loaded from the specified slot.\nThis API is asynchronous because save states can only be loaded in-between 2 CPU instructions, not in the middle of an instruction.\nWhen called while the CPU is in-between 2 instructions (e.g: inside the callback of an cpuExec or startFrame event), the savestate will be loaded immediately."},
|
||||
new List<string> {"func","emu.getSavestateData","emu.getSavestateData()","slotNumber - *Integer* The slot number to get the savestate data from (must be a slot number that was used in a preceding saveSavestateAsync call)","*String* A binary string containing the savestate","Returns the savestate stored in the specified savestate slot."},
|
||||
new List<string> {"func","emu.clearSavestateData","emu.clearSavestateData()","slotNumber - *Integer* The slot number to get the savestate data from (must be a slot number that was used in a preceding saveSavestateAsync call)","","Clears the specified savestate slot (any savestate data in that slot will be removed from memory)."},
|
||||
|
||||
new List<string> {"func","emu.getInput","emu.getInput(port)","port - *Integer* The port number to read (0 to 3)","*Table* A table containing the status of all 8 buttons.","Returns a table containing the status of all 8 buttons: { a, b, select, start, up, down, left, right }"},
|
||||
new List<string> {"func","emu.setInput","emu.setInput(port, input)","port - *Integer* The port number to apply the input to (0 to 3)\ninput - *Table* A table containing the state of some (or all) of the 8 buttons (same format as returned by getInput)","","Buttons enabled or disabled via setInput will keep their state until the next inputPolled event.\nIf a button’s value is not specified to either true or false in the input argument, then the player retains control of that button. For example, setInput(0, { select = false, start = false}) will prevent the player 1 from using both the start and select buttons, but all other buttons will still work as normal.To properly control the emulation, it is recommended to use this function within a callback for the inputPolled event. Otherwise, the inputs may not be applied before the ROM has the chance to read them."},
|
||||
new List<string> {"func","emu.setInput","emu.setInput(port, input)","port - *Integer* The port number to apply the input to (0 to 3)\ninput - *Table* A table containing the state of some (or all) of the 8 buttons (same format as returned by getInput)","","Buttons enabled or disabled via setInput will keep their state until the next inputPolled event.\nIf a button’s value is not specified to either true or false in the input argument, then the player retains control of that button.\nFor example, setInput(0, { select = false, start = false}) will prevent the player 1 from using both the start and select buttons,\nbut all other buttons will still work as normal.To properly control the emulation, it is recommended to use this function\nwithin a callback for the inputPolled event.\nOtherwise, the inputs may not be applied before the ROM has the chance to read them."},
|
||||
new List<string> {"func","emu.getMouseState","emu.getMouseState()","","*Table* The mouse's state","Returns a table containing the position and the state of all 3 buttons: { x, y, left, middle, right }"},
|
||||
new List<string> {"func","emu.isKeyPressed","emu.isKeyPressed(keyName)","keyName - *String* The name of the key to check","*Boolean* The key’s state (true = pressed)","Returns whether or not a specific key is pressed. The “keyName” must be the same as the string shown in the UI when the key is bound to a button."},
|
||||
new List<string> {"func","emu.addCheat","emu.addCheat(cheatCode)","cheatCode - *String* A game genie format cheat code.","","Activates a game genie cheat code (6 or 8 characters).\nNote: cheat codes added via this function are not permanent and not visible in the UI."},
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue