Updated docs.

This commit is contained in:
Бранимир Караџић
2022-08-26 21:44:21 -07:00
parent b175869b08
commit 274da4c0a2
13 changed files with 98 additions and 30 deletions

View File

@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.115.8203',
VERSION: '1.115.8268',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API Reference &mdash; bgfx 1.115.8203 documentation</title>
<title>API Reference &mdash; bgfx 1.115.8268 documentation</title>
@@ -61,7 +61,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>
@@ -256,13 +256,15 @@
<dl class="cpp var">
<dt id="_CPPv4N4bgfx4Init8vendorIdE">
<span id="_CPPv3N4bgfx4Init8vendorIdE"></span><span id="_CPPv2N4bgfx4Init8vendorIdE"></span><span id="bgfx::Init::vendorId__uint16_t"></span><span class="target" id="structbgfx_1_1_init_1a95acf1a68426ecd7192d6cdf93e02e83"></span>uint16_t <code class="sig-name descname">vendorId</code><a class="headerlink" href="#_CPPv4N4bgfx4Init8vendorIdE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Vendor PCI id. If set to <code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_NONE</span></code> it will select the first device. </p>
<dd><p>Vendor PCI ID. If set to <code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_NONE</span></code>, discrete and integrated GPUs will be prioritised. </p>
<p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_NONE</span></code> - Autoselect adapter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_NONE</span></code> - Auto-select adapter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_SOFTWARE_RASTERIZER</span></code> - Software rasterizer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_AMD</span></code> - AMD adapter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_APPLE</span></code> - Apple adapter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_INTEL</span></code> - Intel adapter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_NVIDIA</span></code> - nVidia adapter. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_NVIDIA</span></code> - NVIDIA adapter.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BGFX_PCI_ID_MICROSOFT</span></code> - Microsoft adapter. </p></li>
</ul>
</p>
</dd></dl>
@@ -270,7 +272,7 @@
<dl class="cpp var">
<dt id="_CPPv4N4bgfx4Init8deviceIdE">
<span id="_CPPv3N4bgfx4Init8deviceIdE"></span><span id="_CPPv2N4bgfx4Init8deviceIdE"></span><span id="bgfx::Init::deviceId__uint16_t"></span><span class="target" id="structbgfx_1_1_init_1a60ff2d3dd1ccdae79ef96a62eb1bf5e0"></span>uint16_t <code class="sig-name descname">deviceId</code><a class="headerlink" href="#_CPPv4N4bgfx4Init8deviceIdE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Device id. If set to 0 it will select first device, or device with matching id. </p>
<dd><p>Device ID. If set to 0 it will select first device, or device with matching ID. </p>
</dd></dl>
<dl class="cpp var">
@@ -447,6 +449,12 @@
<dd><p>AMD adapter. </p>
</dd></dl>
<dl class="cpp macro">
<dt id="c.BGFX_PCI_ID_APPLE">
<span class="target" id="defines_8h_1a2478074075bc43cdd19fef17af04a99e"></span><code class="sig-name descname">BGFX_PCI_ID_APPLE</code><a class="headerlink" href="#c.BGFX_PCI_ID_APPLE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Apple adapter. </p>
</dd></dl>
<dl class="cpp macro">
<dt id="c.BGFX_PCI_ID_INTEL">
<span class="target" id="defines_8h_1a2f3ca85ec971d2a6e98f63b60de61755"></span><code class="sig-name descname">BGFX_PCI_ID_INTEL</code><a class="headerlink" href="#c.BGFX_PCI_ID_INTEL" title="Permalink to this definition"></a><br /></dt>
@@ -459,6 +467,12 @@
<dd><p>nVidia adapter. </p>
</dd></dl>
<dl class="cpp macro">
<dt id="c.BGFX_PCI_ID_MICROSOFT">
<span class="target" id="defines_8h_1a8f1222df21869f3b38de871f2bc5b276"></span><code class="sig-name descname">BGFX_PCI_ID_MICROSOFT</code><a class="headerlink" href="#c.BGFX_PCI_ID_MICROSOFT" title="Permalink to this definition"></a><br /></dt>
<dd><p>Microsoft adapter. </p>
</dd></dl>
<dl class="cpp struct">
<dt id="_CPPv4N4bgfx9CallbackIE">
<span id="_CPPv3N4bgfx9CallbackIE"></span><span id="_CPPv2N4bgfx9CallbackIE"></span><span id="bgfx::CallbackI"></span><span class="target" id="structbgfx_1_1_callback_i"></span><em class="property">struct </em><code class="sig-prename descclassname">bgfx<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">CallbackI</code><a class="headerlink" href="#_CPPv4N4bgfx9CallbackIE" title="Permalink to this definition"></a><br /></dt>
@@ -6405,16 +6419,31 @@ Otherwise, use <cite>bgfx::setViewScissor</cite>.</p>
<span id="_CPPv3N4bgfx13TextureFormat4Enum7RGBA32FE"></span><span id="_CPPv2N4bgfx13TextureFormat4Enum7RGBA32FE"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ad21d8c3be31a08140a7abbafb1719166"></span><em class="property">enumerator </em><code class="sig-name descname">RGBA32F</code><a class="headerlink" href="#_CPPv4N4bgfx13TextureFormat4Enum7RGBA32FE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt id="_CPPv4N4bgfx13TextureFormat4Enum6B5G6R5E">
<span id="_CPPv3N4bgfx13TextureFormat4Enum6B5G6R5E"></span><span id="_CPPv2N4bgfx13TextureFormat4Enum6B5G6R5E"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a9132b9c53a5e2dafd1a6a6ade302f33b"></span><em class="property">enumerator </em><code class="sig-name descname">B5G6R5</code><a class="headerlink" href="#_CPPv4N4bgfx13TextureFormat4Enum6B5G6R5E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt id="_CPPv4N4bgfx13TextureFormat4Enum6R5G6B5E">
<span id="_CPPv3N4bgfx13TextureFormat4Enum6R5G6B5E"></span><span id="_CPPv2N4bgfx13TextureFormat4Enum6R5G6B5E"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aec8537567352a4db4088e3e9f1cf978d"></span><em class="property">enumerator </em><code class="sig-name descname">R5G6B5</code><a class="headerlink" href="#_CPPv4N4bgfx13TextureFormat4Enum6R5G6B5E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt id="_CPPv4N4bgfx13TextureFormat4Enum5BGRA4E">
<span id="_CPPv3N4bgfx13TextureFormat4Enum5BGRA4E"></span><span id="_CPPv2N4bgfx13TextureFormat4Enum5BGRA4E"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aa45c193e57e5b9bf0a8693438f1c2256"></span><em class="property">enumerator </em><code class="sig-name descname">BGRA4</code><a class="headerlink" href="#_CPPv4N4bgfx13TextureFormat4Enum5BGRA4E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt id="_CPPv4N4bgfx13TextureFormat4Enum5RGBA4E">
<span id="_CPPv3N4bgfx13TextureFormat4Enum5RGBA4E"></span><span id="_CPPv2N4bgfx13TextureFormat4Enum5RGBA4E"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a4e9ceae8c33292ac988c494f79bccbe3"></span><em class="property">enumerator </em><code class="sig-name descname">RGBA4</code><a class="headerlink" href="#_CPPv4N4bgfx13TextureFormat4Enum5RGBA4E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt id="_CPPv4N4bgfx13TextureFormat4Enum6BGR5A1E">
<span id="_CPPv3N4bgfx13TextureFormat4Enum6BGR5A1E"></span><span id="_CPPv2N4bgfx13TextureFormat4Enum6BGR5A1E"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a45b848a845dc1081fa04570b1bc7bc2a"></span><em class="property">enumerator </em><code class="sig-name descname">BGR5A1</code><a class="headerlink" href="#_CPPv4N4bgfx13TextureFormat4Enum6BGR5A1E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt id="_CPPv4N4bgfx13TextureFormat4Enum6RGB5A1E">
<span id="_CPPv3N4bgfx13TextureFormat4Enum6RGB5A1E"></span><span id="_CPPv2N4bgfx13TextureFormat4Enum6RGB5A1E"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a38bfd7f727149e6458f39ade896d18a7"></span><em class="property">enumerator </em><code class="sig-name descname">RGB5A1</code><a class="headerlink" href="#_CPPv4N4bgfx13TextureFormat4Enum6RGB5A1E" title="Permalink to this definition"></a><br /></dt>

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Building &mdash; bgfx 1.115.8203 documentation</title>
<title>Building &mdash; bgfx 1.115.8268 documentation</title>
@@ -61,7 +61,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Examples &mdash; bgfx 1.115.8203 documentation</title>
<title>Examples &mdash; bgfx 1.115.8268 documentation</title>
@@ -61,7 +61,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>
@@ -141,6 +141,8 @@
<li class="toctree-l2"><a class="reference internal" href="#sss">44-sss</a></li>
<li class="toctree-l2"><a class="reference internal" href="#bokeh">45-bokeh</a></li>
<li class="toctree-l2"><a class="reference internal" href="#fsr">46-fsr</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pixel-formats">47-Pixel Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="#drawindirect">48-drawindirect</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a></li>
@@ -1268,6 +1270,29 @@ from lower resolution inputs.</p>
<img alt="example-46-fsr" src="https://github.com/bkaradzic/bgfx/raw/master/examples/46-fsr/screenshot.png" />
</div>
</div>
<div class="section" id="pixel-formats">
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/47-pixelformats">47-Pixel Formats</a><a class="headerlink" href="#pixel-formats" title="Permalink to this headline"></a></h2>
<p>Pixel Formats</p>
<p>View and test texture formats</p>
<div class="figure align-default">
<img alt="example-47-pixelformats" src="https://github.com/bkaradzic/bgfx/raw/master/examples/47-pixelformats/screenshot.png" />
</div>
</div>
<div class="section" id="drawindirect">
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/48-drawindirect">48-drawindirect</a><a class="headerlink" href="#drawindirect" title="Permalink to this headline"></a></h2>
<p>Draw Indirect</p>
<p>Simple example of indirect rendering + an implementation of multidraw indirect</p>
<dl class="simple">
<dt>Reference(s):</dt><dd><ul class="simple">
<li><p><a class="reference external" href="https://web.archive.org/web/20201109155619/https://litasa.github.io/blog/2017/09/04/OpenGL-MultiDrawIndirect-with-Individual-Textures">OpenGL MultiDrawIndirect with per-instance textures</a>.</p></li>
<li><p><a class="reference external" href="https://web.archive.org/web/20210926073337/https://cpp-rendering.io/indirect-rendering">Indirect Rendering - A way to a million draw calls</a>.</p></li>
</ul>
</dd>
</dl>
<div class="figure align-default">
<img alt="example-48-drawindirect" src="https://github.com/bkaradzic/bgfx/raw/master/examples/48-drawindirect/screenshot.png" />
</div>
</div>
</div>

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; bgfx 1.115.8203 documentation</title>
<title>Index &mdash; bgfx 1.115.8268 documentation</title>
@@ -59,7 +59,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>
@@ -755,12 +755,12 @@
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats11numUniformsE">bgfx::Stats::numUniforms (C++ member)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats16numVertexBuffersE">bgfx::Stats::numVertexBuffers (C++ member)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats16numVertexLayoutsE">bgfx::Stats::numVertexLayouts (C++ member)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats8numViewsE">bgfx::Stats::numViews (C++ member)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats12rtMemoryUsedE">bgfx::Stats::rtMemoryUsed (C++ member)</a>
@@ -808,6 +808,8 @@
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum4ATCEE">bgfx::TextureFormat::Enum::ATCE (C++ enumerator)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum4ATCIE">bgfx::TextureFormat::Enum::ATCI (C++ enumerator)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum6B5G6R5E">bgfx::TextureFormat::Enum::B5G6R5 (C++ enumerator)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum3BC1E">bgfx::TextureFormat::Enum::BC1 (C++ enumerator)</a>
</li>
@@ -822,6 +824,10 @@
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum4BC6HE">bgfx::TextureFormat::Enum::BC6H (C++ enumerator)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum3BC7E">bgfx::TextureFormat::Enum::BC7 (C++ enumerator)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum6BGR5A1E">bgfx::TextureFormat::Enum::BGR5A1 (C++ enumerator)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum5BGRA4E">bgfx::TextureFormat::Enum::BGRA4 (C++ enumerator)</a>
</li>
<li><a href="bgfx.html#_CPPv4N4bgfx13TextureFormat4Enum5BGRA8E">bgfx::TextureFormat::Enum::BGRA8 (C++ enumerator)</a>
</li>
@@ -1222,8 +1228,12 @@
<li><a href="bgfx.html#c.BGFX_DEBUG_WIREFRAME">BGFX_DEBUG_WIREFRAME (C macro)</a>
</li>
<li><a href="bgfx.html#c.BGFX_PCI_ID_AMD">BGFX_PCI_ID_AMD (C macro)</a>
</li>
<li><a href="bgfx.html#c.BGFX_PCI_ID_APPLE">BGFX_PCI_ID_APPLE (C macro)</a>
</li>
<li><a href="bgfx.html#c.BGFX_PCI_ID_INTEL">BGFX_PCI_ID_INTEL (C macro)</a>
</li>
<li><a href="bgfx.html#c.BGFX_PCI_ID_MICROSOFT">BGFX_PCI_ID_MICROSOFT (C macro)</a>
</li>
<li><a href="bgfx.html#c.BGFX_PCI_ID_NONE">BGFX_PCI_ID_NONE (C macro)</a>
</li>

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documentation &mdash; bgfx 1.115.8203 documentation</title>
<title>Documentation &mdash; bgfx 1.115.8268 documentation</title>
@@ -60,7 +60,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>
@@ -270,6 +270,8 @@ licensed under permissive BSD-2 clause open source license.</p>
<li class="toctree-l2"><a class="reference internal" href="examples.html#sss">44-sss</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#bokeh">45-bokeh</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#fsr">46-fsr</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#pixel-formats">47-Pixel Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawindirect">48-drawindirect</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Internals &mdash; bgfx 1.115.8203 documentation</title>
<title>Internals &mdash; bgfx 1.115.8268 documentation</title>
@@ -61,7 +61,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>License &mdash; bgfx 1.115.8203 documentation</title>
<title>License &mdash; bgfx 1.115.8268 documentation</title>
@@ -60,7 +60,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>
@@ -165,7 +165,7 @@
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
<div class="section" id="license-bsd-2-clause">
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/LICENSE">License (BSD 2-clause)</a><a class="headerlink" href="#license-bsd-2-clause" title="Permalink to this headline"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Copyright</span> <span class="mi">2010</span><span class="o">-</span><span class="mi">2020</span> <span class="n">Branimir</span> <span class="n">Karadzic</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Copyright</span> <span class="mi">2010</span><span class="o">-</span><span class="mi">2022</span> <span class="n">Branimir</span> <span class="n">Karadzic</span>
<span class="n">Redistribution</span> <span class="ow">and</span> <span class="n">use</span> <span class="ow">in</span> <span class="n">source</span> <span class="ow">and</span> <span class="n">binary</span> <span class="n">forms</span><span class="p">,</span> <span class="k">with</span> <span class="ow">or</span> <span class="n">without</span> <span class="n">modification</span><span class="p">,</span>
<span class="n">are</span> <span class="n">permitted</span> <span class="n">provided</span> <span class="n">that</span> <span class="n">the</span> <span class="n">following</span> <span class="n">conditions</span> <span class="n">are</span> <span class="n">met</span><span class="p">:</span>

