mirror of
https://github.com/bkaradzic/bgfx.git
synced 2026-02-18 04:53:06 +01:00
Updated docs.
This commit is contained in:
Бранимир Караџић
221
bgfx.html
221
bgfx.html
@@ -885,7 +885,7 @@ tutorial.</p>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
<li><code class="docutils literal"><span class="pre">_attr</span></code>: Background color. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_small</span></code>: Default or 8x8 font.</li>
|
||||
<li><code class="docutils literal"><span class="pre">_small</span></code>: Default 8x16 or 8x8 font.</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -1990,37 +1990,16 @@ creating windows.</p>
|
||||
</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx16overrideInternalE13TextureHandle8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_t">
|
||||
<span id="bgfx::overrideInternal__TextureHandle.uint16_t.uint16_t.uint8_t.TextureFormat::Enum.uint32_t"></span><span class="target" id="namespacebgfx_1a6b011373b9c788a9cef104999f640665"></span>uintptr_t <code class="descclassname">bgfx::</code><code class="descname">overrideInternal</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint8_t <em>_numMips</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_flags</em> = BGFX_SAMPLER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx16overrideInternalE13TextureHandle8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override internal texture by creating new texture. Previously created internal texture will released. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>It’s expected you understand some bgfx internals before you use this call.</dd>
|
||||
<dt><strong>Return</strong></dt>
|
||||
<dd>Native API pointer to texture. If result is 0, texture is not created yet from the main thread.</dd>
|
||||
<dt><strong>Warning</strong></dt>
|
||||
<dd>Must be called only on render thread.</dd>
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_override_internal_texture</span></code>. </dd>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Texture handle. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_numMips</span></code>: Number of mip-maps. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_format</span></code>: Texture format. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
|
||||
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
|
||||
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="admonition warning">
|
||||
<p class="first admonition-title">Warning</p>
|
||||
<p>doxygenfunction: Unable to resolve multiple matches for function “bgfx::overrideInternal” with arguments (TextureHandle, uint16_t, uint16_t, uint8_t, TextureFormat::Enum, uint32_t) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
|
||||
Potential matches:
|
||||
</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="last highlight-python"><div class="highlight"><pre>- uintptr_t bgfx::overrideInternal(TextureHandle, uint16_t, uint16_t, uint8_t, TextureFormat::Enum, uint64_t)
|
||||
- uintptr_t bgfx::overrideInternal(TextureHandle, uintptr_t)
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="miscellaneous">
|
||||
<h3>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permalink to this headline">¶</a></h3>
|
||||
@@ -2984,7 +2963,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer">
|
||||
<span id="bgfx::Encoder::setIndexBuffer__TransientIndexBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1a111617d3f649d957be50b91079a9c052"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientIndexBuffer *<em>_tib</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Encoder::setIndexBuffer__TransientIndexBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1a111617d3f649d957be50b91079a9c052"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx20TransientIndexBufferE" title="bgfx::TransientIndexBuffer">TransientIndexBuffer</a> *<em>_tib</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer" 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>
|
||||
@@ -3000,7 +2979,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">
|
||||
<span id="bgfx::Encoder::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a2a2273ecc04472bd1c6fe9c0c05e530f"></span>void <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="#_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Encoder::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a2a2273ecc04472bd1c6fe9c0c05e530f"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx20TransientIndexBufferE" title="bgfx::TransientIndexBuffer">TransientIndexBuffer</a> *<em>_tib</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer8uint32_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>
|
||||
@@ -3090,7 +3069,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer">
|
||||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.TransientVertexBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1a4d17b54519e2a8c8c2a806368df50080"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.TransientVertexBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1a4d17b54519e2a8c8c2a806368df50080"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx21TransientVertexBufferE" title="bgfx::TransientVertexBuffer">TransientVertexBuffer</a> *<em>_tvb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer" 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>
|
||||
@@ -3107,7 +3086,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t">
|
||||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.TransientVertexBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a6dd809b31661588edb32dcf0f5d3c61b"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.TransientVertexBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a6dd809b31661588edb32dcf0f5d3c61b"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx21TransientVertexBufferE" title="bgfx::TransientVertexBuffer">TransientVertexBuffer</a> *<em>_tvb</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_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>
|
||||
@@ -3144,7 +3123,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
|
||||
|
||||
<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>
|
||||
<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> <a class="reference internal" href="#_CPPv2N4bgfx18InstanceDataBufferE" title="bgfx::InstanceDataBuffer">InstanceDataBuffer</a> *<em>_idb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
@@ -3160,7 +3139,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t">
|
||||
<span id="bgfx::Encoder::setInstanceDataBuffer__InstanceDataBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1adf6c147ada3e5338eb517d0c33faf01d"></span>void <code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> InstanceDataBuffer *<em>_idb</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Encoder::setInstanceDataBuffer__InstanceDataBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1adf6c147ada3e5338eb517d0c33faf01d"></span>void <code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx18InstanceDataBufferE" title="bgfx::InstanceDataBuffer">InstanceDataBuffer</a> *<em>_idb</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
@@ -4138,9 +4117,47 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="_CPPv2N4bgfx20TransientIndexBufferE">
|
||||
<span id="bgfx::TransientIndexBuffer"></span><span class="target" id="structbgfx_1_1_transient_index_buffer"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">TransientIndexBuffer</code><a class="headerlink" href="#_CPPv2N4bgfx20TransientIndexBufferE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Transient index buffer. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_transient_index_buffer_t</span></code>. </dd>
|
||||
</dl>
|
||||
</p>
|
||||
<div class="breathe-sectiondef container">
|
||||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx20TransientIndexBuffer4dataE">
|
||||
<span id="bgfx::TransientIndexBuffer::data__uint8_tP"></span><span class="target" id="structbgfx_1_1_transient_index_buffer_1a56bca703d287253ac57f38dcb283fa1e"></span>uint8_t *<code class="descname">data</code><a class="headerlink" href="#_CPPv2N4bgfx20TransientIndexBuffer4dataE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Pointer to data. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx20TransientIndexBuffer4sizeE">
|
||||
<span id="bgfx::TransientIndexBuffer::size__uint32_t"></span><span class="target" id="structbgfx_1_1_transient_index_buffer_1a7de478d2ab89e7c7129455984457a9be"></span>uint32_t <code class="descname">size</code><a class="headerlink" href="#_CPPv2N4bgfx20TransientIndexBuffer4sizeE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Data size. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx20TransientIndexBuffer10startIndexE">
|
||||
<span id="bgfx::TransientIndexBuffer::startIndex__uint32_t"></span><span class="target" id="structbgfx_1_1_transient_index_buffer_1a62c632b13cd7dc677fb192524b34f8a0"></span>uint32_t <code class="descname">startIndex</code><a class="headerlink" href="#_CPPv2N4bgfx20TransientIndexBuffer10startIndexE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>First index. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx20TransientIndexBuffer6handleE">
|
||||
<span id="bgfx::TransientIndexBuffer::handle__IndexBufferHandle"></span><span class="target" id="structbgfx_1_1_transient_index_buffer_1a434b4d95281489af1710cf6ed68f8979"></span>IndexBufferHandle <code class="descname">handle</code><a class="headerlink" href="#_CPPv2N4bgfx20TransientIndexBuffer6handleE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Index buffer handle. </p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer">
|
||||
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP"></span><span class="target" id="namespacebgfx_1a31bede5af454ba8b2c802d15ee84abab"></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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP"></span><span class="target" id="namespacebgfx_1a31bede5af454ba8b2c802d15ee84abab"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx20TransientIndexBufferE" title="bgfx::TransientIndexBuffer">TransientIndexBuffer</a> *<em>_tib</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer" 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>
|
||||
@@ -4156,7 +4173,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">
|
||||
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_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>
|
||||
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1a1ff04459d5f92944634903ab4bdfe8bc"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx20TransientIndexBufferE" title="bgfx::TransientIndexBuffer">TransientIndexBuffer</a> *<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>
|
||||
@@ -4244,9 +4261,59 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="_CPPv2N4bgfx21TransientVertexBufferE">
|
||||
<span id="bgfx::TransientVertexBuffer"></span><span class="target" id="structbgfx_1_1_transient_vertex_buffer"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">TransientVertexBuffer</code><a class="headerlink" href="#_CPPv2N4bgfx21TransientVertexBufferE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Transient vertex buffer. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_transient_vertex_buffer_t</span></code>. </dd>
|
||||
</dl>
|
||||
</p>
|
||||
<div class="breathe-sectiondef container">
|
||||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx21TransientVertexBuffer4dataE">
|
||||
<span id="bgfx::TransientVertexBuffer::data__uint8_tP"></span><span class="target" id="structbgfx_1_1_transient_vertex_buffer_1af7347b77991e133505e1291db44b6953"></span>uint8_t *<code class="descname">data</code><a class="headerlink" href="#_CPPv2N4bgfx21TransientVertexBuffer4dataE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Pointer to data. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx21TransientVertexBuffer4sizeE">
|
||||
<span id="bgfx::TransientVertexBuffer::size__uint32_t"></span><span class="target" id="structbgfx_1_1_transient_vertex_buffer_1a1bcf038e6540ba4ea9b717f4d3336747"></span>uint32_t <code class="descname">size</code><a class="headerlink" href="#_CPPv2N4bgfx21TransientVertexBuffer4sizeE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Data size. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx21TransientVertexBuffer11startVertexE">
|
||||
<span id="bgfx::TransientVertexBuffer::startVertex__uint32_t"></span><span class="target" id="structbgfx_1_1_transient_vertex_buffer_1a94bf9b08164f27ef2aa599871945e227"></span>uint32_t <code class="descname">startVertex</code><a class="headerlink" href="#_CPPv2N4bgfx21TransientVertexBuffer11startVertexE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>First vertex. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx21TransientVertexBuffer6strideE">
|
||||
<span id="bgfx::TransientVertexBuffer::stride__uint16_t"></span><span class="target" id="structbgfx_1_1_transient_vertex_buffer_1afb88e19c370bc99c1facb5ba92ee1e50"></span>uint16_t <code class="descname">stride</code><a class="headerlink" href="#_CPPv2N4bgfx21TransientVertexBuffer6strideE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Vertex stride. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx21TransientVertexBuffer6handleE">
|
||||
<span id="bgfx::TransientVertexBuffer::handle__VertexBufferHandle"></span><span class="target" id="structbgfx_1_1_transient_vertex_buffer_1aabfe2320c5979036798f5794ab21f977"></span>VertexBufferHandle <code class="descname">handle</code><a class="headerlink" href="#_CPPv2N4bgfx21TransientVertexBuffer6handleE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Vertex buffer handle. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx21TransientVertexBuffer4declE">
|
||||
<span id="bgfx::TransientVertexBuffer::decl__VertexDeclHandle"></span><span class="target" id="structbgfx_1_1_transient_vertex_buffer_1a72301199a80137b8d052918fbf505bd1"></span>VertexDeclHandle <code class="descname">decl</code><a class="headerlink" href="#_CPPv2N4bgfx21TransientVertexBuffer4declE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Vertex declaration handle. </p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer">
|
||||
<span id="bgfx::setVertexBuffer__uint8_t.TransientVertexBufferCP"></span><span class="target" id="namespacebgfx_1adedeea9d83dc33076177b6c0657dbf6f"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::setVertexBuffer__uint8_t.TransientVertexBufferCP"></span><span class="target" id="namespacebgfx_1adedeea9d83dc33076177b6c0657dbf6f"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx21TransientVertexBufferE" title="bgfx::TransientVertexBuffer">TransientVertexBuffer</a> *<em>_tvb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer" 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>
|
||||
@@ -4263,7 +4330,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t">
|
||||
<span id="bgfx::setVertexBuffer__uint8_t.TransientVertexBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1aa9547529632951c0f1b64c327444c4f6"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::setVertexBuffer__uint8_t.TransientVertexBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1aa9547529632951c0f1b64c327444c4f6"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx21TransientVertexBufferE" title="bgfx::TransientVertexBuffer">TransientVertexBuffer</a> *<em>_tvb</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_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>
|
||||
@@ -4298,9 +4365,59 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="_CPPv2N4bgfx18InstanceDataBufferE">
|
||||
<span id="bgfx::InstanceDataBuffer"></span><span class="target" id="structbgfx_1_1_instance_data_buffer"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">InstanceDataBuffer</code><a class="headerlink" href="#_CPPv2N4bgfx18InstanceDataBufferE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Instance data buffer info. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_texture_info_t</span></code>. </dd>
|
||||
</dl>
|
||||
</p>
|
||||
<div class="breathe-sectiondef container">
|
||||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx18InstanceDataBuffer4dataE">
|
||||
<span id="bgfx::InstanceDataBuffer::data__uint8_tP"></span><span class="target" id="structbgfx_1_1_instance_data_buffer_1a3ca64a920d51d545a2d55f9f4a07676b"></span>uint8_t *<code class="descname">data</code><a class="headerlink" href="#_CPPv2N4bgfx18InstanceDataBuffer4dataE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Pointer to data. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx18InstanceDataBuffer4sizeE">
|
||||
<span id="bgfx::InstanceDataBuffer::size__uint32_t"></span><span class="target" id="structbgfx_1_1_instance_data_buffer_1a9756b029b7456ff8968877ce74ab37df"></span>uint32_t <code class="descname">size</code><a class="headerlink" href="#_CPPv2N4bgfx18InstanceDataBuffer4sizeE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Data size. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx18InstanceDataBuffer6offsetE">
|
||||
<span id="bgfx::InstanceDataBuffer::offset__uint32_t"></span><span class="target" id="structbgfx_1_1_instance_data_buffer_1a91b8b832bbb281e48803f38a5f732f36"></span>uint32_t <code class="descname">offset</code><a class="headerlink" href="#_CPPv2N4bgfx18InstanceDataBuffer6offsetE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Offset in vertex buffer. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx18InstanceDataBuffer3numE">
|
||||
<span id="bgfx::InstanceDataBuffer::num__uint32_t"></span><span class="target" id="structbgfx_1_1_instance_data_buffer_1a1990052b31322da9be730efd026f24c4"></span>uint32_t <code class="descname">num</code><a class="headerlink" href="#_CPPv2N4bgfx18InstanceDataBuffer3numE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Number of instances. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx18InstanceDataBuffer6strideE">
|
||||
<span id="bgfx::InstanceDataBuffer::stride__uint16_t"></span><span class="target" id="structbgfx_1_1_instance_data_buffer_1a3dcc99168a618a698abaca9dc62033d6"></span>uint16_t <code class="descname">stride</code><a class="headerlink" href="#_CPPv2N4bgfx18InstanceDataBuffer6strideE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Vertex buffer stride. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx18InstanceDataBuffer6handleE">
|
||||
<span id="bgfx::InstanceDataBuffer::handle__VertexBufferHandle"></span><span class="target" id="structbgfx_1_1_instance_data_buffer_1ab24765df1ccf358a491f27931f0c91cc"></span>VertexBufferHandle <code class="descname">handle</code><a class="headerlink" href="#_CPPv2N4bgfx18InstanceDataBuffer6handleE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Vertex buffer object handle. </p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</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>
|
||||
<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> <a class="reference internal" href="#_CPPv2N4bgfx18InstanceDataBufferE" title="bgfx::InstanceDataBuffer">InstanceDataBuffer</a> *<em>_idb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
@@ -4316,7 +4433,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t">
|
||||
<span id="bgfx::setInstanceDataBuffer__InstanceDataBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1ad9b9b9217c22449bc4d18af7abe4651e"></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>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::setInstanceDataBuffer__InstanceDataBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1ad9b9b9217c22449bc4d18af7abe4651e"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx18InstanceDataBufferE" title="bgfx::InstanceDataBuffer">InstanceDataBuffer</a> *<em>_idb</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
@@ -5563,14 +5680,14 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx26allocTransientVertexBufferEP21TransientVertexBuffer8uint32_tRK10VertexDecl">
|
||||
<span id="bgfx::allocTransientVertexBuffer__TransientVertexBufferP.uint32_t.VertexDeclCR"></span><span class="target" id="namespacebgfx_1a6a4d9cc701bc40867080297ab59390e7"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocTransientVertexBuffer</code><span class="sig-paren">(</span>TransientVertexBuffer *<em>_tvb</em>, uint32_t <em>_num</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx26allocTransientVertexBufferEP21TransientVertexBuffer8uint32_tRK10VertexDecl" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::allocTransientVertexBuffer__TransientVertexBufferP.uint32_t.VertexDeclCR"></span><span class="target" id="namespacebgfx_1a6a4d9cc701bc40867080297ab59390e7"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocTransientVertexBuffer</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx21TransientVertexBufferE" title="bgfx::TransientVertexBuffer">TransientVertexBuffer</a> *<em>_tvb</em>, uint32_t <em>_num</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx26allocTransientVertexBufferEP21TransientVertexBuffer8uint32_tRK10VertexDecl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allocate transient vertex buffer. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_transient_vertex_buffer</span></code>. </dd>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
<li><code class="docutils literal"><span class="pre">_tvb</span></code>: TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_tvb</span></code>: <a class="reference internal" href="#structbgfx_1_1_transient_vertex_buffer"><span>TransientVertexBuffer</span></a> structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of vertices to allocate. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex declaration.</li>
|
||||
</ul>
|
||||
@@ -5729,7 +5846,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx25allocTransientIndexBufferEP20TransientIndexBuffer8uint32_t">
|
||||
<span id="bgfx::allocTransientIndexBuffer__TransientIndexBufferP.uint32_t"></span><span class="target" id="namespacebgfx_1a9526c5d498cfacda5d1a0008d3f61f1e"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocTransientIndexBuffer</code><span class="sig-paren">(</span>TransientIndexBuffer *<em>_tib</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx25allocTransientIndexBufferEP20TransientIndexBuffer8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::allocTransientIndexBuffer__TransientIndexBufferP.uint32_t"></span><span class="target" id="namespacebgfx_1a9526c5d498cfacda5d1a0008d3f61f1e"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocTransientIndexBuffer</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx20TransientIndexBufferE" title="bgfx::TransientIndexBuffer">TransientIndexBuffer</a> *<em>_tib</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx25allocTransientIndexBufferEP20TransientIndexBuffer8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allocate transient index buffer. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Remark</strong></dt>
|
||||
@@ -5738,7 +5855,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_transient_index_buffer</span></code>. </dd>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
<li><code class="docutils literal"><span class="pre">_tib</span></code>: TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_tib</span></code>: <a class="reference internal" href="#structbgfx_1_1_transient_index_buffer"><span>TransientIndexBuffer</span></a> structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of indices to allocate.</li>
|
||||
</ul>
|
||||
</dd>
|
||||
@@ -6434,6 +6551,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
<dd><p>Update 2D texture. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>It’s valid to update only mutable texture. See <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a5164c7c2fb433f680dc888eaf752c31b"><span><span class="pre">bgfx::createTexture2D</span></span></a></code> for more info.</dd>
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_texture_2d</span></code>. </dd>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
@@ -6484,6 +6603,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
<dd><p>Update 3D texture. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>It’s valid to update only mutable texture. See <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a5b3e757ceb8eaa783856c39e3e18e985"><span><span class="pre">bgfx::createTexture3D</span></span></a></code> for more info.</dd>
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_texture_3d</span></code>. </dd>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
@@ -6533,6 +6654,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
<dd><p>Update Cube texture. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>It’s valid to update only mutable texture. See <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1aa78aaf8f1d6f52a956330e7336d403f8"><span><span class="pre">bgfx::createTextureCube</span></span></a></code> for more info.</dd>
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_texture_cube</span></code>. </dd>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
@@ -6868,14 +6991,14 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="_CPPv2N4bgfx23allocInstanceDataBufferEP18InstanceDataBuffer8uint32_t8uint16_t">
|
||||
<span id="bgfx::allocInstanceDataBuffer__InstanceDataBufferP.uint32_t.uint16_t"></span><span class="target" id="namespacebgfx_1a57f18c024a3c7f0f1e902dc85b987757"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocInstanceDataBuffer</code><span class="sig-paren">(</span>InstanceDataBuffer *<em>_idb</em>, uint32_t <em>_num</em>, uint16_t <em>_stride</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx23allocInstanceDataBufferEP18InstanceDataBuffer8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::allocInstanceDataBuffer__InstanceDataBufferP.uint32_t.uint16_t"></span><span class="target" id="namespacebgfx_1a57f18c024a3c7f0f1e902dc85b987757"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocInstanceDataBuffer</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx18InstanceDataBufferE" title="bgfx::InstanceDataBuffer">InstanceDataBuffer</a> *<em>_idb</em>, uint32_t <em>_num</em>, uint16_t <em>_stride</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx23allocInstanceDataBufferEP18InstanceDataBuffer8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allocate instance data buffer. </p>
|
||||
<p><dl class="docutils">
|
||||
<dt><strong>Attention</strong></dt>
|
||||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_instance_data_buffer</span></code>. </dd>
|
||||
<dt><strong>Parameters</strong></dt>
|
||||
<dd><ul class="breatheparameterlist first last simple">
|
||||
<li><code class="docutils literal"><span class="pre">_idb</span></code>: InstanceDataBuffer structure is filled and is valid for duration of frame, and it can be reused for multiple draw calls. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_idb</span></code>: <a class="reference internal" href="#structbgfx_1_1_instance_data_buffer"><span>InstanceDataBuffer</span></a> structure is filled and is valid for duration of frame, and it can be reused for multiple draw calls. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of instances. </li>
|
||||
<li><code class="docutils literal"><span class="pre">_stride</span></code>: Instance stride. Must be multiple of 16.</li>
|
||||
</ul>
|
||||
|
||||
@@ -845,6 +845,34 @@
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx18InstanceDataBufferE">bgfx::InstanceDataBuffer (C++ class)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx18InstanceDataBuffer4dataE">bgfx::InstanceDataBuffer::data (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx18InstanceDataBuffer6handleE">bgfx::InstanceDataBuffer::handle (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx18InstanceDataBuffer3numE">bgfx::InstanceDataBuffer::num (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx18InstanceDataBuffer6offsetE">bgfx::InstanceDataBuffer::offset (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx18InstanceDataBuffer4sizeE">bgfx::InstanceDataBuffer::size (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx18InstanceDataBuffer6strideE">bgfx::InstanceDataBuffer::stride (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx12InternalDataE">bgfx::InternalData (C++ class)</a>
|
||||
</dt>
|
||||
|
||||
@@ -901,7 +929,7 @@
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx16overrideInternalE13TextureHandle8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_t">bgfx::overrideInternal (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx16overrideInternalE13TextureHandle9uintptr_t">[1]</a>
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx16overrideInternalE13TextureHandle9uintptr_t">bgfx::overrideInternal (C++ function)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
@@ -1248,8 +1276,6 @@
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats11numUniformsE">bgfx::Stats::numUniforms (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats16numVertexBuffersE">bgfx::Stats::numVertexBuffers (C++ member)</a>
|
||||
</dt>
|
||||
@@ -1258,6 +1284,8 @@
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats14numVertexDeclsE">bgfx::Stats::numVertexDecls (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats8numViewsE">bgfx::Stats::numViews (C++ member)</a>
|
||||
</dt>
|
||||
@@ -1803,6 +1831,54 @@
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx20TransientIndexBufferE">bgfx::TransientIndexBuffer (C++ class)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx20TransientIndexBuffer4dataE">bgfx::TransientIndexBuffer::data (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx20TransientIndexBuffer6handleE">bgfx::TransientIndexBuffer::handle (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx20TransientIndexBuffer4sizeE">bgfx::TransientIndexBuffer::size (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx20TransientIndexBuffer10startIndexE">bgfx::TransientIndexBuffer::startIndex (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx21TransientVertexBufferE">bgfx::TransientVertexBuffer (C++ class)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx21TransientVertexBuffer4dataE">bgfx::TransientVertexBuffer::data (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx21TransientVertexBuffer4declE">bgfx::TransientVertexBuffer::decl (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx21TransientVertexBuffer6handleE">bgfx::TransientVertexBuffer::handle (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx21TransientVertexBuffer4sizeE">bgfx::TransientVertexBuffer::size (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx21TransientVertexBuffer11startVertexE">bgfx::TransientVertexBuffer::startVertex (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx21TransientVertexBuffer6strideE">bgfx::TransientVertexBuffer::stride (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx11UniformInfoE">bgfx::UniformInfo (C++ class)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user