File ../../LibScriptableImages-1.0/LibScriptableImagesAVSSuperScope-1.0/LibScriptableImagesAVSSuperScope-1.0.lua
Functions
LibAVSSuperScope:Del (lcd) | Delete a superscope object |
LibAVSSuperScope:GetOptions (db, callback, data) | Retreieve an Ace3 options table. |
LibAVSSuperScope:New (name, config, errorLevel) | Create a new superscope. |
LibAVSSuperScope:Render (visdata, isBeat, framebuffer, fbout, w, h) | Render a superscope |
Functions
- LibAVSSuperScope:Del (lcd)
-
Delete a superscope object
Parameters
- lcd: An optional lcd object
Usage:
LibScriptableAVSSuperScope:Del([lcd]) or object:Del()Return value:
Nothing - LibAVSSuperScope:GetOptions (db, callback, data)
-
Retreieve an Ace3 options table.
Parameters
- db: An options table.
- callback: This is optional. This function will be called when a field is set.
- data: Some data to pass back through the callback.
Return value:
An options table. Plugin this into an 'args' of a group section in your options table. - LibAVSSuperScope:New (name, config, errorLevel)
-
Create a new superscope.
Parameters
- name: A name for the buffer
- config: This object's parameters
- errorLevel: The verbocity level
Usage:
LibScriptableAVSSuperScope:New(name, size, defval, errorLevel)Return value:
A new LibScriptableAVSSuperScope object - LibAVSSuperScope:Render (visdata, isBeat, framebuffer, fbout, w, h)
-
Render a superscope
Parameters
- visdata: Some data. Should be in the range between 1 to -1
- isBeat: Whether it's a "beat" - AKA critical strike?
- framebuffer: The draw surface data.
- fbout: The out buffer.
- w: The width of the superscope
- h: The height of the superscope