Binary file not shown.

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Overview &mdash; bgfx 1.115.8203 documentation</title>
<title>Overview &mdash; bgfx 1.115.8268 documentation</title>
@@ -61,7 +61,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>
@@ -583,7 +583,9 @@ bindings.</p></li>
<a class="reference external" href="examples.html#denoise">43-denoise</a>,
<a class="reference external" href="examples.html#sss">44-sss</a>,
and <a class="reference external" href="examples.html#bokeh">45-bokeh</a> example.</p></li>
<li><p>Richard Schubert (<a class="reference external" href="https://github.com/Hemofektik/">&#64;Hemofektik</a>) - <a class="reference external" href="examples.html#fsr">46-fsr</a> example.</p></li>
<li><p>Richard Schubert (<a class="reference external" href="https://github.com/Hemofektik">&#64;Hemofektik</a>) - <a class="reference external" href="examples.html#fsr">46-fsr</a> example.</p></li>
<li><p>Sandy Carter (<a class="reference external" href="https://github.com/bwrsandman">&#64;bwrsandman</a>) - <a class="reference external" href="examples.html#pixelformats">47-pixelformats</a> example, and various fixes and improvements.</p></li>
<li><p>Liam Twigger (<a class="reference external" href="https://github.com/SnapperTT">&#64;SnapperTT</a>) - <a class="reference external" href="examples.html#drawindirect">48-drawindirect</a> example.</p></li>
</ul>
</div></blockquote>
<p>and <a class="reference external" href="https://github.com/bkaradzic/bgfx/graphs/contributors">others</a></p>

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; bgfx 1.115.8203 documentation</title>
<title>Search &mdash; bgfx 1.115.8268 documentation</title>
@@ -61,7 +61,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>

File diff suppressed because one or more lines are too long

View File

@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Tools &mdash; bgfx 1.115.8203 documentation</title>
<title>Tools &mdash; bgfx 1.115.8268 documentation</title>
@@ -61,7 +61,7 @@
<div class="version">
1.115.8203
1.115.8268
</div>