OGRE-Next
3.0.0
Object-Oriented Graphics Rendering Engine
|
The root class of the Ogre system. More...
#include <OgreRoot.h>
Public Types | |
typedef ConstMapIterator< MovableObjectFactoryMap > | MovableObjectFactoryIterator |
typedef vector< Plugin * >::type | PluginInstanceList |
typedef vector< DynLib * >::type | PluginLibList |
Public Member Functions | |
Root (const AbiCookie *abiCookie=0, const String &pluginFileName="plugins" OGRE_BUILD_SUFFIX ".cfg", const String &configFileName="ogre.cfg", const String &logFileName="Ogre.log", const String &appName="") | |
Constructor. More... | |
~Root () | |
bool | _fireFrameEnded () |
Method for raising frame ended events. More... | |
bool | _fireFrameEnded (FrameEvent &evt) |
Method for raising frame ended events. More... | |
bool | _fireFrameRenderingQueued () |
Method for raising frame rendering queued events. More... | |
bool | _fireFrameRenderingQueued (FrameEvent &evt) |
Method for raising frame rendering queued events. More... | |
bool | _fireFrameStarted () |
Method for raising frame started events. More... | |
bool | _fireFrameStarted (FrameEvent &evt) |
Method for raising frame started events. More... | |
SceneManager * | _getCurrentSceneManager () const |
Returns the scene manager currently being used to render a frame. More... | |
void | _notifyRenderingFrameStarted () |
void | _popCurrentSceneManager (SceneManager *sm) |
Pops the scene manager currently being used to render. More... | |
void | _pushCurrentSceneManager (SceneManager *sm) |
Pushes the scene manager currently being used to render. More... | |
void | _renderingFrameEnded () |
void | _setLightProfilesInvHeight (float invHeight) |
bool | _updateAllRenderTargets () |
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update. More... | |
bool | _updateAllRenderTargets (FrameEvent &evt) |
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update, with a custom time passed to the frameRenderingQueued events. More... | |
void | addFrameListener (FrameListener *newListener) |
Registers a FrameListener which will be called back every frame. More... | |
void | addMovableObjectFactory (MovableObjectFactory *fact, bool overrideExisting=false) |
Register a new MovableObjectFactory which will create new MovableObject instances of a particular type, as identified by the getType() method. More... | |
void | addRenderSystem (RenderSystem *newRend) |
Adds a new rendering subsystem to the list of available renderers. More... | |
void | addResourceLocation (const String &name, const String &locType, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, bool recursive=false) |
Adds a location to the list of searchable locations for a Resource type. More... | |
void | addSceneManagerFactory (SceneManagerFactory *fact) |
Register a new SceneManagerFactory, a factory object for creating instances of specific SceneManagers. More... | |
void | clearEventTimes () |
Clears the history of all event times. More... | |
void | convertColourValue (const ColourValue &colour, uint32 *pDest) |
Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem. More... | |
DataStreamPtr | createFileStream (const String &filename, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, bool overwrite=false, const String &locationPattern=BLANKSTRING) |
Helper method to assist you in creating writeable file streams. More... | |
Window * | createRenderWindow (const String &name, uint32 width, uint32 height, bool fullScreen, const NameValuePairList *miscParams=0) |
Creates a new rendering window. More... | |
bool | createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, WindowList &createdWindows) |
Creates multiple rendering windows. More... | |
SceneManager * | createSceneManager (const String &typeName, size_t numWorkerThreads, const String &instanceName=BLANKSTRING) |
Create a SceneManager instance of a given type. More... | |
SceneManager * | createSceneManager (SceneTypeMask typeMask, size_t numWorkerThreads, const String &instanceName=BLANKSTRING) |
Create a SceneManager instance based on scene type support. More... | |
void | destroySceneManager (SceneManager *sm) |
Destroy an instance of a SceneManager. More... | |
bool | endRenderingQueued () |
Check for planned end of rendering. More... | |
const String & | getAppName () const |
Window * | getAutoCreatedWindow () |
Retrieves a pointer to the window that was created automatically. More... | |
const RenderSystemList & | getAvailableRenderers () |
Retrieve a list of the available render systems. More... | |
CompositorManager2 * | getCompositorManager2 () const |
Real | getDefaultMinPixelSize () |
Get the default minimum pixel size for object to be rendered by. More... | |
unsigned int | getDisplayMonitorCount () const |
Gets the number of display monitors. More... | |
String | getErrorDescription (long errorNumber) |
Utility function for getting a better description of an error code. More... | |
Real | getFrameSmoothingPeriod () const |
Gets the period over which OGRE smooths out fluctuations in frame times. More... | |
const FrameStats * | getFrameStats () const |
HlmsManager * | getHlmsManager () const |
Gets the HlmsManager, which is needed to register generators at startup. More... | |
const PluginInstanceList & | getInstalledPlugins () const |
Gets a read-only list of the currently installed plugins. More... | |
float | getLightProfilesInvHeight () const |
v1::MeshManager * | getMeshManagerV1 () |
Retrieves a reference to the current MeshManager. More... | |
MovableObjectFactory * | getMovableObjectFactory (const String &typeName) |
Get a MovableObjectFactory for the given type. More... | |
MovableObjectFactoryIterator | getMovableObjectFactoryIterator () const |
Return an iterator over all the MovableObjectFactory instances currently registered. More... | |
unsigned long | getNextFrameNumber () const |
Gets the number of the next frame to be rendered. More... | |
bool | getRemoveRenderQueueStructuresOnClear () const |
Get whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared. More... | |
RenderSystem * | getRenderSystem () |
Retrieve a pointer to the currently selected render system. More... | |
RenderSystem * | getRenderSystemByName (const String &name) |
Retrieve a pointer to the render system by the given name. More... | |
SceneManager * | getSceneManager (const String &instanceName) const |
Get an existing SceneManager instance that has already been created, identified by the instance name. More... | |
SceneManagerEnumerator::SceneManagerIterator | getSceneManagerIterator () |
Get an iterator over all the existing SceneManager instances. More... | |
const SceneManagerMetaData * | getSceneManagerMetaData (const String &typeName) const |
Get more information about a given type of SceneManager. More... | |
SceneManagerEnumerator::MetaDataIterator | getSceneManagerMetaDataIterator () const |
Iterate over all types of SceneManager available for construction, providing some information about each one. More... | |
Timer * | getTimer () |
Gets a pointer to the central timer used for all OGRE timings. More... | |
WorkQueue * | getWorkQueue () const |
Get the WorkQueue for processing background tasks. More... | |
bool | hasMovableObjectFactory (const String &typeName) const |
Checks whether a factory is registered for a given MovableObject type. More... | |
bool | hasSceneManager (const String &instanceName) const |
Determines if a given SceneManager already exists. More... | |
Window * | initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window", const String &customCapabilitiesConfig=BLANKSTRING) |
Initialises the renderer. More... | |
void | installPlugin (Plugin *plugin, const NameValuePairList *options) |
Install a new plugin. More... | |
bool | isBlendIndicesGpuRedundant () const |
Returns whether blend indices information needs to be passed to the GPU see setBlendIndicesGpuRedundant() for more information. More... | |
bool | isBlendWeightsGpuRedundant () const |
Returns whether blend weights information needs to be passed to the GPU see setBlendWeightsGpuRedundant() for more information. More... | |
bool | isInitialised () const |
Returns whether the system is initialised or not. More... | |
void | loadPlugin (const String &pluginName, const bool bOptional, const NameValuePairList *options) |
Manually load a Plugin contained in a DLL / DSO. More... | |
DataStreamPtr | openFileStream (const String &filename, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, const String &locationPattern=BLANKSTRING) |
Helper method to assist you in accessing readable file streams. More... | |
void | queueEndRendering (bool state=true) |
Queues the end of rendering. More... | |
void | removeFrameListener (FrameListener *oldListener) |
Removes a FrameListener from the list of listening classes. More... | |
void | removeMovableObjectFactory (MovableObjectFactory *fact) |
Removes a previously registered MovableObjectFactory. More... | |
void | removeResourceLocation (const String &name, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) |
Removes a resource location from the list. More... | |
void | removeSceneManagerFactory (SceneManagerFactory *fact) |
Unregister a SceneManagerFactory. More... | |
bool | renderOneFrame () |
Render one frame. More... | |
bool | renderOneFrame (Real timeSinceLastFrame) |
Render one frame, with custom frame time information. More... | |
bool | restoreConfig () |
Checks for saved video/sound/etc settings. More... | |
void | saveConfig () |
Saves the details of the current configuration. More... | |
void | setBlendIndicesGpuRedundant (bool redundant) |
Sets whether blend indices information needs to be passed to the GPU. More... | |
void | setBlendWeightsGpuRedundant (bool redundant) |
Sets whether blend weights information needs to be passed to the GPU. More... | |
void | setDefaultMinPixelSize (Real pixelSize) |
Set the default minimum pixel size for object to be rendered by. More... | |
void | setFrameSmoothingPeriod (Real period) |
Sets the period over which OGRE smooths out fluctuations in frame times. More... | |
void | setRemoveRenderQueueStructuresOnClear (bool r) |
Set whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared. More... | |
void | setRenderSystem (RenderSystem *system) |
Sets the rendering subsystem to be used. More... | |
void | setWorkQueue (WorkQueue *queue) |
Replace the current work queue with an alternative. More... | |
bool | showConfigDialog (ConfigDialog *aCustomDialog=0) |
Displays a dialog asking the user to choose system settings. More... | |
void | shutdown () |
Shuts down the system manually. More... | |
void | startRendering () |
Starts / restarts the automatic rendering cycle. More... | |
void | uninstallPlugin (Plugin *plugin) |
Uninstall an existing plugin. More... | |
void | unloadPlugin (const String &pluginName) |
Manually unloads a Plugin contained in a DLL / DSO. More... | |
void | useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities) |
Requests active RenderSystem to use custom RenderSystemCapabilities. More... | |
Public Member Functions inherited from Ogre::Singleton< Root > | |
Singleton () | |
~Singleton () | |
Static Public Member Functions | |
static Root & | getSingleton () |
Override standard Singleton retrieval. More... | |
static Root * | getSingletonPtr () |
Override standard Singleton retrieval. More... | |
Static Public Member Functions inherited from Ogre::Singleton< Root > | |
static Root & | getSingleton () |
static Root * | getSingletonPtr () |
The root class of the Ogre system.
typedef ConstMapIterator<MovableObjectFactoryMap> Ogre::Root::MovableObjectFactoryIterator |
typedef vector<Plugin *>::type Ogre::Root::PluginInstanceList |
typedef vector<DynLib *>::type Ogre::Root::PluginLibList |
Ogre::Root::Root | ( | const AbiCookie * | abiCookie = 0 , |
const String & | pluginFileName = "plugins" OGRE_BUILD_SUFFIX ".cfg" , |
||
const String & | configFileName = "ogre.cfg" , |
||
const String & | logFileName = "Ogre.log" , |
||
const String & | appName = "" |
||
) |
Constructor.
abiCookie | ABI Cookie for catching ABI mismatches (highly recommended!) Can be nullptr to skip ABI check. See generateAbiCookie See testAbiCookie |
pluginFileName | The file that contains plugins information. Defaults to "plugins.cfg" in release build and to "plugins_d.cfg" in debug build. May be left blank to ignore. |
configFileName | The file that contains the configuration to be loaded. Defaults to "ogre.cfg", may be left blank to load nothing. |
logFileName | The logfile to create, defaults to Ogre.log, may be left blank if you've already set up LogManager & Log yourself |
appName | Name for this app. Use this string so driver vendors can create custom driver profiles (e.g. through NVIDIA's or AMD's control panel) |
Ogre::Root::~Root | ( | ) |
bool Ogre::Root::_fireFrameEnded | ( | ) |
Method for raising frame ended events.
bool Ogre::Root::_fireFrameEnded | ( | FrameEvent & | evt | ) |
Method for raising frame ended events.
evt | Event object which includes all the timing information which you have calculated for yourself |
bool Ogre::Root::_fireFrameRenderingQueued | ( | ) |
Method for raising frame rendering queued events.
bool Ogre::Root::_fireFrameRenderingQueued | ( | FrameEvent & | evt | ) |
Method for raising frame rendering queued events.
bool Ogre::Root::_fireFrameStarted | ( | ) |
Method for raising frame started events.
bool Ogre::Root::_fireFrameStarted | ( | FrameEvent & | evt | ) |
Method for raising frame started events.
evt | Event object which includes all the timing information which you have calculated for yourself |
SceneManager* Ogre::Root::_getCurrentSceneManager | ( | ) | const |
Returns the scene manager currently being used to render a frame.
void Ogre::Root::_notifyRenderingFrameStarted | ( | ) |
void Ogre::Root::_popCurrentSceneManager | ( | SceneManager * | sm | ) |
Pops the scene manager currently being used to render.
void Ogre::Root::_pushCurrentSceneManager | ( | SceneManager * | sm | ) |
Pushes the scene manager currently being used to render.
void Ogre::Root::_renderingFrameEnded | ( | ) |
|
inline |
bool Ogre::Root::_updateAllRenderTargets | ( | ) |
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update.
bool Ogre::Root::_updateAllRenderTargets | ( | FrameEvent & | evt | ) |
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update, with a custom time passed to the frameRenderingQueued events.
void Ogre::Root::addFrameListener | ( | FrameListener * | newListener | ) |
Registers a FrameListener which will be called back every frame.
void Ogre::Root::addMovableObjectFactory | ( | MovableObjectFactory * | fact, |
bool | overrideExisting = false |
||
) |
Register a new MovableObjectFactory which will create new MovableObject instances of a particular type, as identified by the getType() method.
fact | Pointer to the factory instance |
overrideExisting | Set this to true to override any existing factories which are registered for the same type. You should only change this if you are very sure you know what you're doing. |
void Ogre::Root::addRenderSystem | ( | RenderSystem * | newRend | ) |
Adds a new rendering subsystem to the list of available renderers.
void Ogre::Root::addResourceLocation | ( | const String & | name, |
const String & | locType, | ||
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME , |
||
bool | recursive = false |
||
) |
Adds a location to the list of searchable locations for a Resource type.
name | The name of the location, e.g. './data' or '/compressed/gamedata.zip' |
locType | A string identifying the location type, e.g. 'FileSystem' (for folders), 'Zip' etc. Must map to a registered plugin which deals with this type (FileSystem and Zip should always be available) |
groupName | Type of name of the resource group which this location should apply to; defaults to the General group which applies to all non-specific resources. |
recursive | If the resource location has a concept of recursive directory traversal, enabling this option will mean you can load resources in subdirectories using only their unqualified name. The default is to disable this so that resources in subdirectories with the same name are still unique. |
void Ogre::Root::addSceneManagerFactory | ( | SceneManagerFactory * | fact | ) |
Register a new SceneManagerFactory, a factory object for creating instances of specific SceneManagers.
void Ogre::Root::clearEventTimes | ( | ) |
Clears the history of all event times.
void Ogre::Root::convertColourValue | ( | const ColourValue & | colour, |
uint32 * | pDest | ||
) |
Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem.
colour | The colour to convert |
pDest | Pointer to location to put the result. |
DataStreamPtr Ogre::Root::createFileStream | ( | const String & | filename, |
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME , |
||
bool | overwrite = false , |
||
const String & | locationPattern = BLANKSTRING |
||
) |
Helper method to assist you in creating writeable file streams.
filename | The name of the file to create. If it includes path separators, the filesystem will be accessed direct. If no path separators are present the resource system is used, falling back on the raw filesystem after. |
groupName | The name of the group in which to create the file, if the resource system is used |
overwrite | If true, an existing file will be overwritten, if false an error will occur if the file already exists |
locationPattern | If the resource group contains multiple locations, then usually the file will be created in the first writable location. If you want to be more specific, you can include a location pattern here and only locations which match that pattern (as determined by StringUtil::match) will be considered candidates for creation. |
Window* Ogre::Root::createRenderWindow | ( | const String & | name, |
uint32 | width, | ||
uint32 | height, | ||
bool | fullScreen, | ||
const NameValuePairList * | miscParams = 0 |
||
) |
Creates a new rendering window.
name | The name of the window. Used in other methods later like setRenderTarget and getRenderTarget. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
width | The width of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
height | The height of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fullScreen | Specify true to make the window full screen without borders, title bar or menu bar. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
miscParams | A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:
|
bool Ogre::Root::createRenderWindows | ( | const RenderWindowDescriptionList & | renderWindowDescriptions, |
WindowList & | createdWindows | ||
) |
Creates multiple rendering windows.
renderWindowDescriptions | Array of structures containing the descriptions of each render window. The structure's members are the same as the parameters of _createRenderWindow:
|
createdWindows | This array will hold the created render windows. |
SceneManager* Ogre::Root::createSceneManager | ( | const String & | typeName, |
size_t | numWorkerThreads, | ||
const String & | instanceName = BLANKSTRING |
||
) |
Create a SceneManager instance of a given type.
typeName | String identifying a unique SceneManager type |
instanceName | Optional name to given the new instance that is created. If you leave this blank, an auto name will be assigned. |
numWorkerThreads | Number of worker threads. You should not oversubscribe the system. I.e. if the system has 4 cores and you intend to run your logic 100% in one of the cores, set this value to 3. If you intend to fully use 2 cores for your own stuff, set this value to 2. |
A value of 0 means there will be no worker threads, and all tasks will run in the main thread. Use this value on platforms that do not support it (i.e. Emscripten) or to troubleshoot very specific issues (e.g. some Debuggers don't work correctly when threads are involved)
SceneManager* Ogre::Root::createSceneManager | ( | SceneTypeMask | typeMask, |
size_t | numWorkerThreads, | ||
const String & | instanceName = BLANKSTRING |
||
) |
Create a SceneManager instance based on scene type support.
typeMask | A mask containing one or more SceneType flags |
instanceName | Optional name to given the new instance that is created. If you leave this blank, an auto name will be assigned. |
numWorkerThreads | Number of worker threads. Must be greater than 0; you should not oversubscribe the system. I.e. if the system has 4 cores and you intend to run your logic 100% in one of the cores, set this value to 3. If you intend to fully use 2 cores for your own stuff, set this value to 2. |
void Ogre::Root::destroySceneManager | ( | SceneManager * | sm | ) |
Destroy an instance of a SceneManager.
bool Ogre::Root::endRenderingQueued | ( | ) |
Check for planned end of rendering.
|
inline |
Window* Ogre::Root::getAutoCreatedWindow | ( | ) |
const RenderSystemList& Ogre::Root::getAvailableRenderers | ( | ) |
Retrieve a list of the available render systems.
|
inline |
|
inline |
Get the default minimum pixel size for object to be rendered by.
unsigned int Ogre::Root::getDisplayMonitorCount | ( | ) | const |
Gets the number of display monitors.
String Ogre::Root::getErrorDescription | ( | long | errorNumber | ) |
Utility function for getting a better description of an error code.
|
inline |
Gets the period over which OGRE smooths out fluctuations in frame times.
|
inline |
|
inline |
Gets the HlmsManager, which is needed to register generators at startup.
|
inline |
Gets a read-only list of the currently installed plugins.
|
inline |
v1::MeshManager* Ogre::Root::getMeshManagerV1 | ( | ) |
Retrieves a reference to the current MeshManager.
MovableObjectFactory* Ogre::Root::getMovableObjectFactory | ( | const String & | typeName | ) |
Get a MovableObjectFactory for the given type.
MovableObjectFactoryIterator Ogre::Root::getMovableObjectFactoryIterator | ( | ) | const |
Return an iterator over all the MovableObjectFactory instances currently registered.
|
inline |
Gets the number of the next frame to be rendered.
|
inline |
Get whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared.
RenderSystem* Ogre::Root::getRenderSystem | ( | ) |
Retrieve a pointer to the currently selected render system.
Referenced by Ogre::CompositorPassSceneDef::CompositorPassSceneDef().
RenderSystem* Ogre::Root::getRenderSystemByName | ( | const String & | name | ) |
Retrieve a pointer to the render system by the given name.
name | Name of the render system intend to retrieve. |
SceneManager* Ogre::Root::getSceneManager | ( | const String & | instanceName | ) | const |
Get an existing SceneManager instance that has already been created, identified by the instance name.
instanceName | The name of the instance to retrieve. |
SceneManagerEnumerator::SceneManagerIterator Ogre::Root::getSceneManagerIterator | ( | ) |
Get an iterator over all the existing SceneManager instances.
const SceneManagerMetaData* Ogre::Root::getSceneManagerMetaData | ( | const String & | typeName | ) | const |
Get more information about a given type of SceneManager.
typeName | The type name of the SceneManager you want to enquire on. If you don't know the typeName already, you can iterate over the metadata for all types using getMetaDataIterator. |
SceneManagerEnumerator::MetaDataIterator Ogre::Root::getSceneManagerMetaDataIterator | ( | ) | const |
Iterate over all types of SceneManager available for construction, providing some information about each one.
|
static |
Override standard Singleton retrieval.
Referenced by Ogre::CompositorPassSceneDef::CompositorPassSceneDef().
|
static |
Override standard Singleton retrieval.
Timer* Ogre::Root::getTimer | ( | ) |
Gets a pointer to the central timer used for all OGRE timings.
|
inline |
Get the WorkQueue for processing background tasks.
You are free to add new requests and handlers to this queue to process your custom background tasks using the shared thread pool. However, you must remember to assign yourself a new channel through which to process your tasks.
bool Ogre::Root::hasMovableObjectFactory | ( | const String & | typeName | ) | const |
Checks whether a factory is registered for a given MovableObject type.
bool Ogre::Root::hasSceneManager | ( | const String & | instanceName | ) | const |
Determines if a given SceneManager already exists.
instanceName | The name of the instance to retrieve. |
Window* Ogre::Root::initialise | ( | bool | autoCreateWindow, |
const String & | windowTitle = "OGRE Render Window" , |
||
const String & | customCapabilitiesConfig = BLANKSTRING |
||
) |
Initialises the renderer.
autoCreateWindow | If true, a rendering window will automatically be created (saving a call to Root::createRenderWindow). The window will be created based on the options currently set on the render system. |
void Ogre::Root::installPlugin | ( | Plugin * | plugin, |
const NameValuePairList * | options | ||
) |
Install a new plugin.
|
inline |
Returns whether blend indices information needs to be passed to the GPU see setBlendIndicesGpuRedundant() for more information.
|
inline |
Returns whether blend weights information needs to be passed to the GPU see setBlendWeightsGpuRedundant() for more information.
|
inline |
Returns whether the system is initialised or not.
void Ogre::Root::loadPlugin | ( | const String & | pluginName, |
const bool | bOptional, | ||
const NameValuePairList * | options | ||
) |
Manually load a Plugin contained in a DLL / DSO.
pluginName | Name of the plugin library to load |
bOptional | When true, we will skip it if it fails to initialize |
options | Options to pass onto the loading plugin. Can be nullptr |
DataStreamPtr Ogre::Root::openFileStream | ( | const String & | filename, |
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME , |
||
const String & | locationPattern = BLANKSTRING |
||
) |
Helper method to assist you in accessing readable file streams.
filename | The name of the file to open. |
groupName | The name of the group in which to create the file, if the resource system is used |
locationPattern | If the resource group contains multiple locations, then usually the file will be created in the first writable location. If you want to be more specific, you can include a location pattern here and only locations which match that pattern (as determined by StringUtil::match) will be considered candidates for creation. |
void Ogre::Root::queueEndRendering | ( | bool | state = true | ) |
Queues the end of rendering.
void Ogre::Root::removeFrameListener | ( | FrameListener * | oldListener | ) |
Removes a FrameListener from the list of listening classes.
void Ogre::Root::removeMovableObjectFactory | ( | MovableObjectFactory * | fact | ) |
Removes a previously registered MovableObjectFactory.
void Ogre::Root::removeResourceLocation | ( | const String & | name, |
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME |
||
) |
Removes a resource location from the list.
name | The name of the resource location as specified in addResourceLocation |
groupName | The name of the resource group to which this location was assigned. |
void Ogre::Root::removeSceneManagerFactory | ( | SceneManagerFactory * | fact | ) |
Unregister a SceneManagerFactory.
bool Ogre::Root::renderOneFrame | ( | ) |
Render one frame.
bool Ogre::Root::renderOneFrame | ( | Real | timeSinceLastFrame | ) |
Render one frame, with custom frame time information.
bool Ogre::Root::restoreConfig | ( | ) |
Checks for saved video/sound/etc settings.
void Ogre::Root::saveConfig | ( | ) |
Saves the details of the current configuration.
|
inline |
Sets whether blend indices information needs to be passed to the GPU.
When entities use software animation they remove blend information such as indices and weights from the vertex buffers sent to the graphic card. This function can be used to limit which information is removed.
redundant | Set to true to remove blend indices information. |
|
inline |
Sets whether blend weights information needs to be passed to the GPU.
When entities use software animation they remove blend information such as indices and weights from the vertex buffers sent to the graphic card. This function can be used to limit which information is removed.
redundant | Set to true to remove blend weights information. |
|
inline |
Set the default minimum pixel size for object to be rendered by.
|
inline |
Sets the period over which OGRE smooths out fluctuations in frame times.
|
inline |
Set whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared.
void Ogre::Root::setRenderSystem | ( | RenderSystem * | system | ) |
Sets the rendering subsystem to be used.
system | Pointer to the render system to use. |
void Ogre::Root::setWorkQueue | ( | WorkQueue * | queue | ) |
Replace the current work queue with an alternative.
You can use this method to replace the internal implementation of WorkQueue with your own, e.g. to externalise the processing of background events. Doing so will delete the existing queue and replace it with this one.
bool Ogre::Root::showConfigDialog | ( | ConfigDialog * | aCustomDialog = 0 | ) |
Displays a dialog asking the user to choose system settings.
aCustomDialog | If left null ogre will use the default config dialog. Otherwise it will use the one provided. |
void Ogre::Root::shutdown | ( | ) |
void Ogre::Root::startRendering | ( | ) |
Starts / restarts the automatic rendering cycle.
void Ogre::Root::uninstallPlugin | ( | Plugin * | plugin | ) |
Uninstall an existing plugin.
void Ogre::Root::unloadPlugin | ( | const String & | pluginName | ) |
Manually unloads a Plugin contained in a DLL / DSO.
pluginName | Name of the plugin library to unload |
void Ogre::Root::useCustomRenderSystemCapabilities | ( | RenderSystemCapabilities * | capabilities | ) |
Requests active RenderSystem to use custom RenderSystemCapabilities.