Skip to content

Commit

Permalink
Deploy GH
Browse files Browse the repository at this point in the history
  • Loading branch information
darksylinc@users.noreply.github.com committed Feb 5, 2025
1 parent af356ee commit d86ffb4
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
<tr class="odd"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ae38048ebb76edabb33f61e0745d796d0">ParallelHlmsCompileQueue</a>()</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aaf595df16ab16cb9459154049bdd86d1">pushRequest</a>(const Request &amp;&amp;request)</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#aac24523f28c40d659b84f80d2a43fd95">pushWarmUpRequest</a>(const Request &amp;&amp;request)</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a6e2a94362f7bae8919e3074587b252b9">start</a>(SceneManager *sceneManager)</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a5f58298ed8a892fdf0bc4dfa0a936281">start</a>(SceneManager *sceneManager, bool casterPass)</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a">stopAndWait</a>(SceneManager *sceneManager)</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a7a6de65b48a5b5fd42858fd2459b2680">updateThread</a>(size_t threadIdx, HlmsManager *hlmsManager)</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a03a265cea3e505ec77e302b9fbae9bdb">updateWarmUpThread</a>(size_t threadIdx, HlmsManager *hlmsManager, const HlmsCache *passCaches)</td><td class="entry"><a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html">Ogre::ParallelHlmsCompileQueue</a></td><td class="entry"></td></tr>
Expand Down
26 changes: 18 additions & 8 deletions api/latest/class_ogre_1_1_parallel_hlms_compile_queue.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,15 @@
<tr class="memitem:ae38048ebb76edabb33f61e0745d796d0" id="r_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" id="r_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. <br /></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#a5f58298ed8a892fdf0bc4dfa0a936281" 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. <br /></td></tr>
<tr class="separator:a392eb4d02e34df8841097ac7be82b852"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf595df16ab16cb9459154049bdd86d1" id="r_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" id="r_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" id="r_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. <br /></td></tr>
<tr class="separator:a6e2a94362f7bae8919e3074587b252b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f58298ed8a892fdf0bc4dfa0a936281" id="r_a5f58298ed8a892fdf0bc4dfa0a936281"><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#a5f58298ed8a892fdf0bc4dfa0a936281">start</a> (<a class="el" href="class_ogre_1_1_scene_manager.html">SceneManager</a> *sceneManager, bool casterPass)</td></tr>
<tr class="memdesc:a5f58298ed8a892fdf0bc4dfa0a936281"><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. <br /></td></tr>
<tr class="separator:a5f58298ed8a892fdf0bc4dfa0a936281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6f85d23748cecb3d025f464a928bf2a" id="r_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. <br /></td></tr>
<tr class="separator:ab6f85d23748cecb3d025f464a928bf2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -170,7 +170,7 @@ <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>Similar to <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a5f58298ed8a892fdf0bc4dfa0a936281" 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>
Expand Down Expand Up @@ -231,8 +231,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#aac24523f28c40d659b84f80d

