Updated docs.

bgfx.html

@@ -4725,26 +4725,46 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
 <div class="section" id="dispatch">
 <h4>Dispatch<a class="headerlink" href="#dispatch" title="Permalink to this headline">¶</a></h4>
 <p>Within view all compute commands are dispatched after blit commands, and before draw commands.</p>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>doxygenfunction: Unable to resolve multiple matches for function “bgfx::dispatch” with arguments (ViewId, ProgramHandle, uint32_t, uint32_t, uint32_t) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
-Potential matches:
+<dl class="function">
+<dt id="_CPPv4N4bgfx8dispatchE6ViewId13ProgramHandle8uint32_t8uint32_t8uint32_t7uint8_t">
+<span id="_CPPv3N4bgfx8dispatchE6ViewId13ProgramHandle8uint32_t8uint32_t8uint32_t7uint8_t"></span><span id="_CPPv2N4bgfx8dispatchE6ViewId13ProgramHandle8uint32_t8uint32_t8uint32_t7uint8_t"></span><span id="bgfx::dispatch__ViewId.ProgramHandle.uint32_t.uint32_t.uint32_t.uint8_t"></span><span class="target" id="namespacebgfx_1a3f99f5af2f277674422b56e60b5d8a91"></span>void <code class="sig-prename descclassname">bgfx<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">dispatch</code><span class="sig-paren">(</span>ViewId <em>_id</em>, ProgramHandle <em>_handle</em>, uint32_t <em>_numX</em> = 1, uint32_t <em>_numY</em> = 1, uint32_t <em>_numZ</em> = 1, uint8_t <em>_flags</em> = BGFX_DISCARD_ALL<span class="sig-paren">)</span><br /></dt>
+<dd><p>Dispatch compute. </p>
+<p><dl class="simple">
+<dt><strong>Attention</strong></dt><dd><p>C99 equivalent is <code class="docutils literal notranslate"><span class="pre">bgfx_dispatch</span></code>. </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_id</span></code>: View id. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_handle</span></code>: Compute program. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numX</span></code>: Number of groups X. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numY</span></code>: Number of groups Y. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numZ</span></code>: Number of groups Z. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_flags</span></code>: Discard or preserve states. See <code class="docutils literal notranslate"><span class="pre">BGFX_DISCARD_*</span></code>.</p></li>
+</ul>
+</dd>
+</dl>
 </p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span> <span class="n">void</span> <span class="n">bgfx</span><span class="p">::</span><span class="n">dispatch</span><span class="p">(</span><span class="n">ViewId</span><span class="p">,</span> <span class="n">ProgramHandle</span><span class="p">,</span> <span class="n">IndirectBufferHandle</span><span class="p">,</span> <span class="n">uint16_t</span><span class="p">,</span> <span class="n">uint16_t</span><span class="p">,</span> <span class="n">uint8_t</span><span class="p">)</span>
