Updated docs.

This commit is contained in:
Branimir Karadžić
2015-11-02 21:29:43 -08:00
parent 4ae556685f
commit dcf7f90681
4 changed files with 26 additions and 12 deletions

View File

@@ -2239,17 +2239,31 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</p>
</dd></dl>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>doxygenfunction: Unable to resolve multiple matches for function &#8220;bgfx::submit&#8221; with arguments (uint8_t, ProgramHandle, OcclusionQueryHandle, int32_t)) in doxygen xml output for project &#8220;project0&#8221; from directory: ../../.build/docs/xml.
Potential matches:
<dl class="function">
<dt id="_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20OcclusionQueryHandle7int32_t">
<span id="bgfx::submit__uint8_t.ProgramHandle.OcclusionQueryHandle.int32_t"></span><span class="target" id="project0namespacebgfx_1a7c6e4bbf09c47a2d6dbf77568436cb0a"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">submit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_program</em>, OcclusionQueryHandle <em>_occlusionQuery</em>, int32_t <em>_depth</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20OcclusionQueryHandle7int32_t" title="Permalink to this definition"></a></dt>
<dd><p>Submit primitive with occlusion query for rendering. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Number of draw calls.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is `bgfx_submit_occlusion_query. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_program</span></code> - <p>Program. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_occlusionQuery</span></code> - <p>Occlusion query. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>Depth for sorting. </p>
</li>
</ul>
</dd>
</dl>
</p>
<pre class="last literal-block">
- uint32_t bgfx::submit(uint8_t, ProgramHandle, int32_t)
- uint32_t bgfx::submit(uint8_t, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t, int32_t)
- uint32_t bgfx::submit(uint8_t, ProgramHandle, OcclusionQueryHandle, int32_t)
</pre>
</div>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7int32_t">
<span id="bgfx::submit__uint8_t.ProgramHandle.IndirectBufferHandle.uint16_t.uint16_t.int32_t"></span><span class="target" id="project0namespacebgfx_1a549c8c0042a1fb8260bef06aded173a0"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">submit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_program</em>, IndirectBufferHandle <em>_indirectHandle</em>, uint16_t <em>_start</em>, uint16_t <em>_num</em>, int32_t <em>_depth</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7int32_t" title="Permalink to this definition"></a></dt>

View File

@@ -905,7 +905,7 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7int32_t">bgfx::submit (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle7int32_t">[1]</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7int32_t">bgfx::submit (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20OcclusionQueryHandle7int32_t">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle7int32_t">[2]</a>
</dt>

Binary file not shown.

File diff suppressed because one or more lines are too long