Module systems_renderer
Queues and draws render tasks by screen, coordinate space, and layer.
Info:
- Author: Sharper Dev
Functions
| Renderer.registerRenderTask (task, screen, space) | Adds a render task to the given screen's task queue. |
| Renderer.unregisterRenderTask (task, screen, space) | Removes a render task from the given screen's task queue. |
| Renderer.drawTop () | Draws the top screen's world-space tasks, then screen-space tasks. |
| Renderer.drawBottom () | Draws the bottom screen's world-space tasks, then screen-space tasks. |
Local Functions
| sortTasks (screen, space) | Sorts one render queue by layer. |
| checkLayers (screen, space) | Resorts a queue when a task's layer has changed. |
Functions
- Renderer.registerRenderTask (task, screen, space)
-
Adds a render task to the given screen's task queue.
Parameters:
- task
table Render task with
layerandexecutefields. - screen
integer Screen constant (
TOP_SCREENorBOTTOM_SCREEN). - space
integer Coordinate space:
Renderer.SPACES.WORLDorRenderer.SPACES.SCREEN.
Usage:
Renderer.registerRenderTask(task, TOP_SCREEN, Renderer.SPACES.WORLD) - task
table Render task with
- Renderer.unregisterRenderTask (task, screen, space)
-
Removes a render task from the given screen's task queue.
Parameters:
- task table Render task to remove.
- screen
integer Screen constant (
TOP_SCREENorBOTTOM_SCREEN). - space
integer Coordinate space:
Renderer.SPACES.WORLDorRenderer.SPACES.SCREEN.
Usage:
Renderer.unregisterRenderTask(task, TOP_SCREEN, Renderer.SPACES.WORLD) - Renderer.drawTop ()
- Draws the top screen's world-space tasks, then screen-space tasks. The core runtime calls this function automatically.
- Renderer.drawBottom ()
- Draws the bottom screen's world-space tasks, then screen-space tasks. The core runtime calls this function automatically.
Local Functions
- sortTasks (screen, space)
-
Sorts one render queue by layer.
Parameters:
- screen integer Screen whose queue is sorted.
- space integer Render space whose queue is sorted.
- checkLayers (screen, space)
-
Resorts a queue when a task's layer has changed.
Parameters:
- screen integer Screen whose queue is checked.
- space integer Render space whose queue is checked.