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

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić
2018-09-14 21:30:20 -07:00
parent 07ea30db8b
commit 3c8a491673
5 changed files with 83 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
bgfx.html
View File

@@ -1180,6 +1180,12 @@
<dd><p>Maximum number of texture samplers. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits18maxComputeBindingsE">
<span id="bgfx::Caps::Limits::maxComputeBindings__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a2cf3ef61b8359023fd73ba6cd9f47a64"></span>uint32_t <code class="descname">maxComputeBindings</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits18maxComputeBindingsE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum number of compute bindings. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits14maxVertexDeclsE">
<span id="bgfx::Caps::Limits::maxVertexDecls__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a94bbdf9e33aa717cc93d3984952ac8a9"></span>uint32_t <code class="descname">maxVertexDecls</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits14maxVertexDeclsE" title="Permalink to this definition"></a></dt>
@@ -3036,6 +3042,24 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7Encoder16setInstanceCountE8uint32_t">
<span id="bgfx::Encoder::setInstanceCount__uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1ac8450ebbbf04678db6d2c59ea86178a8"></span>void <code class="descname">setInstanceCount</code><span class="sig-paren">(</span>uint32_t <em>_numInstances</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder16setInstanceCountE8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Set number of instances for auto generated instances use in conjuction with gl_InstanceID. </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_instance_count</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_numInstances</span></code>: Number of instances.</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7Encoder10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t">
<span id="bgfx::Encoder::setTexture__uint8_t.UniformHandle.TextureHandle.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1ababcdc9b1bf89fe863573c5629c1ea31"></span>void <code class="descname">setTexture</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, UniformHandle <em>_sampler</em>, TextureHandle <em>_handle</em>, uint32_t <em>_flags</em> = UINT32_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t" title="Permalink to this definition"></a></dt>
@@ -3866,6 +3890,24 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14setVertexCountE8uint32_t">
<span id="bgfx::setVertexCount__uint32_t"></span><span class="target" id="namespacebgfx_1ad86de33993e8c57ee016d5af8a2c51bd"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexCount</code><span class="sig-paren">(</span>uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setVertexCountE8uint32_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="_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer">
<span id="bgfx::setInstanceDataBuffer__InstanceDataBufferCP"></span><span class="target" id="namespacebgfx_1aa99e46d4c06aacf639114d727eac87dd"></span>void <code class="descclassname">bgfx::</code><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="#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer" title="Permalink to this definition"></a></dt>
@@ -3936,6 +3978,24 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx16setInstanceCountE8uint32_t">
<span id="bgfx::setInstanceCount__uint32_t"></span><span class="target" id="namespacebgfx_1aa41e297fd85870c1773f498cb7e51b05"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceCount</code><span class="sig-paren">(</span>uint32_t <em>_numInstances</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx16setInstanceCountE8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Set number of instances for auto generated instances use in conjuction with gl_InstanceID. </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_instance_count</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_numInstances</span></code>: Number of instances.</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t">
<span id="bgfx::setTexture__uint8_t.UniformHandle.TextureHandle.uint32_t"></span><span class="target" id="namespacebgfx_1a62ed3fb0f144798a2a8ba2e19d0e2dc0"></span>void <code class="descclassname">bgfx::</code><code class="descname">setTexture</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, UniformHandle <em>_sampler</em>, TextureHandle <em>_handle</em>, uint32_t <em>_flags</em> = UINT32_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t" title="Permalink to this definition"></a></dt>
@@ -4304,9 +4364,11 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="class">
<dt id="_CPPv2N4bgfx6MemoryE">
<span id="bgfx::Memory"></span><span class="target" id="structbgfx_1_1_memory"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Memory</code><a class="headerlink" href="#_CPPv2N4bgfx6MemoryE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#structbgfx_1_1_memory"><span>Memory</span></a> obtained by calling <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code>, <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1abef77615b85f71391e7eda16f24dc5b7"><span><span class="pre">bgfx::copy</span></span></a></code>, or <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span><span class="pre">bgfx::makeRef</span></span></a></code>. </p>
<dd><p><a class="reference internal" href="#structbgfx_1_1_memory"><span>Memory</span></a> must be obtained by calling <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code>, <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1abef77615b85f71391e7eda16f24dc5b7"><span><span class="pre">bgfx::copy</span></span></a></code>, or <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span><span class="pre">bgfx::makeRef</span></span></a></code>. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>It is illegal to create this structure on stack and pass it to any bgfx API.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_memory_t</span></code>. </dd>
</dl>
</p>

20
genindex.html
View File

@@ -421,6 +421,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits18maxComputeBindingsE">bgfx::Caps::Limits::maxComputeBindings (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits12maxDrawCallsE">bgfx::Caps::Limits::maxDrawCalls (C++ member)</a>
</dt>
@@ -649,6 +653,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx7Encoder16setInstanceCountE8uint32_t">bgfx::Encoder::setInstanceCount (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx7Encoder21setInstanceDataBufferE18VertexBufferHandle8uint32_t8uint32_t">bgfx::Encoder::setInstanceDataBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx7Encoder21setInstanceDataBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer">[2]</a>, <a href="bgfx.html#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t">[3]</a>
</dt>
@@ -985,6 +993,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx16setInstanceCountE8uint32_t">bgfx::setInstanceCount (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx21setInstanceDataBufferE18VertexBufferHandle8uint32_t8uint32_t">bgfx::setInstanceDataBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx21setInstanceDataBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer">[2]</a>, <a href="bgfx.html#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t">[3]</a>
</dt>
@@ -1029,6 +1041,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx14setVertexCountE8uint32_t">bgfx::setVertexCount (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx12setViewClearE6ViewId8uint16_t8uint32_tf7uint8_t">bgfx::setViewClear (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx12setViewClearE6ViewId8uint16_tf7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t">[1]</a>
</dt>
@@ -1096,6 +1112,8 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats13gpuMemoryUsedE">bgfx::Stats::gpuMemoryUsed (C++ member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12gpuTimeBeginE">bgfx::Stats::gpuTimeBegin (C++ member)</a>
</dt>
@@ -1104,8 +1122,6 @@
<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>

BIN
objects.inv
View File

Binary file not shown.

2
overview.html
View File

@@ -198,7 +198,7 @@ licensed under permissive BSD-2 clause open source license.</p>
<h3>Supported Compilers<a class="headerlink" href="#supported-compilers" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Clang 3.3 and above</li>
<li>GCC 4.6 and above</li>
<li>GCC 5 and above</li>
<li>vs2015 and above</li>
</ul>
</div>

2
searchindex.js
View File

File diff suppressed because one or more lines are too long