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

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić
2018-06-09 17:30:45 -07:00
parent 1d3e33ea5a
commit 2dfd3b46f6
5 changed files with 42 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
bgfx.html
View File

@@ -2015,6 +2015,12 @@ creating windows.</p>
<dd><p>Flip winding order of triangle list. </p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv2N4bgfx15TopologyConvert19TriStripFlipWindingE">
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153ab15cde16196aa72a0fe0bad4f389669d"></span><code class="descname">TriStripFlipWinding</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert19TriStripFlipWindingE" title="Permalink to this definition"></a></dt>
<dd><p>Flip winding order of trinagle strip. </p>
</dd></dl>
<dl class="enumerator">
<dt id="_CPPv2N4bgfx15TopologyConvert17TriListToLineListE">
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153a0cf4dc87b95b89d5633e151a286aaeb1"></span><code class="descname">TriListToLineList</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert17TriListToLineListE" title="Permalink to this definition"></a></dt>
@@ -2984,6 +2990,24 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7Encoder14setVertexCountE8uint32_t">
<span id="bgfx::Encoder::setVertexCount__uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a6bec8d7a72516210170abcd6b1fd98aa"></span>void <code class="descname">setVertexCount</code><span class="sig-paren">(</span>uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setVertexCountE8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Set number of vertices for auto generated vertices use in conjuction with gl_VertexID. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ID</span></code>. </dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_vertex_count</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices.</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer">
<span id="bgfx::Encoder::setInstanceDataBuffer__InstanceDataBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1afadc5fbe3874159961d5552220328622"></span>void <code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> InstanceDataBuffer *<em>_idb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer" title="Permalink to this definition"></a></dt>
@@ -5047,8 +5071,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx25updateDynamicVertexBufferE25DynamicVertexBufferHandle8uint32_tPK6Memory">
<span id="bgfx::updateDynamicVertexBuffer__DynamicVertexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1a392233c9c36e33a902ccacea28c83299"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateDynamicVertexBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx25updateDynamicVertexBufferE25DynamicVertexBufferHandle8uint32_tPK6Memory" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx6updateE25DynamicVertexBufferHandle8uint32_tPK6Memory">
<span id="bgfx::update__DynamicVertexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1ae443751595715ba47e61a97c45cbf939"></span>void <code class="descclassname">bgfx::</code><code class="descname">update</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6updateE25DynamicVertexBufferHandle8uint32_tPK6Memory" title="Permalink to this definition"></a></dt>
<dd><p>Update dynamic vertex buffer. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
@@ -5214,8 +5238,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx24updateDynamicIndexBufferE24DynamicIndexBufferHandle8uint32_tPK6Memory">
<span id="bgfx::updateDynamicIndexBuffer__DynamicIndexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1a94bc9d8f473817a271846bc17e321d11"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateDynamicIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em>, uint32_t <em>_startIndex</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx24updateDynamicIndexBufferE24DynamicIndexBufferHandle8uint32_tPK6Memory" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx6updateE24DynamicIndexBufferHandle8uint32_tPK6Memory">
<span id="bgfx::update__DynamicIndexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1abdc14b2d18b00e5c85b9b099d63c5d99"></span>void <code class="descclassname">bgfx::</code><code class="descname">update</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em>, uint32_t <em>_startIndex</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6updateE24DynamicIndexBufferHandle8uint32_tPK6Memory" title="Permalink to this definition"></a></dt>
<dd><p>Update dynamic index buffer. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>

18
genindex.html
View File

@@ -677,6 +677,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx7Encoder14setVertexCountE8uint32_t">bgfx::Encoder::setVertexCount (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7int32_tb">bgfx::Encoder::submit (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle20OcclusionQueryHandle7int32_tb">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle7int32_tb">[2]</a>
</dt>
@@ -1092,12 +1096,12 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx8shutdownEv">bgfx::shutdown (C++ function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5StatsE">bgfx::Stats (C++ class)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimeBeginE">bgfx::Stats::cpuTimeBegin (C++ member)</a>
</dt>
@@ -1599,6 +1603,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx15TopologyConvert19TriStripFlipWindingE">bgfx::TopologyConvert::TriStripFlipWinding (C++ enumerator)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx15TopologyConvert17TriStripToTriListE">bgfx::TopologyConvert::TriStripToTriList (C++ enumerator)</a>
</dt>
@@ -1719,11 +1727,7 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx24updateDynamicIndexBufferE24DynamicIndexBufferHandle8uint32_tPK6Memory">bgfx::updateDynamicIndexBuffer (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx25updateDynamicVertexBufferE25DynamicVertexBufferHandle8uint32_tPK6Memory">bgfx::updateDynamicVertexBuffer (C++ function)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx6updateE24DynamicIndexBufferHandle8uint32_tPK6Memory">bgfx::update (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx6updateE25DynamicVertexBufferHandle8uint32_tPK6Memory">[1]</a>
</dt>

5
internals.html
View File

@@ -161,7 +161,7 @@
</div>
<div class="section" id="resource-api">
<h2>Resource API<a class="headerlink" href="#resource-api" title="Permalink to this headline"></a></h2>
<p>Any API call starting with <code class="docutils literal"><span class="pre">bgfx::create*</span></code>, <code class="docutils literal"><span class="pre">bgfx::destroy</span></code>, <code class="docutils literal"><span class="pre">bgfx::update*</span></code>, <code class="docutils literal"><span class="pre">bgfx::alloc*</span></code> is considered part of resource API. Internally resource API calls are guarded by mutex. There is no limit of number of threads that can call resource API simultanesly. Calling any resource API is infrequent, and functions are cheap since most of work with resurces is done at later point on render thread.</p>
<p>Any API call starting with <code class="docutils literal"><span class="pre">bgfx::create*</span></code>, <code class="docutils literal"><span class="pre">bgfx::destroy*</span></code>, <code class="docutils literal"><span class="pre">bgfx::update*</span></code>, <code class="docutils literal"><span class="pre">bgfx::alloc*</span></code> is considered part of resource API. Internally resource API calls are guarded by mutex. There is no limit of number of threads that can call resource API simultaneously. Calling any resource API is infrequent, and functions are cheap since most of work with resource is done at later point on render thread.</p>
</div>
<div class="section" id="view-api">
<h2>View API<a class="headerlink" href="#view-api" title="Permalink to this headline"></a></h2>
@@ -169,7 +169,7 @@
</div>
<div class="section" id="encoder-api">
<h2>Encoder API<a class="headerlink" href="#encoder-api" title="Permalink to this headline"></a></h2>
<p>Encoder API can be obtained by calling <code class="docutils literal"><span class="pre">bgfx::begin</span></code>. bgfx by default allows 8 simultaneous threads to use encoders. This can be configured by changing <code class="docutils literal"><span class="pre">BGFX_CONFIG_MAX_ENCODERS</span></code> option.</p>
<p>Encoder API can be obtained by calling <code class="docutils literal"><span class="pre">bgfx::begin</span></code>. bgfx by default allows 8 simultaneous threads to use encoders. This can be configured by changing <code class="docutils literal"><span class="pre">Limits.maxEncoders</span></code> init option of <code class="docutils literal"><span class="pre">bgfx::Init</span></code> structure.</p>
</div>
<div class="section" id="customization">
<h2>Customization<a class="headerlink" href="#customization" title="Permalink to this headline"></a></h2>
@@ -181,7 +181,6 @@ SDK</a>, <a class="reference external" href="http://www.malideveloper.com/">Mali
<div class="section" id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h3>
<p><code class="docutils literal"><span class="pre">BGFX_CONFIG_MULTITHREADED</span></code> is used to enable/disable threading support inside bgfx. By default set to 1 on all platforms that support threading.</p>
<p><code class="docutils literal"><span class="pre">BGFX_CONFIG_MAX_ENCODERS</span></code> maximum number of encoders supported by bgfx. This many threads can simultaneosly generate draw calls.</p>
</div>
</div>
</div>

BIN
objects.inv
View File

Binary file not shown.

2
searchindex.js
View File

File diff suppressed because one or more lines are too long