1 | <html> |
---|
2 | <head> |
---|
3 | <title>Ogre::ResourceBackgroundQueue class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
4 | <link type="text/css" rel="stylesheet" href="style.css"> |
---|
5 | </head> |
---|
6 | |
---|
7 | <body> |
---|
8 | <!-- Generated by Doxygen 1.3.6 --> |
---|
9 | <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
10 | <h1>Ogre::ResourceBackgroundQueue Class Reference</h1>This class is used to perform <a class="el" href="classOgre_1_1Resource.html">Resource</a> operations in a background thread. |
---|
11 | <a href="#_details">More...</a> |
---|
12 | <p> |
---|
13 | <code>#include <<a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>></code> |
---|
14 | <p> |
---|
15 | <p>Inheritance diagram for Ogre::ResourceBackgroundQueue: |
---|
16 | <p><center><img src="classOgre_1_1ResourceBackgroundQueue.png" usemap="#Ogre::ResourceBackgroundQueue_map" border="0" alt=""></center> |
---|
17 | <map name="Ogre::ResourceBackgroundQueue_map"> |
---|
18 | <area href="classOgre_1_1Singleton.html" alt="Ogre::Singleton< ResourceBackgroundQueue >" shape="rect" coords="0,0,283,24"> |
---|
19 | </map> |
---|
20 | <a href="classOgre_1_1ResourceBackgroundQueue-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> |
---|
21 | <tr><td></td></tr> |
---|
22 | <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
---|
23 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea0">ResourceBackgroundQueue</a> ()</td></tr> |
---|
24 | |
---|
25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Private mutex, not allowed to lock from outside. <a href="#Ogre_1_1ResourceBackgroundQueuea0"></a><br><br></td></tr> |
---|
26 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea1">~ResourceBackgroundQueue</a> ()</td></tr> |
---|
27 | |
---|
28 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea2">initialise</a> (void)</td></tr> |
---|
29 | |
---|
30 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the background queue system. <a href="#Ogre_1_1ResourceBackgroundQueuea2"></a><br><br></td></tr> |
---|
31 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea3">shutdown</a> (void)</td></tr> |
---|
32 | |
---|
33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Shut down the background queue system. <a href="#Ogre_1_1ResourceBackgroundQueuea3"></a><br><br></td></tr> |
---|
34 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea4">initialiseResourceGroup</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &name, <a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> *listener=0)</td></tr> |
---|
35 | |
---|
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise a resource group in the background. <a href="#Ogre_1_1ResourceBackgroundQueuea4"></a><br><br></td></tr> |
---|
37 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea5">initialiseAllResourceGroups</a> (<a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> *listener=0)</td></tr> |
---|
38 | |
---|
39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise all resource groups which are yet to be initialised in the background. <a href="#Ogre_1_1ResourceBackgroundQueuea5"></a><br><br></td></tr> |
---|
40 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea6">loadResourceGroup</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &name, <a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> *listener=0)</td></tr> |
---|
41 | |
---|
42 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Loads a resource group in the background. <a href="#Ogre_1_1ResourceBackgroundQueuea6"></a><br><br></td></tr> |
---|
43 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea7">load</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &resType, const <a class="el" href="namespaceOgre.html#a426">String</a> &name, const <a class="el" href="namespaceOgre.html#a426">String</a> &group, bool isManual=false, <a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> *loader=0, const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> *loadParams=0, <a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> *listener=0)</td></tr> |
---|
44 | |
---|
45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Load a single resource in the background. <a href="#Ogre_1_1ResourceBackgroundQueuea7"></a><br><br></td></tr> |
---|
46 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea8">isProcessComplete</a> (<a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> ticket)</td></tr> |
---|
47 | |
---|
48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a previously queued process has completed or not. <a href="#Ogre_1_1ResourceBackgroundQueuea8"></a><br><br></td></tr> |
---|
49 | <tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> |
---|
50 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuee0">getSingleton</a> (void)</td></tr> |
---|
51 | |
---|
52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval. <a href="#Ogre_1_1ResourceBackgroundQueuee0"></a><br><br></td></tr> |
---|
53 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuee1">getSingletonPtr</a> (void)</td></tr> |
---|
54 | |
---|
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval. <a href="#Ogre_1_1ResourceBackgroundQueuee1"></a><br><br></td></tr> |
---|
56 | <tr><td colspan=2><br><h2>Protected Types</h2></td></tr> |
---|
57 | <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::list< <a class="el" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex0">RequestQueue</a></td></tr> |
---|
58 | |
---|
59 | <tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map< <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a>,<br> |
---|
60 | <a class="el" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a> * > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex1">RequestTicketMap</a></td></tr> |
---|
61 | |
---|
62 | <tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7">RequestType</a> { <br> |
---|
63 | <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex2">RT_INITIALISE_GROUP</a>, |
---|
64 | <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex3">RT_INITIALISE_ALL_GROUPS</a>, |
---|
65 | <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex4">RT_LOAD_GROUP</a>, |
---|
66 | <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex5">RT_LOAD_RESOURCE</a>, |
---|
67 | <br> |
---|
68 | <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex6">RT_SHUTDOWN</a> |
---|
69 | <br> |
---|
70 | }</td></tr> |
---|
71 | |
---|
72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerates the type of requests. <a href="#Ogre_1_1ResourceBackgroundQueuex7">More...</a><br><br></td></tr> |
---|
73 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
74 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex0">RequestQueue</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep0">mRequestQueue</a></td></tr> |
---|
75 | |
---|
76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Queue of requests, used to store and order requests. <a href="#Ogre_1_1ResourceBackgroundQueuep0"></a><br><br></td></tr> |
---|
77 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex1">RequestTicketMap</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep1">mRequestTicketMap</a></td></tr> |
---|
78 | |
---|
79 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a> lookup by ticket. <a href="#Ogre_1_1ResourceBackgroundQueuep1"></a><br><br></td></tr> |
---|
80 | <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep2">mNextTicketID</a></td></tr> |
---|
81 | |
---|
82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Next ticket ID. <a href="#Ogre_1_1ResourceBackgroundQueuep2"></a><br><br></td></tr> |
---|
83 | <tr><td class="memItemLeft" nowrap align=right valign=top>void * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep3">mThread</a></td></tr> |
---|
84 | |
---|
85 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Dummy. <a href="#Ogre_1_1ResourceBackgroundQueuep3"></a><br><br></td></tr> |
---|
86 | <tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr> |
---|
87 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a></td></tr> |
---|
88 | |
---|
89 | </table> |
---|
90 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
91 | This class is used to perform <a class="el" href="classOgre_1_1Resource.html">Resource</a> operations in a background thread. |
---|
92 | <p> |
---|
93 | <dl compact><dt><b>Remarks:</b></dt><dd>If threading is enabled, <a class="el" href="namespaceOgre.html">Ogre</a> will create a single background thread which can be used to load / unload resources in parallel. Only one resource will be processed at once in this background thread, but it will be in parallel with the main thread. </dd></dl> |
---|
94 | <dl compact><dt><b></b></dt><dd>The general approach here is that on requesting a background resource process, your request is placed on a queue ready for the background thread to be picked up, and you will get a 'ticket' back, identifying the request. Your call will then return and your thread can proceed, knowing that at some point in the background the operation wil be performed. In it's own thread, the resource operation will be performed, and once finished the ticket will be marked as complete. You can check the status of tickets by calling <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea8">isProcessComplete()</a> from your queueing thread. It is also possible to get immediate callbacks on completion, but these callbacks happen in the background loading thread (not your calling thread), so should only be used if you really understand multithreading. </dd></dl> |
---|
95 | <dl compact><dt><b>Note:</b></dt><dd>This class will only perform tasks in a background thread if OGRE_THREAD_SUPPORT is defined to be 1. Otherwise, all methods will call their exact equivalents in <a class="el" href="classOgre_1_1ResourceGroupManager.html">ResourceGroupManager</a> synchronously.</dd></dl> |
---|
96 | |
---|
97 | <p> |
---|
98 | |
---|
99 | <p> |
---|
100 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00090">90</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>.<hr><h2>Member Typedef Documentation</h2> |
---|
101 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex0" doxytag="Ogre::ResourceBackgroundQueue::RequestQueue" ></a><p> |
---|
102 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
103 | <tr> |
---|
104 | <td class="mdRow"> |
---|
105 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
106 | <tr> |
---|
107 | <td class="md" nowrap valign="top"> typedef std::list<<a class="el" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a>> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex0">Ogre::ResourceBackgroundQueue::RequestQueue</a><code> [protected]</code> |
---|
108 | </table> |
---|
109 | </td> |
---|
110 | </tr> |
---|
111 | </table> |
---|
112 | <table cellspacing=5 cellpadding=0 border=0> |
---|
113 | <tr> |
---|
114 | <td> |
---|
115 | |
---|
116 | </td> |
---|
117 | <td> |
---|
118 | |
---|
119 | <p> |
---|
120 | |
---|
121 | <p> |
---|
122 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00115">115</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>. </td> |
---|
123 | </tr> |
---|
124 | </table> |
---|
125 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex1" doxytag="Ogre::ResourceBackgroundQueue::RequestTicketMap" ></a><p> |
---|
126 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
127 | <tr> |
---|
128 | <td class="mdRow"> |
---|
129 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
130 | <tr> |
---|
131 | <td class="md" nowrap valign="top"> typedef std::map<<a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a>, <a class="el" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a>*> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex1">Ogre::ResourceBackgroundQueue::RequestTicketMap</a><code> [protected]</code> |
---|
132 | </table> |
---|
133 | </td> |
---|
134 | </tr> |
---|
135 | </table> |
---|
136 | <table cellspacing=5 cellpadding=0 border=0> |
---|
137 | <tr> |
---|
138 | <td> |
---|
139 | |
---|
140 | </td> |
---|
141 | <td> |
---|
142 | |
---|
143 | <p> |
---|
144 | |
---|
145 | <p> |
---|
146 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00116">116</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>. </td> |
---|
147 | </tr> |
---|
148 | </table> |
---|
149 | <hr><h2>Member Enumeration Documentation</h2> |
---|
150 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex7" doxytag="Ogre::ResourceBackgroundQueue::RequestType" ></a><p> |
---|
151 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
152 | <tr> |
---|
153 | <td class="mdRow"> |
---|
154 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
155 | <tr> |
---|
156 | <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex7">Ogre::ResourceBackgroundQueue::RequestType</a><code> [protected]</code> |
---|
157 | </table> |
---|
158 | </td> |
---|
159 | </tr> |
---|
160 | </table> |
---|
161 | <table cellspacing=5 cellpadding=0 border=0> |
---|
162 | <tr> |
---|
163 | <td> |
---|
164 | |
---|
165 | </td> |
---|
166 | <td> |
---|
167 | |
---|
168 | <p> |
---|
169 | Enumerates the type of requests. |
---|
170 | <p> |
---|
171 | <dl compact><dt><b>Enumeration values: </b></dt><dd> |
---|
172 | <table border=0 cellspacing=2 cellpadding=0> |
---|
173 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex2" doxytag="RT_INITIALISE_GROUP" ></a>RT_INITIALISE_GROUP</em> </td><td> |
---|
174 | </td></tr> |
---|
175 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex3" doxytag="RT_INITIALISE_ALL_GROUPS" ></a>RT_INITIALISE_ALL_GROUPS</em> </td><td> |
---|
176 | </td></tr> |
---|
177 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex4" doxytag="RT_LOAD_GROUP" ></a>RT_LOAD_GROUP</em> </td><td> |
---|
178 | </td></tr> |
---|
179 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex5" doxytag="RT_LOAD_RESOURCE" ></a>RT_LOAD_RESOURCE</em> </td><td> |
---|
180 | </td></tr> |
---|
181 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1ResourceBackgroundQueuex7Ogre_1_1ResourceBackgroundQueuex6" doxytag="RT_SHUTDOWN" ></a>RT_SHUTDOWN</em> </td><td> |
---|
182 | </td></tr> |
---|
183 | </table> |
---|
184 | </dl> |
---|
185 | |
---|
186 | <p> |
---|
187 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00094">94</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>. </td> |
---|
188 | </tr> |
---|
189 | </table> |
---|
190 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
191 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea0" doxytag="Ogre::ResourceBackgroundQueue::ResourceBackgroundQueue" ></a><p> |
---|
192 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
193 | <tr> |
---|
194 | <td class="mdRow"> |
---|
195 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
196 | <tr> |
---|
197 | <td class="md" nowrap valign="top"> Ogre::ResourceBackgroundQueue::ResourceBackgroundQueue </td> |
---|
198 | <td class="md" valign="top">( </td> |
---|
199 | <td class="mdname1" valign="top" nowrap> </td> |
---|
200 | <td class="md" valign="top"> ) </td> |
---|
201 | <td class="md" nowrap></td> |
---|
202 | </tr> |
---|
203 | |
---|
204 | </table> |
---|
205 | </td> |
---|
206 | </tr> |
---|
207 | </table> |
---|
208 | <table cellspacing=5 cellpadding=0 border=0> |
---|
209 | <tr> |
---|
210 | <td> |
---|
211 | |
---|
212 | </td> |
---|
213 | <td> |
---|
214 | |
---|
215 | <p> |
---|
216 | Private mutex, not allowed to lock from outside. |
---|
217 | <p> |
---|
218 | </td> |
---|
219 | </tr> |
---|
220 | </table> |
---|
221 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea1" doxytag="Ogre::ResourceBackgroundQueue::~ResourceBackgroundQueue" ></a><p> |
---|
222 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
223 | <tr> |
---|
224 | <td class="mdRow"> |
---|
225 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
226 | <tr> |
---|
227 | <td class="md" nowrap valign="top"> virtual Ogre::ResourceBackgroundQueue::~<a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a> </td> |
---|
228 | <td class="md" valign="top">( </td> |
---|
229 | <td class="mdname1" valign="top" nowrap> </td> |
---|
230 | <td class="md" valign="top"> ) </td> |
---|
231 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
232 | </tr> |
---|
233 | |
---|
234 | </table> |
---|
235 | </td> |
---|
236 | </tr> |
---|
237 | </table> |
---|
238 | <table cellspacing=5 cellpadding=0 border=0> |
---|
239 | <tr> |
---|
240 | <td> |
---|
241 | |
---|
242 | </td> |
---|
243 | <td> |
---|
244 | |
---|
245 | <p> |
---|
246 | </td> |
---|
247 | </tr> |
---|
248 | </table> |
---|
249 | <hr><h2>Member Function Documentation</h2> |
---|
250 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuee0" doxytag="Ogre::ResourceBackgroundQueue::getSingleton" ></a><p> |
---|
251 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
252 | <tr> |
---|
253 | <td class="mdRow"> |
---|
254 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
255 | <tr> |
---|
256 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a>& Ogre::ResourceBackgroundQueue::getSingleton </td> |
---|
257 | <td class="md" valign="top">( </td> |
---|
258 | <td class="md" nowrap valign="top">void </td> |
---|
259 | <td class="mdname1" valign="top" nowrap> </td> |
---|
260 | <td class="md" valign="top"> ) </td> |
---|
261 | <td class="md" nowrap><code> [static]</code></td> |
---|
262 | </tr> |
---|
263 | |
---|
264 | </table> |
---|
265 | </td> |
---|
266 | </tr> |
---|
267 | </table> |
---|
268 | <table cellspacing=5 cellpadding=0 border=0> |
---|
269 | <tr> |
---|
270 | <td> |
---|
271 | |
---|
272 | </td> |
---|
273 | <td> |
---|
274 | |
---|
275 | <p> |
---|
276 | Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval. |
---|
277 | <p> |
---|
278 | <dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl> |
---|
279 | <dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl> |
---|
280 | |
---|
281 | <p> |
---|
282 | Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone0">Ogre::Singleton< ResourceBackgroundQueue ></a>. </td> |
---|
283 | </tr> |
---|
284 | </table> |
---|
285 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuee1" doxytag="Ogre::ResourceBackgroundQueue::getSingletonPtr" ></a><p> |
---|
286 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
287 | <tr> |
---|
288 | <td class="mdRow"> |
---|
289 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
290 | <tr> |
---|
291 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a>* Ogre::ResourceBackgroundQueue::getSingletonPtr </td> |
---|
292 | <td class="md" valign="top">( </td> |
---|
293 | <td class="md" nowrap valign="top">void </td> |
---|
294 | <td class="mdname1" valign="top" nowrap> </td> |
---|
295 | <td class="md" valign="top"> ) </td> |
---|
296 | <td class="md" nowrap><code> [static]</code></td> |
---|
297 | </tr> |
---|
298 | |
---|
299 | </table> |
---|
300 | </td> |
---|
301 | </tr> |
---|
302 | </table> |
---|
303 | <table cellspacing=5 cellpadding=0 border=0> |
---|
304 | <tr> |
---|
305 | <td> |
---|
306 | |
---|
307 | </td> |
---|
308 | <td> |
---|
309 | |
---|
310 | <p> |
---|
311 | Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval. |
---|
312 | <p> |
---|
313 | <dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl> |
---|
314 | <dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl> |
---|
315 | |
---|
316 | <p> |
---|
317 | Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone1">Ogre::Singleton< ResourceBackgroundQueue ></a>. </td> |
---|
318 | </tr> |
---|
319 | </table> |
---|
320 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea2" doxytag="Ogre::ResourceBackgroundQueue::initialise" ></a><p> |
---|
321 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
322 | <tr> |
---|
323 | <td class="mdRow"> |
---|
324 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
325 | <tr> |
---|
326 | <td class="md" nowrap valign="top"> virtual void Ogre::ResourceBackgroundQueue::initialise </td> |
---|
327 | <td class="md" valign="top">( </td> |
---|
328 | <td class="md" nowrap valign="top">void </td> |
---|
329 | <td class="mdname1" valign="top" nowrap> </td> |
---|
330 | <td class="md" valign="top"> ) </td> |
---|
331 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
332 | </tr> |
---|
333 | |
---|
334 | </table> |
---|
335 | </td> |
---|
336 | </tr> |
---|
337 | </table> |
---|
338 | <table cellspacing=5 cellpadding=0 border=0> |
---|
339 | <tr> |
---|
340 | <td> |
---|
341 | |
---|
342 | </td> |
---|
343 | <td> |
---|
344 | |
---|
345 | <p> |
---|
346 | Initialise the background queue system. |
---|
347 | <p> |
---|
348 | </td> |
---|
349 | </tr> |
---|
350 | </table> |
---|
351 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea5" doxytag="Ogre::ResourceBackgroundQueue::initialiseAllResourceGroups" ></a><p> |
---|
352 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
353 | <tr> |
---|
354 | <td class="mdRow"> |
---|
355 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
356 | <tr> |
---|
357 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> Ogre::ResourceBackgroundQueue::initialiseAllResourceGroups </td> |
---|
358 | <td class="md" valign="top">( </td> |
---|
359 | <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> * </td> |
---|
360 | <td class="mdname1" valign="top" nowrap> <em>listener</em> = 0 </td> |
---|
361 | <td class="md" valign="top"> ) </td> |
---|
362 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
363 | </tr> |
---|
364 | |
---|
365 | </table> |
---|
366 | </td> |
---|
367 | </tr> |
---|
368 | </table> |
---|
369 | <table cellspacing=5 cellpadding=0 border=0> |
---|
370 | <tr> |
---|
371 | <td> |
---|
372 | |
---|
373 | </td> |
---|
374 | <td> |
---|
375 | |
---|
376 | <p> |
---|
377 | Initialise all resource groups which are yet to be initialised in the background. |
---|
378 | <p> |
---|
379 | <dl compact><dt><b>See also:</b></dt><dd>ResourceGroupManager::intialiseResourceGroup </dd></dl> |
---|
380 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
381 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
382 | <tr><td valign=top><em>listener</em> </td><td>Optional callback interface, take note of warnings in the header and only use if you understand them. </td></tr> |
---|
383 | </table> |
---|
384 | </dl> |
---|
385 | <dl compact><dt><b>Returns:</b></dt><dd>Ticket identifying the request, use <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea8">isProcessComplete()</a> to determine if completed if not using listener</dd></dl> |
---|
386 | </td> |
---|
387 | </tr> |
---|
388 | </table> |
---|
389 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea4" doxytag="Ogre::ResourceBackgroundQueue::initialiseResourceGroup" ></a><p> |
---|
390 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
391 | <tr> |
---|
392 | <td class="mdRow"> |
---|
393 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
394 | <tr> |
---|
395 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> Ogre::ResourceBackgroundQueue::initialiseResourceGroup </td> |
---|
396 | <td class="md" valign="top">( </td> |
---|
397 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
398 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
399 | </tr> |
---|
400 | <tr> |
---|
401 | <td class="md" nowrap align="right"></td> |
---|
402 | <td></td> |
---|
403 | <td class="md" nowrap><a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> * </td> |
---|
404 | <td class="mdname" nowrap> <em>listener</em> = 0</td> |
---|
405 | </tr> |
---|
406 | <tr> |
---|
407 | <td></td> |
---|
408 | <td class="md">) </td> |
---|
409 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
410 | </tr> |
---|
411 | |
---|
412 | </table> |
---|
413 | </td> |
---|
414 | </tr> |
---|
415 | </table> |
---|
416 | <table cellspacing=5 cellpadding=0 border=0> |
---|
417 | <tr> |
---|
418 | <td> |
---|
419 | |
---|
420 | </td> |
---|
421 | <td> |
---|
422 | |
---|
423 | <p> |
---|
424 | Initialise a resource group in the background. |
---|
425 | <p> |
---|
426 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1ResourceGroupManager.html#Ogre_1_1ResourceGroupManagera3">ResourceGroupManager::initialiseResourceGroup</a> </dd></dl> |
---|
427 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
428 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
429 | <tr><td valign=top><em>name</em> </td><td>The name of the resource group to initialise </td></tr> |
---|
430 | <tr><td valign=top><em>listener</em> </td><td>Optional callback interface, take note of warnings in the header and only use if you understand them. </td></tr> |
---|
431 | </table> |
---|
432 | </dl> |
---|
433 | <dl compact><dt><b>Returns:</b></dt><dd>Ticket identifying the request, use <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea8">isProcessComplete()</a> to determine if completed if not using listener</dd></dl> |
---|
434 | </td> |
---|
435 | </tr> |
---|
436 | </table> |
---|
437 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea8" doxytag="Ogre::ResourceBackgroundQueue::isProcessComplete" ></a><p> |
---|
438 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
439 | <tr> |
---|
440 | <td class="mdRow"> |
---|
441 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
442 | <tr> |
---|
443 | <td class="md" nowrap valign="top"> virtual bool Ogre::ResourceBackgroundQueue::isProcessComplete </td> |
---|
444 | <td class="md" valign="top">( </td> |
---|
445 | <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> </td> |
---|
446 | <td class="mdname1" valign="top" nowrap> <em>ticket</em> </td> |
---|
447 | <td class="md" valign="top"> ) </td> |
---|
448 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
449 | </tr> |
---|
450 | |
---|
451 | </table> |
---|
452 | </td> |
---|
453 | </tr> |
---|
454 | </table> |
---|
455 | <table cellspacing=5 cellpadding=0 border=0> |
---|
456 | <tr> |
---|
457 | <td> |
---|
458 | |
---|
459 | </td> |
---|
460 | <td> |
---|
461 | |
---|
462 | <p> |
---|
463 | Returns whether a previously queued process has completed or not. |
---|
464 | <p> |
---|
465 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
466 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
467 | <tr><td valign=top><em>ticket</em> </td><td>The ticket which was returned when the process was queued </td></tr> |
---|
468 | </table> |
---|
469 | </dl> |
---|
470 | <dl compact><dt><b>Returns:</b></dt><dd>true if process has completed (or if the ticket is unrecognised), false otherwise </dd></dl> |
---|
471 | <dl compact><dt><b>Note:</b></dt><dd>Tickets are not stored onced complete so do not accumulate over time. This is why a non-existent ticket will return 'true'.</dd></dl> |
---|
472 | </td> |
---|
473 | </tr> |
---|
474 | </table> |
---|
475 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea7" doxytag="Ogre::ResourceBackgroundQueue::load" ></a><p> |
---|
476 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
477 | <tr> |
---|
478 | <td class="mdRow"> |
---|
479 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
480 | <tr> |
---|
481 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> Ogre::ResourceBackgroundQueue::load </td> |
---|
482 | <td class="md" valign="top">( </td> |
---|
483 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
484 | <td class="mdname" nowrap> <em>resType</em>, </td> |
---|
485 | </tr> |
---|
486 | <tr> |
---|
487 | <td class="md" nowrap align="right"></td> |
---|
488 | <td></td> |
---|
489 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
490 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
491 | </tr> |
---|
492 | <tr> |
---|
493 | <td class="md" nowrap align="right"></td> |
---|
494 | <td></td> |
---|
495 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
496 | <td class="mdname" nowrap> <em>group</em>, </td> |
---|
497 | </tr> |
---|
498 | <tr> |
---|
499 | <td class="md" nowrap align="right"></td> |
---|
500 | <td></td> |
---|
501 | <td class="md" nowrap>bool </td> |
---|
502 | <td class="mdname" nowrap> <em>isManual</em> = false, </td> |
---|
503 | </tr> |
---|
504 | <tr> |
---|
505 | <td class="md" nowrap align="right"></td> |
---|
506 | <td></td> |
---|
507 | <td class="md" nowrap><a class="el" href="classOgre_1_1ManualResourceLoader.html">ManualResourceLoader</a> * </td> |
---|
508 | <td class="mdname" nowrap> <em>loader</em> = 0, </td> |
---|
509 | </tr> |
---|
510 | <tr> |
---|
511 | <td class="md" nowrap align="right"></td> |
---|
512 | <td></td> |
---|
513 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> * </td> |
---|
514 | <td class="mdname" nowrap> <em>loadParams</em> = 0, </td> |
---|
515 | </tr> |
---|
516 | <tr> |
---|
517 | <td class="md" nowrap align="right"></td> |
---|
518 | <td></td> |
---|
519 | <td class="md" nowrap><a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> * </td> |
---|
520 | <td class="mdname" nowrap> <em>listener</em> = 0</td> |
---|
521 | </tr> |
---|
522 | <tr> |
---|
523 | <td></td> |
---|
524 | <td class="md">) </td> |
---|
525 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
526 | </tr> |
---|
527 | |
---|
528 | </table> |
---|
529 | </td> |
---|
530 | </tr> |
---|
531 | </table> |
---|
532 | <table cellspacing=5 cellpadding=0 border=0> |
---|
533 | <tr> |
---|
534 | <td> |
---|
535 | |
---|
536 | </td> |
---|
537 | <td> |
---|
538 | |
---|
539 | <p> |
---|
540 | Load a single resource in the background. |
---|
541 | <p> |
---|
542 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1ResourceManager.html#Ogre_1_1TextureManagera29">ResourceManager::load</a> </dd></dl> |
---|
543 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
544 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
545 | <tr><td valign=top><em>resType</em> </td><td>The type of the resource (from <a class="el" href="classOgre_1_1ResourceManager.html#Ogre_1_1TextureManagera33">ResourceManager::getResourceType()</a>) </td></tr> |
---|
546 | <tr><td valign=top><em>name</em> </td><td>The name of the <a class="el" href="classOgre_1_1Resource.html">Resource</a> </td></tr> |
---|
547 | <tr><td valign=top><em>group</em> </td><td>The resource group to which this resource will belong </td></tr> |
---|
548 | <tr><td valign=top><em>isManual</em> </td><td>Is the resource to be manually loaded? If so, you should provide a value for the loader parameter </td></tr> |
---|
549 | <tr><td valign=top><em>loader</em> </td><td>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!! </td></tr> |
---|
550 | <tr><td valign=top><em>loadParams</em> </td><td>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!</td></tr> |
---|
551 | </table> |
---|
552 | </dl> |
---|
553 | </td> |
---|
554 | </tr> |
---|
555 | </table> |
---|
556 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea6" doxytag="Ogre::ResourceBackgroundQueue::loadResourceGroup" ></a><p> |
---|
557 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
558 | <tr> |
---|
559 | <td class="mdRow"> |
---|
560 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
561 | <tr> |
---|
562 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a487">BackgroundProcessTicket</a> Ogre::ResourceBackgroundQueue::loadResourceGroup </td> |
---|
563 | <td class="md" valign="top">( </td> |
---|
564 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> & </td> |
---|
565 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
566 | </tr> |
---|
567 | <tr> |
---|
568 | <td class="md" nowrap align="right"></td> |
---|
569 | <td></td> |
---|
570 | <td class="md" nowrap><a class="el" href="classOgre_1_1ResourceBackgroundQueueListener.html">ResourceBackgroundQueueListener</a> * </td> |
---|
571 | <td class="mdname" nowrap> <em>listener</em> = 0</td> |
---|
572 | </tr> |
---|
573 | <tr> |
---|
574 | <td></td> |
---|
575 | <td class="md">) </td> |
---|
576 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
577 | </tr> |
---|
578 | |
---|
579 | </table> |
---|
580 | </td> |
---|
581 | </tr> |
---|
582 | </table> |
---|
583 | <table cellspacing=5 cellpadding=0 border=0> |
---|
584 | <tr> |
---|
585 | <td> |
---|
586 | |
---|
587 | </td> |
---|
588 | <td> |
---|
589 | |
---|
590 | <p> |
---|
591 | Loads a resource group in the background. |
---|
592 | <p> |
---|
593 | <dl compact><dt><b>See also:</b></dt><dd>ResourceGroupManager::intialiseResourceGroup </dd></dl> |
---|
594 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
595 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
596 | <tr><td valign=top><em>listener</em> </td><td>Optional callback interface, take note of warnings in the header and only use if you understand them. </td></tr> |
---|
597 | </table> |
---|
598 | </dl> |
---|
599 | <dl compact><dt><b>Returns:</b></dt><dd>Ticket identifying the request, use <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuea8">isProcessComplete()</a> to determine if completed if not using listener</dd></dl> |
---|
600 | </td> |
---|
601 | </tr> |
---|
602 | </table> |
---|
603 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuea3" doxytag="Ogre::ResourceBackgroundQueue::shutdown" ></a><p> |
---|
604 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
605 | <tr> |
---|
606 | <td class="mdRow"> |
---|
607 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
608 | <tr> |
---|
609 | <td class="md" nowrap valign="top"> virtual void Ogre::ResourceBackgroundQueue::shutdown </td> |
---|
610 | <td class="md" valign="top">( </td> |
---|
611 | <td class="md" nowrap valign="top">void </td> |
---|
612 | <td class="mdname1" valign="top" nowrap> </td> |
---|
613 | <td class="md" valign="top"> ) </td> |
---|
614 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
615 | </tr> |
---|
616 | |
---|
617 | </table> |
---|
618 | </td> |
---|
619 | </tr> |
---|
620 | </table> |
---|
621 | <table cellspacing=5 cellpadding=0 border=0> |
---|
622 | <tr> |
---|
623 | <td> |
---|
624 | |
---|
625 | </td> |
---|
626 | <td> |
---|
627 | |
---|
628 | <p> |
---|
629 | Shut down the background queue system. |
---|
630 | <p> |
---|
631 | </td> |
---|
632 | </tr> |
---|
633 | </table> |
---|
634 | <hr><h2>Member Data Documentation</h2> |
---|
635 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuep2" doxytag="Ogre::ResourceBackgroundQueue::mNextTicketID" ></a><p> |
---|
636 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
637 | <tr> |
---|
638 | <td class="mdRow"> |
---|
639 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
640 | <tr> |
---|
641 | <td class="md" nowrap valign="top"> unsigned long <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep2">Ogre::ResourceBackgroundQueue::mNextTicketID</a><code> [protected]</code> |
---|
642 | </table> |
---|
643 | </td> |
---|
644 | </tr> |
---|
645 | </table> |
---|
646 | <table cellspacing=5 cellpadding=0 border=0> |
---|
647 | <tr> |
---|
648 | <td> |
---|
649 | |
---|
650 | </td> |
---|
651 | <td> |
---|
652 | |
---|
653 | <p> |
---|
654 | Next ticket ID. |
---|
655 | <p> |
---|
656 | |
---|
657 | <p> |
---|
658 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00125">125</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>. </td> |
---|
659 | </tr> |
---|
660 | </table> |
---|
661 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuep0" doxytag="Ogre::ResourceBackgroundQueue::mRequestQueue" ></a><p> |
---|
662 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
663 | <tr> |
---|
664 | <td class="mdRow"> |
---|
665 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
666 | <tr> |
---|
667 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex0">RequestQueue</a> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep0">Ogre::ResourceBackgroundQueue::mRequestQueue</a><code> [protected]</code> |
---|
668 | </table> |
---|
669 | </td> |
---|
670 | </tr> |
---|
671 | </table> |
---|
672 | <table cellspacing=5 cellpadding=0 border=0> |
---|
673 | <tr> |
---|
674 | <td> |
---|
675 | |
---|
676 | </td> |
---|
677 | <td> |
---|
678 | |
---|
679 | <p> |
---|
680 | Queue of requests, used to store and order requests. |
---|
681 | <p> |
---|
682 | |
---|
683 | <p> |
---|
684 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00119">119</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>. </td> |
---|
685 | </tr> |
---|
686 | </table> |
---|
687 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuep1" doxytag="Ogre::ResourceBackgroundQueue::mRequestTicketMap" ></a><p> |
---|
688 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
689 | <tr> |
---|
690 | <td class="mdRow"> |
---|
691 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
692 | <tr> |
---|
693 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuex1">RequestTicketMap</a> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep1">Ogre::ResourceBackgroundQueue::mRequestTicketMap</a><code> [protected]</code> |
---|
694 | </table> |
---|
695 | </td> |
---|
696 | </tr> |
---|
697 | </table> |
---|
698 | <table cellspacing=5 cellpadding=0 border=0> |
---|
699 | <tr> |
---|
700 | <td> |
---|
701 | |
---|
702 | </td> |
---|
703 | <td> |
---|
704 | |
---|
705 | <p> |
---|
706 | <a class="el" href="structOgre_1_1ResourceBackgroundQueue_1_1Request.html">Request</a> lookup by ticket. |
---|
707 | <p> |
---|
708 | |
---|
709 | <p> |
---|
710 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00122">122</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>. </td> |
---|
711 | </tr> |
---|
712 | </table> |
---|
713 | <a class="anchor" name="Ogre_1_1Singletont0" doxytag="Ogre::ResourceBackgroundQueue::ms_Singleton" ></a><p> |
---|
714 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
715 | <tr> |
---|
716 | <td class="mdRow"> |
---|
717 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
718 | <tr> |
---|
719 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a> * <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>< <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html">ResourceBackgroundQueue</a> >::<a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a><code> [static, protected, inherited]</code> |
---|
720 | </table> |
---|
721 | </td> |
---|
722 | </tr> |
---|
723 | </table> |
---|
724 | <table cellspacing=5 cellpadding=0 border=0> |
---|
725 | <tr> |
---|
726 | <td> |
---|
727 | |
---|
728 | </td> |
---|
729 | <td> |
---|
730 | |
---|
731 | <p> |
---|
732 | |
---|
733 | <p> |
---|
734 | Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00054">54</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>. </td> |
---|
735 | </tr> |
---|
736 | </table> |
---|
737 | <a class="anchor" name="Ogre_1_1ResourceBackgroundQueuep3" doxytag="Ogre::ResourceBackgroundQueue::mThread" ></a><p> |
---|
738 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
739 | <tr> |
---|
740 | <td class="mdRow"> |
---|
741 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
742 | <tr> |
---|
743 | <td class="md" nowrap valign="top"> void* <a class="el" href="classOgre_1_1ResourceBackgroundQueue.html#Ogre_1_1ResourceBackgroundQueuep3">Ogre::ResourceBackgroundQueue::mThread</a><code> [protected]</code> |
---|
744 | </table> |
---|
745 | </td> |
---|
746 | </tr> |
---|
747 | </table> |
---|
748 | <table cellspacing=5 cellpadding=0 border=0> |
---|
749 | <tr> |
---|
750 | <td> |
---|
751 | |
---|
752 | </td> |
---|
753 | <td> |
---|
754 | |
---|
755 | <p> |
---|
756 | Dummy. |
---|
757 | <p> |
---|
758 | |
---|
759 | <p> |
---|
760 | Definition at line <a class="el" href="OgreResourceBackgroundQueue_8h-source.html#l00138">138</a> of file <a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a>. </td> |
---|
761 | </tr> |
---|
762 | </table> |
---|
763 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
764 | <li><a class="el" href="OgreResourceBackgroundQueue_8h-source.html">OgreResourceBackgroundQueue.h</a></ul> |
---|
765 | <hr> |
---|
766 | <p> |
---|
767 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
768 | <!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/> |
---|
769 | This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/> |
---|
770 | <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> |
---|
771 | <Work rdf:about=""> |
---|
772 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
773 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
774 | </Work> |
---|
775 | <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> --> |
---|
776 | |
---|
777 | Last modified Sun Feb 12 13:02:48 2006 |
---|
778 | </p> |
---|
779 | </body> |
---|
780 | </html> |
---|