Scarfski/bgfx
1
0
Fork 0
mirror of https://github.com/bkaradzic/bgfx.git synced 2026-10-29 20:25:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Бранимир Караџић
2019-10-26 10:41:31 -07:00
parent 763fd247cd
commit 17c3e02b03
11 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bgfx.html
+9 -9
View File
@@ -222,8 +222,8 @@
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>TL;DR for simple walkthrough how to use bgfx API, see <a class="reference external" href="https://dev.to/pperon/hello-bgfx-4dka">Hello, bgfx!</a>
or <a class="reference external" href="https://www.sandeepnambiar.com/getting-started-with-bgfx/">Using the bgfx library with C++ on Ubuntu</a> tutorial.</p>
<p>TL;DR for simple walkthrough how to use bgfx API, see <a class="reference external" href="https://dev.to/pperon/hello-bgfx-4dka">Hello, bgfx!</a>,
<a class="reference external" href="https://github.com/jpcy/bgfx-minimal-example#bgfx-minimal-example">bgfx-minimal-example</a>, or <a class="reference external" href="https://www.sandeepnambiar.com/getting-started-with-bgfx/">Using the bgfx library with C++ on Ubuntu</a> tutorial.</p>
</div>
<div class="section" id="general">
<h2>General<a class="headerlink" href="#general" title="Permalink to this headline"></a></h2>
@@ -3005,7 +3005,7 @@ known until the last moment, view ids can be remaped to arbitrary order by calli
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_handle</span></code>: Vertex buffer. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_startVertex</span></code>: First vertex to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numVertices</span></code>: Number of vertices to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: <a class="reference internal" href="#structbgfx_1_1_vertex_layout"><span class="std std-ref">VertexLayout</span></a> handle for aliasing vertex buffer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: Vertex layout for aliasing vertex buffer.</p></li>
</ul>
</dd>
</dl>
@@ -3040,7 +3040,7 @@ known until the last moment, view ids can be remaped to arbitrary order by calli
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_handle</span></code>: Dynamic vertex buffer. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_startVertex</span></code>: First vertex to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numVertices</span></code>: Number of vertices to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: <a class="reference internal" href="#structbgfx_1_1_vertex_layout"><span class="std std-ref">VertexLayout</span></a> handle for aliasing vertex buffer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: Vertex layout for aliasing vertex buffer.</p></li>
</ul>
</dd>
</dl>
@@ -3075,7 +3075,7 @@ known until the last moment, view ids can be remaped to arbitrary order by calli
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_tvb</span></code>: Transient vertex buffer. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_startVertex</span></code>: First vertex to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numVertices</span></code>: Number of vertices to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: <a class="reference internal" href="#structbgfx_1_1_vertex_layout"><span class="std std-ref">VertexLayout</span></a> handle for aliasing vertex buffer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: Vertex layout for aliasing vertex buffer.</p></li>
</ul>
</dd>
</dl>
@@ -4158,7 +4158,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_handle</span></code>: Vertex buffer. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_startVertex</span></code>: First vertex to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numVertices</span></code>: Number of vertices to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: <a class="reference internal" href="#structbgfx_1_1_vertex_layout"><span class="std std-ref">VertexLayout</span></a> handle for aliasing vertex buffer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: Vertex layout for aliasing vertex buffer.</p></li>
</ul>
</dd>
</dl>
@@ -4193,7 +4193,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_handle</span></code>: Dynamic vertex buffer. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_startVertex</span></code>: First vertex to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numVertices</span></code>: Number of vertices to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: <a class="reference internal" href="#structbgfx_1_1_vertex_layout"><span class="std std-ref">VertexLayout</span></a> handle for aliasing vertex buffer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: Vertex layout for aliasing vertex buffer.</p></li>
</ul>
</dd>
</dl>
@@ -4278,7 +4278,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_tvb</span></code>: Transient vertex buffer. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_startVertex</span></code>: First vertex to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_numVertices</span></code>: Number of vertices to render. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: <a class="reference internal" href="#structbgfx_1_1_vertex_layout"><span class="std std-ref">VertexLayout</span></a> handle for aliasing vertex buffer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[in]</span> <span class="pre">_layoutHandle</span></code>: Vertex layout for aliasing vertex buffer.</p></li>
</ul>
</dd>
</dl>
@@ -7048,7 +7048,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
build.html
+1 -1
View File
@@ -384,7 +384,7 @@ system.</p>
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
examples.html
+1 -1
View File
@@ -1225,7 +1225,7 @@ off programatically.</p>
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
genindex.html
+1 -1
View File
@@ -1326,7 +1326,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
index.html
+1 -1
View File
@@ -360,7 +360,7 @@ licensed under permissive BSD-2 clause open source license.</p>
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
internals.html
+1 -1
View File
@@ -228,7 +228,7 @@ SDK</a>, <a class="reference external" href="http://www.malideveloper.com/">Mali
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
license.html
+1 -1
View File
@@ -436,7 +436,7 @@ contour texturing.</p>
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
overview.html
+5 -1
View File
@@ -559,6 +559,10 @@ minimal bgfx example.</p></li>
<li><p>Daniel Gavin (<a class="reference external" href="https://github.com/DanielGavin">&#64;DanielGavin</a>) - <a class="reference external" href="examples.html#tess">41-tess</a> example.</p></li>
<li><p>Ji-yong Kwon (<a class="reference external" href="https://github.com/rinthel">&#64;rinthel</a>) - Vulkan rendering backend.</p></li>
<li><p>Leandro Freire (<a class="reference external" href="https://github.com/leandrolfre">&#64;leandrolfre</a>).</p></li>
<li><p>Ari Vuollet (<a class="reference external" href="https://github.com/GoaLitiuM">&#64;GoaLitiuM</a>) IDL generator for D language
bindings.</p></li>
<li><p>Sebastian Marketsmueller (<a class="reference external" href="https://github.com/sebastianmunity3d">&#64;sebastianmunity3d</a>).</p></li>
<li><p>Cedric Guillemet (<a class="reference external" href="https://github.com/CedricGuillemet">&#64;CedricGuillemet</a>).</p></li>
</ul>
</div></blockquote>
<p>and <a class="reference external" href="https://github.com/bkaradzic/bgfx/graphs/contributors">others</a>…</p>
@@ -591,7 +595,7 @@ minimal bgfx example.</p></li>
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
search.html
+1 -1
View File
@@ -177,7 +177,7 @@
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>
searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long
tools.html
+1 -1
View File
@@ -227,7 +227,7 @@ shaders is provided in examples. D3D9 and D3D11 shaders can be only compiled on
<div role="contentinfo">
<p>
&copy; Copyright 2010-2018, Branimir Karadžić
&copy; Copyright 2010-2019, Branimir Karadžić
</p>
</div>