Deploy GH

api/latest/class_ogre_1_1_parallel_hlms_compile_queue.html

@@ -107,20 +107,26 @@
 <tr class="memitem:ae38048ebb76edabb33f61e0745d796d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ae38048ebb76edabb33f61e0745d796d0">ParallelHlmsCompileQueue</a> ()</td></tr>
 <tr class="separator:ae38048ebb76edabb33f61e0745d796d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a392eb4d02e34df8841097ac7be82b852"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a392eb4d02e34df8841097ac7be82b852">fireWarmUpParallel</a> (<a class="el" href="class_ogre_1_1_scene_manager.html">SceneManager</a> *sceneManager)</td></tr>
+<tr class="memdesc:a392eb4d02e34df8841097ac7be82b852"><td class="mdescLeft">&#160;</td><td class="mdescRight">Similar to <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a6e2a94362f7bae8919e3074587b252b9" title="Starts worker threads (job queue) so they start accepting work every time pushRequest() gets called a...">start()</a> and <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a" title="Signals worker threads we won&#39;t be submitting more work, so they should stop once they&#39;re done compil...">stopAndWait()</a> at the same time: It assumes all work has already been gathered in mRequests via <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aac24523f28c40d659b84f80d2a43fd95">pushWarmUpRequest()</a> (instead of gather it as we go) and fires all threads to compile the shaders and PSOs in parallel.  <a href="class_ogre_1_1_parallel_hlms_compile_queue.html#a392eb4d02e34df8841097ac7be82b852">More...</a><br /></td></tr>
 <tr class="separator:a392eb4d02e34df8841097ac7be82b852"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aaf595df16ab16cb9459154049bdd86d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aaf595df16ab16cb9459154049bdd86d1">pushRequest</a> (const <a class="el" href="struct_ogre_1_1_parallel_hlms_compile_queue_1_1_request.html">Request</a> &amp;&amp;request)</td></tr>
 <tr class="separator:aaf595df16ab16cb9459154049bdd86d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aac24523f28c40d659b84f80d2a43fd95"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aac24523f28c40d659b84f80d2a43fd95">pushWarmUpRequest</a> (const <a class="el" href="struct_ogre_1_1_parallel_hlms_compile_queue_1_1_request.html">Request</a> &amp;&amp;request)</td></tr>
 <tr class="separator:aac24523f28c40d659b84f80d2a43fd95"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a6e2a94362f7bae8919e3074587b252b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a6e2a94362f7bae8919e3074587b252b9">start</a> (<a class="el" href="class_ogre_1_1_scene_manager.html">SceneManager</a> *sceneManager)</td></tr>
+<tr class="memdesc:a6e2a94362f7bae8919e3074587b252b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts worker threads (job queue) so they start accepting work every time <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aaf595df16ab16cb9459154049bdd86d1">pushRequest()</a> gets called and will keep compiling those shaders until <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a" title="Signals worker threads we won&#39;t be submitting more work, so they should stop once they&#39;re done compil...">stopAndWait()</a> is called.  <a href="class_ogre_1_1_parallel_hlms_compile_queue.html#a6e2a94362f7bae8919e3074587b252b9">More...</a><br /></td></tr>
 <tr class="separator:a6e2a94362f7bae8919e3074587b252b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab6f85d23748cecb3d025f464a928bf2a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a">stopAndWait</a> (<a class="el" href="class_ogre_1_1_scene_manager.html">SceneManager</a> *sceneManager)</td></tr>
+<tr class="memdesc:ab6f85d23748cecb3d025f464a928bf2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals worker threads we won't be submitting more work, so they should stop once they're done compiling all pending shaders / PSOs.  <a href="class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a">More...</a><br /></td></tr>
 <tr class="separator:ab6f85d23748cecb3d025f464a928bf2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a7a6de65b48a5b5fd42858fd2459b2680"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a7a6de65b48a5b5fd42858fd2459b2680">updateThread</a> (size_t threadIdx, <a class="el" href="class_ogre_1_1_hlms_manager.html">HlmsManager</a> *hlmsManager)</td></tr>
