Adaptor to Ogre3d.
More...
#include <rendering/rendering.hh>
Inherits SingletonT< RenderEngine >.
Adaptor to Ogre3d.
Provides the interface to load, initialize the rendering engine.
◆ RenderPathType
The type of rendering path used by the rendering engine.
Enumerator |
---|
NONE | No rendering is done.
|
VERTEX | Most basic rendering, with least fidelity.
|
FORWARD | Utilizes the RTT shader system.
|
DEFERRED | Utilizes deferred rendering. Best fidelity.
|
RENDER_PATH_COUNT | Count of the rendering path enums.
|
◆ AddResourcePath()
void AddResourcePath |
( |
const std::string & |
_uri | ) |
|
Add a new path for Ogre to search for resources.
- Parameters
-
[in] | _uri | URI of the path. The uri should be of the form file:// or model:// |
◆ CreateScene()
ScenePtr CreateScene |
( |
const std::string & |
_name, |
|
|
bool |
_enableVisualizations, |
|
|
bool |
_isServer = false |
|
) |
| |
Create a scene.
- Parameters
-
[in] | _name | The name of the scene. |
[in] | _enableVisualizations | True enables visualization elements such as laser lines. |
◆ Fini()
Tears down the rendering engine.
◆ FSAALevels()
std::vector<unsigned int> FSAALevels |
( |
| ) |
const |
Get a list of all supported FSAA levels for this render system.
- Returns
- a list of FSAA levels
◆ GetRenderPathType()
Get the type of rendering path to use.
This is automatically determined based on the computers capabilities
- Returns
- The RenderPathType
◆ GetScene() [1/2]
ScenePtr GetScene |
( |
const std::string & |
_name = "" | ) |
|
Get a scene by name.
- Parameters
-
[in] | _name | Name of the scene to retreive. |
- Returns
- A pointer to the Scene, or NULL if the scene doesn't exist.
◆ GetScene() [2/2]
ScenePtr GetScene |
( |
unsigned int |
_index | ) |
|
Get a scene by index.
The index should be between 0 and GetSceneCount().
- Parameters
-
[in] | _index | The index of the scene. |
- Returns
- A pointer to a Scene, or NULL if the index was invalid.
◆ GetWindowManager()
Get a pointer to the window manager.
- Returns
- Pointer to the window manager.
◆ Init()
Initialize Ogre. Load must happen before Init.
◆ Instance()
Get an instance of the singleton.
◆ Load()
Load the parameters for Ogre. Load must happen before Init.
◆ RemoveScene()
void RemoveScene |
( |
const std::string & |
_name | ) |
|
Remove a scene.
- Parameters
-
[in] | _name | The name of the scene to remove. |
◆ Root()
Ogre::Root* Root |
( |
| ) |
const |
Get a pointer to the Ogre root object.
- Returns
- Pointer to the Ogre root object.
◆ SceneCount()
unsigned int SceneCount |
( |
| ) |
const |
Get the number of scenes.
- Returns
- The number of scenes created by the RenderEngine.
◆ dummyContext
GLX context used to render the scenes.Used for gui-less operation.
◆ dummyDisplay
Pointer to the dummy display.Used for gui-less operation.
◆ dummyWindowId
ID for a dummy window. Used for gui-less operation.
The documentation for this class was generated from the following file: