Mirrors/bgfx
1
0
Fork 0
mirror of https://github.com/bkaradzic/bgfx.git synced 2026-02-18 21:13:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić
2016-02-23 20:47:30 -08:00
parent 2ca686bb0c
commit ff4606d429
6 changed files with 223 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

186
bgfx.html
View File

@@ -1499,6 +1499,109 @@ creating windows.</p>
</div>
<div class="section" id="miscellaneous">
<h3>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permalink to this headline"></a></h3>
<dl class="function">
<dt id="_CPPv2N4bgfx10vertexPackEKfbN6Attrib4EnumERK10VertexDeclPv8uint32_t">
<span id="bgfx::vertexPack__floatC.b.Attrib::Enum.VertexDeclCR.voidP.uint32_t"></span><span class="target" id="project0namespacebgfx_1af00c88a0daf27e1ddc43470a3e0f73ad"></span>void <code class="descclassname">bgfx::</code><code class="descname">vertexPack</code><span class="sig-paren">(</span><em class="property">const</em> float <em>_input</em>, bool <em>_inputNormalized</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attr</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<em>_decl</em>, void *<em>_data</em>, uint32_t <em>_index</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10vertexPackEKfbN6Attrib4EnumERK10VertexDeclPv8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Pack vec4 into vertex stream format. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_pack</span></code>. </dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx12vertexUnpackEfN6Attrib4EnumERK10VertexDeclPKv8uint32_t">
<span id="bgfx::vertexUnpack__float.Attrib::Enum.VertexDeclCR.voidCP.uint32_t"></span><span class="target" id="project0namespacebgfx_1a2407f7864d3303f18177f4b6ec1fbd08"></span>void <code class="descclassname">bgfx::</code><code class="descname">vertexUnpack</code><span class="sig-paren">(</span>float <em>_output</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attr</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<em>_decl</em>, <em class="property">const</em> void *<em>_data</em>, uint32_t <em>_index</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12vertexUnpackEfN6Attrib4EnumERK10VertexDeclPKv8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Unpack vec4 from vertex stream format. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_unpack</span></code>. </dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx13vertexConvertERK10VertexDeclPvRK10VertexDeclPKv8uint32_t">
<span id="bgfx::vertexConvert__VertexDeclCR.voidP.VertexDeclCR.voidCP.uint32_t"></span><span class="target" id="project0namespacebgfx_1af941804b071ee62fefc45e5d80787701"></span>void <code class="descclassname">bgfx::</code><code class="descname">vertexConvert</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<em>_destDecl</em>, void *<em>_destData</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<em>_srcDecl</em>, <em class="property">const</em> void *<em>_srcData</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13vertexConvertERK10VertexDeclPvRK10VertexDeclPKv8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Converts vertex stream data from one vertex stream format to another. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_convert</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_destDecl</span></code> - <p>Destination vertex stream declaration. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_destData</span></code> - <p>Destination vertex stream. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_srcDecl</span></code> - <p>Source vertex stream declaration. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_srcData</span></code> - <p>Source vertex stream data. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of vertices to convert from source to destination.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx12weldVerticesEP8uint16_tRK10VertexDeclPKv8uint16_tf">
<span id="bgfx::weldVertices__uint16_tP.VertexDeclCR.voidCP.uint16_t.float"></span><span class="target" id="project0namespacebgfx_1a487ee942fc5775ecd46a7cc48f9e3bb0"></span>uint16_t <code class="descclassname">bgfx::</code><code class="descname">weldVertices</code><span class="sig-paren">(</span>uint16_t *<em>_output</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<em>_decl</em>, <em class="property">const</em> void *<em>_data</em>, uint16_t <em>_num</em>, float <em>_epsilon</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12weldVerticesEP8uint16_tRK10VertexDeclPKv8uint16_tf" title="Permalink to this definition"></a></dt>
<dd><p>Weld vertices. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Number of unique vertices after vertex welding.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_weld_vertices</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_output</span></code> - <p>Welded vertices remapping table. The size of buffer must be the same as number of vertices. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex stream declaration. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Vertex stream. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of vertices in vertex stream. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_epsilon</span></code> - <p>Error tolerance for vertex position comparison. </p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx15topologyConvertEN15TopologyConvert4EnumEPv8uint32_tPKv8uint32_tb">
<span id="bgfx::topologyConvert__TopologyConvert::Enum.voidP.uint32_t.voidCP.uint32_t.b"></span><span class="target" id="project0namespacebgfx_1a4faf0379f4f649826fa82616a84a4b13"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">topologyConvert</code><span class="sig-paren">(</span>TopologyConvert::Enum <em>_conversion</em>, void *<em>_dst</em>, uint32_t <em>_dstSize</em>, <em class="property">const</em> void *<em>_indices</em>, uint32_t <em>_numIndices</em>, bool <em>_index32</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15topologyConvertEN15TopologyConvert4EnumEPv8uint32_tPKv8uint32_tb" title="Permalink to this definition"></a></dt>
<dd><p>Convert index buffer for use with different primitive topologies. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Number of output indices after conversion.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_topology_convert</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_conversion</span></code> - <p>Conversion type, see <code class="docutils literal"><span class="pre">TopologyConvert::Enum</span></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_dst</span></code> - <p>Destination index buffer. If this argument it NULL function will return number of indices after conversion. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_dstSize</span></code> - <p>Destination index buffer in bytes. It must be large enough to contain output indices. If destination size is insufficient index buffer will be truncated. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_indices</span></code> - <p>Source indices. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_numIndices</span></code> - <p>Number of input indices. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_index32</span></code> - <p>Set to <code class="docutils literal"><span class="pre">true</span></code> if input indices are 32-bit.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7discardEv">
<span id="bgfx::discard"></span><span class="target" id="project0namespacebgfx_1a0c43481c7f94a51e14842b3971e21c54"></span>void <code class="descclassname">bgfx::</code><code class="descname">discard</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7discardEv" title="Permalink to this definition"></a></dt>
@@ -2099,9 +2202,26 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</div>
<div class="section" id="buffers">
<h3>Buffers<a class="headerlink" href="#buffers" title="Permalink to this headline"></a></h3>
<dl class="function">
<dt id="_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle">
<span id="bgfx::setIndexBuffer__IndexBufferHandle"></span><span class="target" id="project0namespacebgfx_1a788bf7feee1fd76127e628fcc0e879d4"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle" title="Permalink to this definition"></a></dt>
<dd><p>Set index buffer for draw primitive. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_index_buffer</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Index buffer.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t">
<span id="bgfx::setIndexBuffer__IndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1adce84edbab8794d9979476ccecc797aa"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition"></a></dt>
<span id="bgfx::setIndexBuffer__IndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1a557d08e2d163054e7642206ac00b6724"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Set index buffer for draw primitive. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
@@ -2121,19 +2241,15 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t">
<span id="bgfx::setIndexBuffer__DynamicIndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1ad5aa3d6a895bb2963df4d04426584543"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle">
<span id="bgfx::setIndexBuffer__DynamicIndexBufferHandle"></span><span class="target" id="project0namespacebgfx_1abdf5b7249100abcb08ec8195e65bbb66"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle" title="Permalink to this definition"></a></dt>
<dd><p>Set index buffer for draw primitive. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_dynamic_index_buffer</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic index buffer. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_firstIndex</span></code> - <p>First index to render. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_numIndices</span></code> - <p>Number of indices to render.</p>
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic index buffer.</p>
</li>
</ul>
</dd>
@@ -2142,15 +2258,15 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1a1ff04459d5f92944634903ab4bdfe8bc"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientIndexBuffer *<em>_tib</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t">
<span id="bgfx::setIndexBuffer__DynamicIndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1a97f7ff081c65d9d14bab89286dacc8c2"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Set index buffer for draw primitive. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transient_index_buffer</span></code>. </dd>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_dynamic_index_buffer</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_tib</span></code> - <p>Transient index buffer. </p>
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic index buffer. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_firstIndex</span></code> - <p>First index to render. </p>
</li>
@@ -2179,6 +2295,27 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1a1ff04459d5f92944634903ab4bdfe8bc"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientIndexBuffer *<em>_tib</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Set index buffer for draw primitive. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transient_index_buffer</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_tib</span></code> - <p>Transient index buffer. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_firstIndex</span></code> - <p>First index to render. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_numIndices</span></code> - <p>Number of indices to render.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle">
<span id="bgfx::setVertexBuffer__VertexBufferHandle"></span><span class="target" id="project0namespacebgfx_1a641a1e05d472617461413faf67b3705f"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle" title="Permalink to this definition"></a></dt>
@@ -2218,8 +2355,25 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_t">
<span id="bgfx::setVertexBuffer__DynamicVertexBufferHandle.uint32_t"></span><span class="target" id="project0namespacebgfx_1a8f0fd5ff0b80aa3f4ffcedad7b39130a"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_t" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle">
<span id="bgfx::setVertexBuffer__DynamicVertexBufferHandle"></span><span class="target" id="project0namespacebgfx_1a851ec1c38d446e0ad97cc2cbecccfde6"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle" title="Permalink to this definition"></a></dt>
<dd><p>Set vertex buffer for draw primitive. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_dynamic_vertex_buffer</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic vertex buffer.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t">
<span id="bgfx::setVertexBuffer__DynamicVertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1a526691fc5de0086bbad5f44e55a8354a"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Set vertex buffer for draw primitive. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
@@ -2228,6 +2382,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic vertex buffer. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_startVertex</span></code> - <p>First vertex to render. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_numVertices</span></code> - <p>Number of vertices to render.</p>
</li>
</ul>
@@ -4358,7 +4514,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_side</span></code> - <p>Cubemap side, where 0 is +X, 1 is -X, 2 is +Y, 3 is -Y, 4 is +Z, and 5 is -Z. <div class="highlight-python"><div class="highlight"><pre> +----------+
<li><code class="first docutils literal"><span class="pre">_side</span></code> - <p>Cubemap side <code class="docutils literal"><span class="pre">BGFX_CUBE_MAP_&lt;POSITIVE</span> <span class="pre">or</span> <span class="pre">NEGATIVE&gt;_&lt;X,</span> <span class="pre">Y</span> <span class="pre">or</span> <span class="pre">Z&gt;</span></code>, where 0 is +X, 1 is -X, 2 is +Y, 3 is -Y, 4 is +Z, and 5 is -Z. <div class="highlight-python"><div class="highlight"><pre> +----------+
|-z 2|
| ^ +y |
| | |

6
build.html
View File

@@ -332,6 +332,12 @@ setx ANDROID_NDK_MIPS &lt;path to AndroidNDK directory&gt;\toolchains\mipsel-lin
setx ANDROID_NDK_X86 &lt;path to AndroidNDK directory&gt;\toolchains\x86-4.7\prebuilt\windows-x86_64
</pre></div>
</div>
<p>To deploy on Android you can use bgfx android activity:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://github.com/Nodrev/bgfx-android-activity#bgfx-android-activity---android-glue-for-bgfx">https://github.com/Nodrev/bgfx-android-activity#bgfx-android-activity&#8212;android-glue-for-bgfx</a></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline"></a></h3>

28
genindex.html
View File

@@ -832,7 +832,7 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t">bgfx::setIndexBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer">[2]</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">[3]</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle">bgfx::setIndexBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle">[2]</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t">[3]</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer">[4]</a>, <a href="bgfx.html#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">[5]</a>
</dt>
@@ -872,7 +872,7 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle">bgfx::setVertexBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle8uint32_t8uint32_t">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_t">[2]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer">[3]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer8uint32_t8uint32_t">[4]</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle">bgfx::setVertexBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle8uint32_t8uint32_t">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle">[2]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t">[3]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer">[4]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer8uint32_t8uint32_t">[5]</a>
</dt>
@@ -923,8 +923,6 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats10cpuTimeEndE">bgfx::Stats::cpuTimeEnd (C++ member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimerFreqE">bgfx::Stats::cpuTimerFreq (C++ member)</a>
</dt>
@@ -937,6 +935,8 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats10gpuTimeEndE">bgfx::Stats::gpuTimeEnd (C++ member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12gpuTimerFreqE">bgfx::Stats::gpuTimerFreq (C++ member)</a>
</dt>
@@ -1246,6 +1246,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx15topologyConvertEN15TopologyConvert4EnumEPv8uint32_tPKv8uint32_tb">bgfx::topologyConvert (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx5touchE7uint8_t">bgfx::touch (C++ function)</a>
</dt>
@@ -1302,6 +1306,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx13vertexConvertERK10VertexDeclPvRK10VertexDeclPKv8uint32_t">bgfx::vertexConvert (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx10VertexDeclE">bgfx::VertexDecl (C++ class)</a>
</dt>
@@ -1342,6 +1350,18 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx10vertexPackEKfbN6Attrib4EnumERK10VertexDeclPv8uint32_t">bgfx::vertexPack (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx12vertexUnpackEfN6Attrib4EnumERK10VertexDeclPKv8uint32_t">bgfx::vertexUnpack (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx12weldVerticesEP8uint16_tRK10VertexDeclPKv8uint16_tf">bgfx::weldVertices (C++ function)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_CAPS_BLEND_INDEPENDENT">BGFX_CAPS_BLEND_INDEPENDENT (C macro)</a>
</dt>

BIN
objects.inv
View File

Binary file not shown.

28
overview.html
View File

@@ -327,6 +327,7 @@ licensed under permissive BSD-2 clause open source license.</p>
<li>Native Client (PPAPI 37+, ARM, x86, x64, PNaCl)</li>
<li>OSX (10.9+)</li>
<li>RaspberryPi</li>
<li>SteamLink</li>
<li>Windows (XP, Vista, 7, 8, 10)</li>
<li>WinRT (WinPhone 8.0+)</li>
</ul>
@@ -434,15 +435,16 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<h3>Other Debuggers and Profilers<a class="headerlink" href="#other-debuggers-and-profilers" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="21%" />
<col width="9%" />
<col width="10%" />
<col width="15%" />
<col width="20%" />
<col width="8%" />
<col width="9%" />
<col width="7%" />
<col width="8%" />
<col width="10%" />
<col width="10%" />
<col width="7%" />
<col width="7%" />
<col width="8%" />
<col width="9%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -453,6 +455,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<th class="head">Metal</th>
<th class="head">GL</th>
<th class="head">GLES</th>
<th class="head">Vulkan</th>
<th class="head">Source</th>
</tr>
</thead>
@@ -465,6 +468,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>&nbsp;</td>
<td>✓</td>
<td>✓</td>
<td>&nbsp;</td>
<td>✓</td>
</tr>
<tr class="row-odd"><td>CodeXL</td>
@@ -476,6 +480,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>✓</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>Dissector</td>
<td>Win</td>
@@ -485,6 +490,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>✓</td>
</tr>
<tr class="row-odd"><td>PerfStudio</td>
@@ -496,6 +502,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>✓</td>
<td>✓</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>IntelGPA</td>
<td>Linux/OSX/Win</td>
@@ -506,6 +513,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>&nbsp;</td>
<td>✓</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>Nsight</td>
<td>Win</td>
@@ -516,6 +524,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>✓</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td>PerfHUD</td>
<td>Win</td>
@@ -526,9 +535,10 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td>RenderDoc</td>
<td>Win</td>
<td>Win/Linux</td>
<td>&nbsp;</td>
<td>✓</td>
<td>&nbsp;</td>
@@ -536,6 +546,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>✓</td>
<td>&nbsp;</td>
<td>✓</td>
<td>✓</td>
</tr>
<tr class="row-even"><td>vogl</td>
<td>Linux</td>
@@ -545,6 +556,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<td>&nbsp;</td>
<td>✓</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>✓</td>
</tr>
</tbody>
@@ -555,6 +567,7 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
<li><a class="reference external" href="http://developer.amd.com/tools-and-sdks/opencl-zone/codexl/">CodeXL</a></li>
<li><a class="reference external" href="https://github.com/imccown/Dissector">Dissector</a></li>
<li><a class="reference external" href="http://developer.amd.com/tools-and-sdks/graphics-development/gpu-perfstudio/">GPU PerfStudio</a></li>
<li><a class="reference external" href="https://developer.nvidia.com/linux-graphics-debugger">Linux Graphics Debugger</a></li>
<li><a class="reference external" href="https://developer.nvidia.com/nvidia-nsight-visual-studio-edition">Nsight</a></li>
<li><a class="reference external" href="https://developer.nvidia.com/nvidia-perfhud">PerfHUD</a></li>
<li><a class="reference external" href="https://github.com/ValveSoftware/vogl">vogl</a></li>
@@ -652,6 +665,7 @@ handling.</li>
<li>Andrew Mac (<a class="reference external" href="https://github.com/andr3wmac">&#64;andr3wmac</a>) - 27-terrain.</li>
<li>Oliver Charles (<a class="reference external" href="https://github.com/ocharles">&#64;ocharles</a>) - Haskel language API bindings.</li>
<li>Johan Sköld (<a class="reference external" href="https://github.com/rhoot">&#64;rhoot</a>) - Rust language API bindings.</li>
<li>Jean-François Verdon (<a class="reference external" href="https://github.com/Nodrev">&#64;Nodrev</a>) - Alternative deployment for Android.</li>
</ul>
</div></blockquote>
</div>

2
searchindex.js
View File

File diff suppressed because one or more lines are too long