+<tr class="memdesc:a7a6de65b48a5b5fd42858fd2459b2680"><td class="mdescLeft">&#160;</td><td class="mdescRight">The actual work done by the job queues.  <a href="class_ogre_1_1_parallel_hlms_compile_queue.html#a7a6de65b48a5b5fd42858fd2459b2680">More...</a><br /></td></tr>
 <tr class="separator:a7a6de65b48a5b5fd42858fd2459b2680"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a03a265cea3e505ec77e302b9fbae9bdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a03a265cea3e505ec77e302b9fbae9bdb">updateWarmUpThread</a> (size_t threadIdx, <a class="el" href="class_ogre_1_1_hlms_manager.html">HlmsManager</a> *hlmsManager, const <a class="el" href="struct_ogre_1_1_hlms_cache.html">HlmsCache</a> *passCaches)</td></tr>
+<tr class="memdesc:a03a265cea3e505ec77e302b9fbae9bdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The actual work done by <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a392eb4d02e34df8841097ac7be82b852" title="Similar to start() and stopAndWait() at the same time: It assumes all work has already been gathered ...">fireWarmUpParallel()</a>.  <a href="class_ogre_1_1_parallel_hlms_compile_queue.html#a03a265cea3e505ec77e302b9fbae9bdb">More...</a><br /></td></tr>
 <tr class="separator:a03a265cea3e505ec77e302b9fbae9bdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ad304fe38d2b602e9840ab2d33dacc788"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ad304fe38d2b602e9840ab2d33dacc788">warmUpSerial</a> (<a class="el" href="class_ogre_1_1_hlms_manager.html">HlmsManager</a> *hlmsManager, const <a class="el" href="struct_ogre_1_1_hlms_cache.html">HlmsCache</a> *passCaches)</td></tr>
+<tr class="memdesc:ad304fe38d2b602e9840ab2d33dacc788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serial alternative of <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a392eb4d02e34df8841097ac7be82b852" title="Similar to start() and stopAndWait() at the same time: It assumes all work has already been gathered ...">fireWarmUpParallel()</a> + <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a03a265cea3e505ec77e302b9fbae9bdb" title="The actual work done by fireWarmUpParallel().">updateWarmUpThread()</a> for when <a class="el" href="class_ogre_1_1_render_system.html#a5e64cf633bd9dfcea3bff39e447bac20" title="Returns true if RenderSystem supports multithreaded shader and PSO compilation.">RenderSystem::supportsMultithreadedShaderCompliation</a> is false.  <a href="class_ogre_1_1_parallel_hlms_compile_queue.html#ad304fe38d2b602e9840ab2d33dacc788">More...</a><br /></td></tr>
 <tr class="separator:ad304fe38d2b602e9840ab2d33dacc788"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
@@ -158,6 +164,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a392eb4d02e34df8841097ac7
       </table>
 </div><div class="memdoc">
 
+<p>Similar to <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a6e2a94362f7bae8919e3074587b252b9" title="Starts worker threads (job queue) so they start accepting work every time pushRequest() gets called a...">start()</a> and <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a" title="Signals worker threads we won&#39;t be submitting more work, so they should stop once they&#39;re done compil...">stopAndWait()</a> at the same time: It assumes all work has already been gathered in mRequests via <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aac24523f28c40d659b84f80d2a43fd95">pushWarmUpRequest()</a> (instead of gather it as we go) and fires all threads to compile the shaders and PSOs in parallel. </p>
+<p>It will wait until all threads are done. </p>
+
 </div>
 </div>
 <a id="aaf595df16ab16cb9459154049bdd86d1"></a>
@@ -230,6 +239,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6e2a94362f7bae8919e30745
       </table>
 </div><div class="memdoc">
 
