mirror of
https://github.com/bkaradzic/bgfx.git
synced 2026-02-17 20:52:36 +01:00
Updated docs.
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1 +1,3 @@
|
||||
.build
|
||||
examples
|
||||
tools
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
const DOCUMENTATION_OPTIONS = {
|
||||
VERSION: '1.135.9039',
|
||||
VERSION: '1.136.9083',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
|
||||
18
bgfx.html
18
bgfx.html
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>API Reference — bgfx 1.135.9039 documentation</title>
|
||||
<title>API Reference — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
@@ -323,9 +323,11 @@
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>If you’re just getting started with bgfx, you might get more out of these simple walkthroughs for how to use bgfx’s API:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://dev.to/pperon/hello-bgfx-4dka">Hello, bgfx!</a></p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/jpcy/bgfx-minimal-example#bgfx-minimal-example">bgfx-minimal-example</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.sandeepnambiar.com/getting-started-with-bgfx/">Using the bgfx library with C++ on Ubuntu</a></p></li>
|
||||
<li><p><a class="reference external" href="https://dev.to/pperon/hello-bgfx-4dka">Hello, bgfx! (tutorial)</a></p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/jpcy/bgfx-minimal-example#bgfx-minimal-example">bgfx-minimal-example (repo on GitHub)</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.sandeepnambiar.com/getting-started-with-bgfx/">Using the bgfx library with C++ on Ubuntu (tutorial)</a></p></li>
|
||||
<li><p><a class="reference external" href="https://www.youtube.com/playlist?list=PLwFtWV3PS6y_oTOfHjbE0Zk8N9_QuQlHy">Getting started with BGFX (playlist on Youtube)</a></p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/gamecoder-nz/Getting-Started-With-BGFX">Getting started with BGFX (repo on GitHub)</a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section id="general">
|
||||
@@ -389,6 +391,12 @@
|
||||
<dd><p>Enable device for profiling. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp var">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N4bgfx4Init8fallbackE">
|
||||
<span id="_CPPv3N4bgfx4Init8fallbackE"></span><span id="_CPPv2N4bgfx4Init8fallbackE"></span><span id="bgfx::Init::fallback__b"></span><span class="target" id="structbgfx_1_1_init_1aefe6e75e932796ecae19dead24ba6e1a"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">fallback</span></span></span><a class="headerlink" href="#_CPPv4N4bgfx4Init8fallbackE" title="Link to this definition"></a><br /></dt>
|
||||
<dd><p>Enable fallback to next available renderer. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="cpp var">
|
||||
<dt class="sig sig-object cpp" id="_CPPv4N4bgfx4Init12platformDataE">
|
||||
<span id="_CPPv3N4bgfx4Init12platformDataE"></span><span id="_CPPv2N4bgfx4Init12platformDataE"></span><span id="bgfx::Init::platformData__PlatformData"></span><span class="target" id="structbgfx_1_1_init_1a45c9bd57be8ff9a4ecd1fc180d8526c9"></span><a class="reference internal" href="#_CPPv4N4bgfx12PlatformDataE" title="bgfx::PlatformData"><span class="n"><span class="pre">PlatformData</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">platformData</span></span></span><a class="headerlink" href="#_CPPv4N4bgfx4Init12platformDataE" title="Link to this definition"></a><br /></dt>
|
||||
|
||||
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Building — bgfx 1.135.9039 documentation</title>
|
||||
<title>Building — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
|
||||
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Examples — bgfx 1.135.9039 documentation</title>
|
||||
<title>Examples — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
|
||||
@@ -5,14 +5,14 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — bgfx 1.135.9039 documentation</title>
|
||||
<title>Index — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
@@ -429,6 +429,8 @@
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx4Init5debugE">bgfx::Init::debug (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx4Init8deviceIdE">bgfx::Init::deviceId (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx4Init8fallbackE">bgfx::Init::fallback (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx4Init6limitsE">bgfx::Init::limits (C++ member)</a>
|
||||
</li>
|
||||
|
||||
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Documentation — bgfx 1.135.9039 documentation</title>
|
||||
<title>Documentation — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
|
||||
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Internals — bgfx 1.135.9039 documentation</title>
|
||||
<title>Internals — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
|
||||
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>License — bgfx 1.135.9039 documentation</title>
|
||||
<title>License — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Overview — bgfx 1.135.9039 documentation</title>
|
||||
<title>Overview — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
@@ -178,7 +178,7 @@ licensed under permissive BSD-2 clause open source license.</p>
|
||||
<li><p><a class="reference external" href="https://github.com/bkaradzic/bgfx/discussions">GitHub Discussions</a></p></li>
|
||||
<li><p><a class="reference external" href="https://discord.gg/9eMbv7J">Discord Chat</a></p></li>
|
||||
<li><p>GitHub <a class="reference external" href="https://github.com/bkaradzic">@bkaradzic</a></p></li>
|
||||
<li><p>Twitter <a class="reference external" href="https://twitter.com/bkaradzic">@bkaradzic</a></p></li>
|
||||
<li><p>X <a class="reference external" href="https://x.com/bkaradzic">@bkaradzic</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
@@ -331,7 +331,9 @@ and <a class="reference external" href="examples.html#bokeh">45-bokeh</a> exampl
|
||||
<li><p>Raziel Alphadios (<a class="reference external" href="https://github.com/RazielXYZ">@RazielXYZ</a>) - Various fixes and improvements.</p></li>
|
||||
<li><p>IchorDev (<a class="reference external" href="https://github.com/ichordev">@IchorDev</a>) - Improved D language bindings.</p></li>
|
||||
<li><p>Martijn Courteaux (<a class="reference external" href="https://github.com/mcourteaux">@Martijn Courteaux</a>) - Various fixes and improvements.</p></li>
|
||||
<li><p>JazielGuerrero (<a class="reference external" href="https://github.com/JazielGuerrero">@JazielGuerrero</a>) - C3 language bindings.</p></li>
|
||||
<li><p>Jaziel Guerrero (<a class="reference external" href="https://github.com/JazielGuerrero">@JazielGuerrero</a>) - C3 language bindings.</p></li>
|
||||
<li><p>gamecoder-nz (<a class="reference external" href="Mhttps://github.com/gamecoder-nz">@gamecoder-nz</a>) - “Getting Started with BGFX”
|
||||
tutorial series on Youtube.</p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>and <a class="reference external" href="https://github.com/bkaradzic/bgfx/graphs/contributors">others</a>…</p>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Search — bgfx 1.135.9039 documentation</title>
|
||||
<title>Search — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -6,14 +6,14 @@
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Tools — bgfx 1.135.9039 documentation</title>
|
||||
<title>Tools — bgfx 1.136.9083 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=35fa3054"></script>
|
||||
<script src="_static/documentation_options.js?v=f601d78d"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
|
||||
Reference in New Issue
Block a user