</div>
</div>
<a id="a6e2a94362f7bae8919e3074587b252b9" name="a6e2a94362f7bae8919e3074587b252b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e2a94362f7bae8919e3074587b252b9">&#9670;&#160;</a></span>start()</h2>
<a id="a5f58298ed8a892fdf0bc4dfa0a936281" name="a5f58298ed8a892fdf0bc4dfa0a936281"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f58298ed8a892fdf0bc4dfa0a936281">&#9670;&#160;</a></span>start()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -241,8 +241,18 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6e2a94362f7bae8919e30745
<td class="memname">void Ogre::ParallelHlmsCompileQueue::start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_ogre_1_1_scene_manager.html">SceneManager</a> *&#160;</td>
<td class="paramname"><em>sceneManager</em></td><td>)</td>
<td class="paramname"><em>sceneManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>casterPass</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
Expand Down
2 changes: 1 addition & 1 deletion api/latest/class_ogre_1_1_parallel_hlms_compile_queue.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ var class_ogre_1_1_parallel_hlms_compile_queue =
[ "fireWarmUpParallel", "class_ogre_1_1_parallel_hlms_compile_queue.html#a392eb4d02e34df8841097ac7be82b852", null ],
[ "pushRequest", "class_ogre_1_1_parallel_hlms_compile_queue.html#aaf595df16ab16cb9459154049bdd86d1", null ],
[ "pushWarmUpRequest", "class_ogre_1_1_parallel_hlms_compile_queue.html#aac24523f28c40d659b84f80d2a43fd95", null ],
[ "start", "class_ogre_1_1_parallel_hlms_compile_queue.html#a6e2a94362f7bae8919e3074587b252b9", null ],
[ "start", "class_ogre_1_1_parallel_hlms_compile_queue.html#a5f58298ed8a892fdf0bc4dfa0a936281", null ],
[ "stopAndWait", "class_ogre_1_1_parallel_hlms_compile_queue.html#ab6f85d23748cecb3d025f464a928bf2a", null ],
[ "updateThread", "class_ogre_1_1_parallel_hlms_compile_queue.html#a7a6de65b48a5b5fd42858fd2459b2680", null ],
[ "updateWarmUpThread", "class_ogre_1_1_parallel_hlms_compile_queue.html#a03a265cea3e505ec77e302b9fbae9bdb", null ],
Expand Down
2 changes: 1 addition & 1 deletion api/latest/functions_func_s.html
Original file line number Diff line number Diff line change
Expand Up @@ -1177,7 +1177,7 @@ <h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>StagingTextureManager()&#160;:&#160;<a class="el" href="class_ogre_1_1_staging_texture_manager.html#a08032f5765443d5c35d413dd8a8e5849">Ogre::StagingTextureManager</a></li>
<li>stall()&#160;:&#160;<a class="el" href="struct_ogre_1_1_metal_device.html#ac370d0d6d7539e4e31187c7d33c27961">Ogre::MetalDevice</a>, <a class="el" href="struct_ogre_1_1_vulkan_device.html#a9052e6d3cb9531fcea410cdce25e16f9">Ogre::VulkanDevice</a></li>
<li>standardisePath()&#160;:&#160;<a class="el" href="class_ogre_1_1_string_util.html#ab936109efdb3b4f224cdddbb37704cd0">Ogre::StringUtil</a></li>
<li>start()&#160;:&#160;<a class="el" href="class_ogre_1_1_e_g_l_g_l_support.html#a0697a85c9916e6f380e3d235993ec08f">Ogre::EGLGLSupport</a>, <a class="el" href="class_ogre_1_1_egl_p_buffer_support.html#a93b42683ff274d8cb6663b7fb2064901">Ogre::EglPBufferSupport</a>, <a class="el" href="class_ogre_1_1_e_g_l_support.html#a2d5b0535c16be8714ad0885b16704c0c">Ogre::EGLSupport</a>, <a class="el" href="class_ogre_1_1_g_l3_plus_support.html#a78d090a0e8e44d68594a8c4155cbf430">Ogre::GL3PlusSupport</a>, <a class="el" href="class_ogre_1_1_g_l_e_s2_support.html#af1f839cc740a061bc17999ecca76e0a2">Ogre::GLES2Support</a>, <a class="el" href="class_ogre_1_1_gl_switchable_support.html#a74eea3fbd9ea068ff6dd4c7b2a39256c">Ogre::GlSwitchableSupport</a>, <a class="el" href="class_ogre_1_1_g_l_x_g_l_support.html#a31a7c5f8dc894c733f2a9bbc2cc15fa1">Ogre::GLXGLSupport</a>, <a class="el" href="class_ogre_1_1_o_s_x_g_l3_plus_support.html#a2341ccd57e89aa77c7f90838d390b1b6">Ogre::OSXGL3PlusSupport</a>, <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a6e2a94362f7bae8919e3074587b252b9">Ogre::ParallelHlmsCompileQueue</a>, <a class="el" href="class_ogre_1_1_win32_g_l_support.html#a380050379cd51b034d824652f38cf31e">Ogre::Win32GLSupport</a></li>
<li>start()&#160;:&#160;<a class="el" href="class_ogre_1_1_e_g_l_g_l_support.html#a0697a85c9916e6f380e3d235993ec08f">Ogre::EGLGLSupport</a>, <a class="el" href="class_ogre_1_1_egl_p_buffer_support.html#a93b42683ff274d8cb6663b7fb2064901">Ogre::EglPBufferSupport</a>, <a class="el" href="class_ogre_1_1_e_g_l_support.html#a2d5b0535c16be8714ad0885b16704c0c">Ogre::EGLSupport</a>, <a class="el" href="class_ogre_1_1_g_l3_plus_support.html#a78d090a0e8e44d68594a8c4155cbf430">Ogre::GL3PlusSupport</a>, <a class="el" href="class_ogre_1_1_g_l_e_s2_support.html#af1f839cc740a061bc17999ecca76e0a2">Ogre::GLES2Support</a>, <a class="el" href="class_ogre_1_1_gl_switchable_support.html#a74eea3fbd9ea068ff6dd4c7b2a39256c">Ogre::GlSwitchableSupport</a>, <a class="el" href="class_ogre_1_1_g_l_x_g_l_support.html#a31a7c5f8dc894c733f2a9bbc2cc15fa1">Ogre::GLXGLSupport</a>, <a class="el" href="class_ogre_1_1_o_s_x_g_l3_plus_support.html#a2341ccd57e89aa77c7f90838d390b1b6">Ogre::OSXGL3PlusSupport</a>, <a class="el" href="class_ogre_1_1_parallel_hlms_compile_queue.html#a5f58298ed8a892fdf0bc4dfa0a936281">Ogre::ParallelHlmsCompileQueue</a>, <a class="el" href="class_ogre_1_1_win32_g_l_support.html#a380050379cd51b034d824652f38cf31e">Ogre::Win32GLSupport</a></li>
<li>startDeflate()&#160;:&#160;<a class="el" href="class_ogre_1_1_stream_serialiser.html#aa9c4b6be63560e6f2ab0b647fe797175">Ogre::StreamSerialiser</a></li>
<li>startGpuDebuggerFrameCapture()&#160;:&#160;<a class="el" href="class_ogre_1_1_render_system.html#afe7705e26f10dccebf2e6db0b3d6859e">Ogre::RenderSystem</a></li>
<li>startMapRegion()&#160;:&#160;<a class="el" href="class_ogre_1_1_d3_d11_staging_texture.html#ad6bb2b8856e79260d691991fbccd0d1b">Ogre::D3D11StagingTexture</a>, <a class="el" href="class_ogre_1_1_g_l3_plus_staging_texture.html#afe825cd5e2312ffbc5ef503151e9bd77">Ogre::GL3PlusStagingTexture</a>, <a class="el" href="class_ogre_1_1_staging_texture.html#af5c5ae43d118dd5db9ac65ca65a5e75e">Ogre::StagingTexture</a>, <a class="el" href="class_ogre_1_1_staging_texture_buffer_impl.html#ad2f3c66603fc7e844e0b45c52b1ca5ef">Ogre::StagingTextureBufferImpl</a>, <a class="el" href="class_ogre_1_1_vulkan_staging_texture.html#a2c573cac40239aaf12890ddd316514f6">Ogre::VulkanStagingTexture</a></li>
Expand Down
Loading

0 comments on commit d86ffb4

Please sign in to comment.