![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
This class is used to perform Resource operations in a background thread. More...
#include <OgreResourceBackgroundQueue.h>
Inheritance diagram for Ogre::ResourceBackgroundQueue:Classes | |
| class | Listener |
| This abstract listener interface lets you get notifications of completed background processes instead of having to poll ticket statuses. More... | |
Public Member Functions | |
| ResourceBackgroundQueue () | |
| ~ResourceBackgroundQueue () override | |
| void | abortRequest (BackgroundProcessTicket ticket) |
| Aborts background process. | |
| bool | canHandleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ) override |
| Implementation for WorkQueue::RequestHandler. | |
| bool | canHandleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ) override |
| Implementation for WorkQueue::ResponseHandler. | |
| WorkQueue::Response * | handleRequest (const WorkQueue::Request *req, const WorkQueue *srcQ) override |
| Implementation for WorkQueue::RequestHandler. | |
| void | handleResponse (const WorkQueue::Response *res, const WorkQueue *srcQ) override |
| Implementation for WorkQueue::ResponseHandler. | |
| virtual void | initialise () |
| Initialise the background queue system. | |
| virtual BackgroundProcessTicket | initialiseAllResourceGroups (Listener *listener=0) |
| Initialise all resource groups which are yet to be initialised in the background. | |
| virtual BackgroundProcessTicket | initialiseResourceGroup (const String &name, Listener *listener=0) |
| Initialise a resource group in the background. | |
| virtual bool | isProcessComplete (BackgroundProcessTicket ticket) |
| Returns whether a previously queued process has completed or not. | |
| virtual BackgroundProcessTicket | load (const String &resType, const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, Listener *listener=0) |
| Load a single resource in the background. | |
| virtual BackgroundProcessTicket | loadResourceGroup (const String &name, Listener *listener=0) |
| Loads a resource group in the background. | |
| virtual BackgroundProcessTicket | prepare (const String &resType, const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, Listener *listener=0) |
| Prepare a single resource in the background. | |
| virtual BackgroundProcessTicket | prepareResourceGroup (const String &name, Listener *listener=0) |
| Prepares a resource group in the background. | |
| virtual void | shutdown () |
| Shut down the background queue system. | |
| virtual BackgroundProcessTicket | unload (const String &resType, const String &name, Listener *listener=0) |
| Unload a single resource in the background. | |
| virtual BackgroundProcessTicket | unload (const String &resType, ResourceHandle handle, Listener *listener=0) |
| Unload a single resource in the background. | |
| virtual BackgroundProcessTicket | unloadResourceGroup (const String &name, Listener *listener=0) |
| Unloads a resource group in the background. | |
Public Member Functions inherited from Ogre::Singleton< ResourceBackgroundQueue > | |
| Singleton () | |
| ~Singleton () | |
Public Member Functions inherited from Ogre::WorkQueue::RequestHandler | |
| RequestHandler () | |
| virtual | ~RequestHandler () |
Public Member Functions inherited from Ogre::WorkQueue::ResponseHandler | |
| ResponseHandler () | |
| virtual | ~ResponseHandler () |
Static Public Member Functions | |
| static ResourceBackgroundQueue & | getSingleton () |
| Override standard Singleton retrieval. | |
| static ResourceBackgroundQueue * | getSingletonPtr () |
| Override standard Singleton retrieval. | |
Static Public Member Functions inherited from Ogre::Singleton< ResourceBackgroundQueue > | |
| static ResourceBackgroundQueue & | getSingleton () |
| static ResourceBackgroundQueue * | getSingletonPtr () |
This class is used to perform Resource operations in a background thread.
| Ogre::ResourceBackgroundQueue::ResourceBackgroundQueue | ( | ) |
Referenced by getSingleton(), and getSingletonPtr().
|
override |
| void Ogre::ResourceBackgroundQueue::abortRequest | ( | BackgroundProcessTicket | ticket | ) |
Aborts background process.
|
overridevirtual |
Implementation for WorkQueue::RequestHandler.
Reimplemented from Ogre::WorkQueue::RequestHandler.
|
overridevirtual |
Implementation for WorkQueue::ResponseHandler.
Reimplemented from Ogre::WorkQueue::ResponseHandler.
|
static |
Override standard Singleton retrieval.
References ResourceBackgroundQueue().
|
static |
Override standard Singleton retrieval.
References ResourceBackgroundQueue().
|
overridevirtual |
Implementation for WorkQueue::RequestHandler.
Implements Ogre::WorkQueue::RequestHandler.
|
overridevirtual |
Implementation for WorkQueue::ResponseHandler.
Implements Ogre::WorkQueue::ResponseHandler.
|
virtual |
Initialise the background queue system.
|
virtual |
Initialise all resource groups which are yet to be initialised in the background.
| listener | Optional callback interface, take note of warnings in the header and only use if you understand them. |
|
virtual |
Initialise a resource group in the background.
| name | The name of the resource group to initialise |
| listener | Optional callback interface, take note of warnings in the header and only use if you understand them. |
|
virtual |
Returns whether a previously queued process has completed or not.
| ticket | The ticket which was returned when the process was queued |
|
virtual |
Load a single resource in the background.
| resType | The type of the resource (from ResourceManager::getResourceType()) |
| name | The name of the Resource |
| group | The resource group to which this resource will belong |
| isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter |
| loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter. NOTE: must be thread safe!! |
| loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource. Remember that this must have a lifespan longer than the return of this call! |
|
virtual |
Loads a resource group in the background.
| name | The name of the resource group to load |
| listener | Optional callback interface, take note of warnings in the header and only use if you understand them. |
|
virtual |
Prepare a single resource in the background.
| resType | The type of the resource (from ResourceManager::getResourceType()) |
| name | The name of the Resource |
| group | The resource group to which this resource will belong |
| isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter |
| loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter. NOTE: must be thread safe!! |
| loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource. Remember that this must have a lifespan longer than the return of this call! |
|
virtual |
Prepares a resource group in the background.
| name | The name of the resource group to prepare |
| listener | Optional callback interface, take note of warnings in the header and only use if you understand them. |
|
virtual |
Shut down the background queue system.
|
virtual |
Unload a single resource in the background.
| resType | The type of the resource (from ResourceManager::getResourceType()) |
| name | The name of the Resource |
|
virtual |
Unload a single resource in the background.
| resType | The type of the resource (from ResourceManager::getResourceType()) |
| handle | Handle to the resource |
|
virtual |
Unloads a resource group in the background.
| name | The name of the resource group to load |