![]() |
Public API Reference |
Render loop manager. More...
#include <iengine/renderloop.h>
Public Member Functions | |
| virtual csPtr< iRenderLoop > | Create ()=0 |
| Create a new render loop. | |
| virtual const char * | GetName (iRenderLoop *loop)=0 |
| Get the name asociated to the render loop. | |
| virtual csPtr< iRenderLoop > | Load (const char *fileName)=0 |
| Load a renderloop from VFS file. | |
| virtual bool | Register (const char *name, iRenderLoop *loop, bool checkDupes=false)=0 |
| Associate a name with a renderloop. | |
| virtual iRenderLoop * | Retrieve (const char *name)=0 |
| Get the render loop associated with the name. | |
| virtual bool | Unregister (iRenderLoop *loop)=0 |
| Remove an association between a name and a render loop. | |
| virtual void | UnregisterAll (bool evenDefault=false)=0 |
| Unregister all render loops. | |
Render loop manager.
Use to create new loops and manage loop names.
Main ways to get pointers to this interface:
Definition at line 81 of file renderloop.h.
| virtual csPtr<iRenderLoop> iRenderLoopManager::Create | ( | ) | [pure virtual] |
Create a new render loop.
| virtual const char* iRenderLoopManager::GetName | ( | iRenderLoop * | loop | ) | [pure virtual] |
Get the name asociated to the render loop.
| loop | Render loop which associated name is to be retrieved. |
| virtual csPtr<iRenderLoop> iRenderLoopManager::Load | ( | const char * | fileName | ) | [pure virtual] |
Load a renderloop from VFS file.
This file should be a renderloop XML file with <params> as the root.
| fileName | is the VFS path. |
| virtual bool iRenderLoopManager::Register | ( | const char * | name, |
| iRenderLoop * | loop, | ||
| bool | checkDupes = false |
||
| ) | [pure virtual] |
Associate a name with a renderloop.
One name is associated with one render loop. If you try to register a loop with a name that is already used, Register() will fail.
| name | Name the render loop is registered with. |
| loop | The render loop. |
| virtual iRenderLoop* iRenderLoopManager::Retrieve | ( | const char * | name | ) | [pure virtual] |
Get the render loop associated with the name.
| name | Name for which the renderloop is to be retrieved. |
| virtual bool iRenderLoopManager::Unregister | ( | iRenderLoop * | loop | ) | [pure virtual] |
Remove an association between a name and a render loop.
| loop | Render loop which associated name should be removed. |
| virtual void iRenderLoopManager::UnregisterAll | ( | bool | evenDefault = false | ) | [pure virtual] |
Unregister all render loops.
| evenDefault | Whether even the default render loop (identified by the name CS_DEFAULT_RENDERLOOP_NAME) should be unregistered. |