Namespace sandboxe.display
Defined in: docbase.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Display management utilities and functions.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
sandboxe.display.create(name, width, height)
Creates a new display object.
|
| <static> |
sandboxe.display.destroy(display)
Destroys a display object.
|
| <static> |
sandboxe.display.getMain()
Returns the current main display for sandboxe in use, if any.
|
| <static> |
sandboxe.display.setMain(display)
Tells sandboxe which display to update and draw to.
|
Method Detail
<static>
{display}
sandboxe.display.create(name, width, height)
Creates a new display object. See display.
- Parameters:
- {String} name
- Optional: A name for the display. The default is "sandboxe"
- {Number} width
- Optional: Width for the display. The default is 640
- {Number} height
- Optional: Height for the display. The default is 480
- Returns:
- {display}
<static>
sandboxe.display.destroy(display)
Destroys a display object.
- Parameters:
- {display} display
- Display to remove from the system.
<static>
{display}
sandboxe.display.getMain()
Returns the current main display for sandboxe in use, if any.
- Returns:
- {display}
<static>
sandboxe.display.setMain(display)
Tells sandboxe which display to update and draw to. Once set as a main display,
this display will receive all update requests from the renderer. In addition,
sandboxe will use this display as the source of input from the user on systems
where input comes form the display (i.e. WINAPI or X11).
- Parameters:
- {display} display
- Display to set as the main.