+<p>Starts worker threads (job queue) so they start accepting work every time <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aaf595df16ab16cb9459154049bdd86d1">pushRequest()</a> gets called and will keep compiling those shaders until <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a" title="Signals worker threads we won&#39;t be submitting more work, so they should stop once they&#39;re done compil...">stopAndWait()</a> is called. </p>
+<p>The work is done in <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a7a6de65b48a5b5fd42858fd2459b2680" title="The actual work done by the job queues.">updateThread()</a> and is in charge of compiling shaders AND generating PSOs. </p><dl class="section remark"><dt>Remarks</dt><dd>This function must not be called if <a class="el" href="class_ogre_1_1_render_system.html#a5e64cf633bd9dfcea3bff39e447bac20" title="Returns true if RenderSystem supports multithreaded shader and PSO compilation.">RenderSystem::supportsMultithreadedShaderCompliation</a> is false. </dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">sceneManager</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 <a id="ab6f85d23748cecb3d025f464a928bf2a"></a>
@@ -248,6 +266,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab6f85d23748cecb3d025f464
       </table>
 </div><div class="memdoc">
 
+<p>Signals worker threads we won't be submitting more work, so they should stop once they're done compiling all pending shaders / PSOs. </p>
+<p>Will wait until all shaders are done. </p><dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">sceneManager</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 <a id="a7a6de65b48a5b5fd42858fd2459b2680"></a>
@@ -276,6 +302,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7a6de65b48a5b5fd42858fd2
       </table>
 </div><div class="memdoc">
 
+<p>The actual work done by the job queues. </p>
+
 </div>
 </div>
 <a id="a03a265cea3e505ec77e302b9fbae9bdb"></a>
@@ -310,6 +338,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a03a265cea3e505ec77e302b9
       </table>
 </div><div class="memdoc">
 
+<p>The actual work done by <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a392eb4d02e34df8841097ac7be82b852" title="Similar to start() and stopAndWait() at the same time: It assumes all work has already been gathered ...">fireWarmUpParallel()</a>. </p>
+
 </div>
 </div>
 <a id="ad304fe38d2b602e9840ab2d33dacc788"></a>
@@ -338,6 +368,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad304fe38d2b602e9840ab2d3
       </table>
 </div><div class="memdoc">
 
+<p>Serial alternative of <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a392eb4d02e34df8841097ac7be82b852" title="Similar to start() and stopAndWait() at the same time: It assumes all work has already been gathered ...">fireWarmUpParallel()</a> + <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a03a265cea3e505ec77e302b9fbae9bdb" title="The actual work done by fireWarmUpParallel().">updateWarmUpThread()</a> for when <a class="el" href="class_ogre_1_1_render_system.html#a5e64cf633bd9dfcea3bff39e447bac20" title="Returns true if RenderSystem supports multithreaded shader and PSO compilation.">RenderSystem::supportsMultithreadedShaderCompliation</a> is false. </p>
+
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>

api/latest/functions_c.html

@@ -881,7 +881,7 @@ <h3><a id="index_c"></a>- c -</h3><ul>
 </li>
 <li>colour
 : <a class="el" href="class_ogre_1_1v1_1_1_billboard_chain_1_1_element.html#a6d8fd40f0e4fa74963e628d6b152654c">Ogre::v1::BillboardChain::Element</a>
-, <a class="el" href="class_ogre_1_1v1_1_1_manual_object.html#a0b78d55494b11f535c513fd8cc64b5da">Ogre::v1::ManualObject</a>
+, <a class="el" href="class_ogre_1_1v1_1_1_manual_object.html#aec35d093b8cc51d9c1edf74b0bf6155b">Ogre::v1::ManualObject</a>
 </li>
 <li>Colour0
 : <a class="el" href="class_ogre_1_1_render_pass_descriptor.html#ae003dc630410b352f3e14668b7938254ac6494c572533b8d986293e55386a9e1c">Ogre::RenderPassDescriptor</a>

api/latest/functions_d.html

@@ -428,7 +428,7 @@ <h3><a id="index_d"></a>- d -</h3><ul>
 : <a class="el" href="class_ogre_1_1_convex_body.html#a9abd096ec64a6eedbd942a4f15ae4c34">Ogre::ConvexBody</a>
 </li>
 <li>Define()