-<span class="o">-</span> <span class="n">void</span> <span class="n">bgfx</span><span class="p">::</span><span class="n">dispatch</span><span class="p">(</span><span class="n">ViewId</span><span class="p">,</span> <span class="n">ProgramHandle</span><span class="p">,</span> <span class="n">uint32_t</span><span class="p">,</span> <span class="n">uint32_t</span><span class="p">,</span> <span class="n">uint32_t</span><span class="p">,</span> <span class="n">uint8_t</span><span class="p">)</span>
-</pre></div>
-</div>
-</div>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>doxygenfunction: Unable to resolve multiple matches for function “bgfx::dispatch” with arguments (ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
-Potential matches:
+</dd></dl>
+
+<dl class="function">
+<dt id="_CPPv4N4bgfx8dispatchE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7uint8_t">
+<span id="_CPPv3N4bgfx8dispatchE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7uint8_t"></span><span id="_CPPv2N4bgfx8dispatchE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7uint8_t"></span><span id="bgfx::dispatch__ViewId.ProgramHandle.IndirectBufferHandle.uint16_t.uint16_t.uint8_t"></span><span class="target" id="namespacebgfx_1a67c9b630c2b48baf101c66fc64aa5919"></span>void <code class="sig-prename descclassname">bgfx<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">dispatch</code><span class="sig-paren">(</span>ViewId <em>_id</em>, ProgramHandle <em>_handle</em>, IndirectBufferHandle <em>_indirectHandle</em>, uint16_t <em>_start</em> = 0, uint16_t <em>_num</em> = 1, uint8_t <em>_flags</em> = BGFX_DISCARD_ALL<span class="sig-paren">)</span><br /></dt>
+<dd><p>Dispatch compute indirect. </p>
+<p><dl class="simple">
+<dt><strong>Attention</strong></dt><dd><p>C99 equivalent is <code class="docutils literal notranslate"><span class="pre">bgfx_dispatch_indirect</span></code>. </p>
+</dd>
+<dt><strong>Parameters</strong></dt><dd><ul class="breatheparameterlist simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_id</span></code>: View id. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_handle</span></code>: Compute program. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_indirectHandle</span></code>: Indirect buffer. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_start</span></code>: First element in indirect buffer. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_num</span></code>: Number of dispatches. </p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_flags</span></code>: Discard or preserve states. See <code class="docutils literal notranslate"><span class="pre">BGFX_DISCARD_*</span></code>.</p></li>
+</ul>
+</dd>
+</dl>
 </p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span> <span class="n">void</span> <span class="n">bgfx</span><span class="p">::</span><span class="n">dispatch</span><span class="p">(</span><span class="n">ViewId</span><span class="p">,</span> <span class="n">ProgramHandle</span><span class="p">,</span> <span class="n">IndirectBufferHandle</span><span class="p">,</span> <span class="n">uint16_t</span><span class="p">,</span> <span class="n">uint16_t</span><span class="p">,</span> <span class="n">uint8_t</span><span class="p">)</span>
-<span class="o">-</span> <span class="n">void</span> <span class="n">bgfx</span><span class="p">::</span><span class="n">dispatch</span><span class="p">(</span><span class="n">ViewId</span><span class="p">,</span> <span class="n">ProgramHandle</span><span class="p">,</span> <span class="n">uint32_t</span><span class="p">,</span> <span class="n">uint32_t</span><span class="p">,</span> <span class="n">uint32_t</span><span class="p">,</span> <span class="n">uint8_t</span><span class="p">)</span>
-</pre></div>
-</div>
-</div>
+</dd></dl>
+
 </div>
 </div>
 <div class="section" id="blit">

genindex.html

@@ -408,6 +408,8 @@
       <li><a href="bgfx.html#_CPPv4N4bgfx7destroyE12ShaderHandle">bgfx::destroy (C++ function)</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE13ProgramHandle">[1]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE13TextureHandle">[2]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE13UniformHandle">[3]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE17FrameBufferHandle">[4]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE17IndexBufferHandle">[5]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE18VertexBufferHandle">[6]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE18VertexLayoutHandle">[7]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE20IndirectBufferHandle">[8]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE20OcclusionQueryHandle">[9]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE24DynamicIndexBufferHandle">[10]</a>, <a href="bgfx.html#_CPPv4N4bgfx7destroyE25DynamicVertexBufferHandle">[11]</a>
 </li>
       <li><a href="bgfx.html#_CPPv4N4bgfx7discardE7uint8_t">bgfx::discard (C++ function)</a>
+</li>
+      <li><a href="bgfx.html#_CPPv4N4bgfx8dispatchE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7uint8_t">bgfx::dispatch (C++ function)</a>, <a href="bgfx.html#_CPPv4N4bgfx8dispatchE6ViewId13ProgramHandle8uint32_t8uint32_t8uint32_t7uint8_t">[1]</a>
 </li>
       <li><a href="bgfx.html#_CPPv4N4bgfx7EncoderE">bgfx::Encoder (C++ class)</a>
 </li>