-: <a class="el" href="class_ogre_1_1_c_preprocessor.html#a70c0a271d5ea9dcf93d13f9c08318458">Ogre::CPreprocessor</a>
+: <a class="el" href="class_ogre_1_1_c_preprocessor.html#a3026667d0f447d89bcac3fd8c6007a00">Ogre::CPreprocessor</a>
 </li>
 <li>define()
 : <a class="el" href="class_ogre_1_1v1_1_1_patch_mesh.html#aa270594ea025e8b6786cb5ea15183d75">Ogre::v1::PatchMesh</a>

api/latest/functions_func_d.html

@@ -361,10 +361,10 @@ <h3><a id="index_d"></a>- d -</h3><ul>
 : <a class="el" href="class_ogre_1_1_default_work_queue_base.html#ad8c782f13059f74607be6c01df9d10be">Ogre::DefaultWorkQueueBase</a>
 </li>
 <li>define()
-: <a class="el" href="class_ogre_1_1_convex_body.html#a9abd096ec64a6eedbd942a4f15ae4c34">Ogre::ConvexBody</a>
+: <a class="el" href="class_ogre_1_1_convex_body.html#af53cc9b7650fa12ba37fc3ed6b10736a">Ogre::ConvexBody</a>
 </li>
 <li>Define()
-: <a class="el" href="class_ogre_1_1_c_preprocessor.html#a3026667d0f447d89bcac3fd8c6007a00">Ogre::CPreprocessor</a>
+: <a class="el" href="class_ogre_1_1_c_preprocessor.html#a70c0a271d5ea9dcf93d13f9c08318458">Ogre::CPreprocessor</a>
 </li>
 <li>define()
 : <a class="el" href="class_ogre_1_1v1_1_1_patch_mesh.html#aa270594ea025e8b6786cb5ea15183d75">Ogre::v1::PatchMesh</a>

api/latest/functions_l.html

@@ -622,12 +622,12 @@ <h3><a id="index_l"></a>- l -</h3><ul>
 , <a class="el" href="class_ogre_1_1v1_1_1_edge_data.html#adf559492b955ae7f03a177e2a42d48b2">Ogre::v1::EdgeData</a>
 , <a class="el" href="class_ogre_1_1v1_1_1_edge_list_builder.html#ad319a0ee6ee198f07034055216493b61">Ogre::v1::EdgeListBuilder</a>
 </li>
-<li>Log2()
-: <a class="el" href="class_ogre_1_1_math.html#ac453f2205d3deb1c29aa9ef806b8a9ec">Ogre::Math</a>
-</li>
 <li>LOG2
 : <a class="el" href="class_ogre_1_1_math.html#ac2f6916aed097d695a0bffd4ca8a22dd">Ogre::Math</a>
 </li>
+<li>Log2()
+: <a class="el" href="class_ogre_1_1_math.html#ac453f2205d3deb1c29aa9ef806b8a9ec">Ogre::Math</a>
+</li>
 <li>logicalIndex
 : <a class="el" href="struct_ogre_1_1_gpu_constant_definition.html#a8579926ecde16841abf0d872689b672c">Ogre::GpuConstantDefinition</a>
 </li>

api/latest/functions_m.html

@@ -766,7 +766,7 @@ <h3><a id="index_m"></a>- m -</h3><ul>
 </li>
 <li>merge()
 : <a class="el" href="struct_ogre_1_1_aabb.html#a7ba3332a96f6c1c1c03fd9b5e14f8015">Ogre::Aabb</a>
-, <a class="el" href="class_ogre_1_1_array_aabb.html#a634edd8238e051c392b6d1e01a65b050">Ogre::ArrayAabb</a>
+, <a class="el" href="class_ogre_1_1_array_aabb.html#a7e166349561727c9661170ddbf5dba78">Ogre::ArrayAabb</a>
 , <a class="el" href="class_ogre_1_1_axis_aligned_box.html#a569d00c84979da765abfc66a64b25b68">Ogre::AxisAlignedBox</a>
 , <a class="el" href="class_ogre_1_1_sphere.html#a9e9104e8e57c2fa2d30920989c725d1a">Ogre::Sphere</a>
 , <a class="el" href="struct_ogre_1_1_t_rect.html#ae9c7c3a5d3b95ad159e65c9af9d7b173">Ogre::TRect&lt; T &gt;</a>
@@ -914,7 +914,7 @@ <h3><a id="index_m"></a>- m -</h3><ul>
 : <a class="el" href="struct_ogre_1_1_metal_device.html#ad8e3a62da0aa8f8ff31c516c95ffc94e">Ogre::MetalDevice</a>
 </li>
 <li>MetalDeviceItem()
-: <a class="el" href="class_ogre_1_1_metal_device_item.html#aff94284080ae3ec8be878f116fad96a9">Ogre::MetalDeviceItem</a>
+: <a class="el" href="class_ogre_1_1_metal_device_item.html#a8e4db63fb6884f976429c70f45390701">Ogre::MetalDeviceItem</a>
 </li>
 <li>MetalDiscardBuffer()
 : <a class="el" href="class_ogre_1_1_metal_discard_buffer.html#a353865cac81742d6be7a070a8bb4ec19">Ogre::MetalDiscardBuffer</a>

api/latest/functions_n.html

@@ -403,7 +403,7 @@ <h3><a id="index_n"></a>- n -</h3><ul>
 , <a class="el" href="class_ogre_1_1_vulkan_texture_gpu_window.html#a73d1e2dd9cc9bffa9338d038abc7248c">Ogre::VulkanTextureGpuWindow</a>
 </li>
 <li>notifyDestroyed()
-: <a class="el" href="class_ogre_1_1_compositor_node.html#a6e9edc7379e9c8759de9abb0baaf2135">Ogre::CompositorNode</a>
+: <a class="el" href="class_ogre_1_1_compositor_node.html#ae72f2d56524f23dc474d2634b06aeeeb">Ogre::CompositorNode</a>
 , <a class="el" href="class_ogre_1_1_compositor_pass.html#a9f7ab3e159808c63ff31ac799e476c66">Ogre::CompositorPass</a>
 </li>
 <li>notifyDeviceLost()

api/latest/functions_p.html

@@ -408,7 +408,7 @@ <h3><a id="index_p"></a>- p -</h3><ul>
 : <a class="el" href="struct_ogre_1_1_hlms_pso.html#a01d5b5734bfaa181540788babf7e64dd">Ogre::HlmsPso</a>
 </li>
 <li>Pass()
-: <a class="el" href="class_ogre_1_1_pass.html#a7f36f2c48b62fd29b2abdee4425d6a2c">Ogre::Pass</a>
+: <a class="el" href="class_ogre_1_1_pass.html#a2af67ca21bb1a91d6c228db8207384fc">Ogre::Pass</a>
 </li>
 <li>PassBits
 : <a class="el" href="struct_ogre_1_1_hlms_bits.html#a1c20ddc62968f4fa2bb4a43baa035423">Ogre::HlmsBits</a>
@@ -831,7 +831,7 @@ <h3><a id="index_p"></a>- p -</h3><ul>
 </li>
 <li>position
 : <a class="el" href="struct_ogre_1_1_lod_data_1_1_vertex.html#a4df65828c129283e5430d3c5df18d33d">Ogre::LodData::Vertex</a>
-, <a class="el" href="class_ogre_1_1_manual_object.html#a8b4d68a9227896fdf1ab39568ae57f89">Ogre::ManualObject</a>
+, <a class="el" href="class_ogre_1_1_manual_object.html#ab253d66699dcd555da4b404650b7f7a4">Ogre::ManualObject</a>
 </li>
 <li>Position
 : <a class="el" href="class_ogre_1_1_node_array_memory_manager.html#af49bbc12dc3106a2fc7b8f1761ac9f5fa1a7870e94d39b477ac50fa43460438e8">Ogre::NodeArrayMemoryManager</a>