mirror of https://github.com/bkaradzic/bgfx
Updated docs.
This commit is contained in:
parent
222622db72
commit
b07035ae42
|
@ -1,6 +1,6 @@
|
|||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '1.118.8367',
|
||||
VERSION: '1.118.8481',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>API Reference — bgfx 1.118.8367 documentation</title>
|
||||
<title>API Reference — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -31,7 +31,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -7941,7 +7941,7 @@ Otherwise, use <cite>bgfx::setViewScissor</cite>.</p>
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
10
build.html
10
build.html
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Building — bgfx 1.118.8367 documentation</title>
|
||||
<title>Building — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -31,7 +31,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -174,7 +174,7 @@ You must use use <strong>cmd.exe</strong> with provided makefiles.</p>
|
|||
<section id="build">
|
||||
<h2>Build<a class="headerlink" href="#build" title="Permalink to this heading">¶</a></h2>
|
||||
<p>bgfx uses <a class="reference external" href="https://github.com/bkaradzic/genie#genie---project-generator-tool">GENie - Project generator tool</a>
|
||||
to generate project files for various platform. Binaries for Linux, OSX, and Windows are included in
|
||||
to generate project files for various platform. Binaries for Linux, macOS, and Windows are included in
|
||||
bx repository.</p>
|
||||
<section id="general">
|
||||
<h3>General<a class="headerlink" href="#general" title="Permalink to this heading">¶</a></h3>
|
||||
|
@ -250,7 +250,7 @@ configuration file, it has to be set manually for each example project:</p>
|
|||
<p>For ease of integration to other build system bgfx library can be built
|
||||
with single .cpp file. It’s only necessary to build
|
||||
<a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/src/amalgamated.cpp">src/amalgamated.cpp</a>
|
||||
(for OSX/iOS use
|
||||
(for macOS/iOS/iPadOS/tvOS use
|
||||
<a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/src/amalgamated.mm">src/amalgamated.mm</a>
|
||||
instead) inside different build system.</p>
|
||||
</section>
|
||||
|
@ -298,7 +298,7 @@ system.</p>
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Examples — bgfx 1.118.8367 documentation</title>
|
||||
<title>Examples — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -31,7 +31,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -1239,7 +1239,7 @@ from lower resolution inputs.</p>
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — bgfx 1.118.8367 documentation</title>
|
||||
<title>Index — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -28,7 +28,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -1305,7 +1305,7 @@
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Documentation — bgfx 1.118.8367 documentation</title>
|
||||
<title>Documentation — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -30,7 +30,7 @@
|
|||
<a href="#" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -230,6 +230,8 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<li class="toctree-l2"><a class="reference internal" href="tools.html#shader-compiler-shaderc">Shader Compiler (shaderc)</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tools.html#defines">Defines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tools.html#predefined-uniforms">Predefined Uniforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tools.html#vertex-shader-attributes">Vertex Shader Attributes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tools.html#options">Options</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tools.html#building-shaders">Building shaders</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
@ -270,7 +272,7 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Internals — bgfx 1.118.8367 documentation</title>
|
||||
<title>Internals — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -31,7 +31,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -116,7 +116,7 @@
|
|||
</section>
|
||||
<section id="customization">
|
||||
<h2>Customization<a class="headerlink" href="#customization" title="Permalink to this heading">¶</a></h2>
|
||||
<p>By default each platform has sane default values. For example on Windows default renderer is DirectX, on Linux it is OpenGL, and on OSX it’s Metal. On Windows platform almost all rendering backends are available. For OpenGL ES on desktop you can find more information at:- <a class="reference external" href="http://www.g-truc.net/post-0457.html">OpenGL ES 2.0 and EGL on desktop</a></p>
|
||||
<p>By default each platform has sane default values. For example on Windows default renderer is DirectX, on Linux it is OpenGL, and on macOS it’s Metal. On Windows platform almost all rendering backends are available. For OpenGL ES on desktop you can find more information at:- <a class="reference external" href="http://www.g-truc.net/post-0457.html">OpenGL ES 2.0 and EGL on desktop</a></p>
|
||||
<p>If you’re targeting specific mobile hardware, you can find GLES support in their official SDKs: <a class="reference external" href="http://developer.qualcomm.com/mobile-development/mobile-technologies/gaming-graphics-optimization-adreno/tools-and-resources">Adreno
|
||||
SDK</a>, <a class="reference external" href="http://www.malideveloper.com/">Mali SDK</a>, <a class="reference external" href="http://www.imgtec.com/powervr/insider/sdkdownloads/">PowerVR SDK</a>.</p>
|
||||
<p>All configuration settings are located inside <a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/src/config.h">src/config.h</a>.</p>
|
||||
|
@ -139,7 +139,7 @@ SDK</a>, <a class="reference external" href="http://www.malideveloper.com/">Mali
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>License — bgfx 1.118.8367 documentation</title>
|
||||
<title>License — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -30,7 +30,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -82,7 +82,7 @@
|
|||
<h1>License<a class="headerlink" href="#license" title="Permalink to this heading">¶</a></h1>
|
||||
<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 heading">¶</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">2022</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">2023</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>
|
||||
|
@ -261,7 +261,7 @@ directory.</p>
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Overview — bgfx 1.118.8367 documentation</title>
|
||||
<title>Overview — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -31,7 +31,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -129,10 +129,10 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<ul class="simple">
|
||||
<li><p>Android (14+, ARM, x86, MIPS)</p></li>
|
||||
<li><p>FreeBSD</p></li>
|
||||
<li><p>iOS (iPhone, iPad, AppleTV)</p></li>
|
||||
<li><p>iOS/iPadOS/tvOS (iPhone, iPad, AppleTV)</p></li>
|
||||
<li><p>Linux</p></li>
|
||||
<li><p>MIPS Creator CI20</p></li>
|
||||
<li><p>OSX (10.12+)</p></li>
|
||||
<li><p>macOS (11+)</p></li>
|
||||
<li><p>PlayStation 4</p></li>
|
||||
<li><p>RaspberryPi</p></li>
|
||||
<li><p>UWP (Universal Windows, Xbox One)</p></li>
|
||||
|
@ -143,9 +143,10 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<section id="supported-compilers">
|
||||
<h3>Supported Compilers<a class="headerlink" href="#supported-compilers" title="Permalink to this heading">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Clang 3.3 and above</p></li>
|
||||
<li><p>GCC 5 and above</p></li>
|
||||
<li><p>vs2017 and above</p></li>
|
||||
<li><p>Clang 11 and above</p></li>
|
||||
<li><p>GCC 8 and above</p></li>
|
||||
<li><p>VS2019 and above</p></li>
|
||||
<li><p>Apple clang 12 and above</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="supported-languages">
|
||||
|
@ -238,7 +239,7 @@ in GPA directory and add <code class="docutils literal notranslate"><span class=
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>APITrace</p></td>
|
||||
<td><p>Linux/OSX/Win</p></td>
|
||||
<td><p>Linux/macOS/Win</p></td>
|
||||
<td><p>✓</p></td>
|
||||
<td><p>✓</p></td>
|
||||
<td></td>
|
||||
|
@ -271,7 +272,7 @@ in GPA directory and add <code class="docutils literal notranslate"><span class=
|
|||
<td><p>✓</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>IntelGPA</p></td>
|
||||
<td><p>Linux/OSX/Win</p></td>
|
||||
<td><p>Linux/macOS/Win</p></td>
|
||||
<td><p>✓</p></td>
|
||||
<td><p>✓</p></td>
|
||||
<td></td>
|
||||
|
@ -416,7 +417,7 @@ licensing terms.</strong></p>
|
|||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p>Branimir Karadžić (<a class="reference external" href="https://github.com/bkaradzic">@bkaradzic</a>)</p></li>
|
||||
<li><p>Garett Bass (<a class="reference external" href="https://github.com/garettbass">@garettbass</a>) - OSX port.</p></li>
|
||||
<li><p>Garett Bass (<a class="reference external" href="https://github.com/garettbass">@garettbass</a>) - macOS port.</p></li>
|
||||
<li><p>Jeremie Roy (<a class="reference external" href="https://github.com/jeremieroy">@jeremieroy</a>) -
|
||||
<a class="reference external" href="examples.html#font">10-font</a>,
|
||||
and <a class="reference external" href="examples.html#fontsdf">11-fontsdf</a> examples.</p></li>
|
||||
|
@ -441,7 +442,7 @@ bindings, WinRT/WinPhone support.</p></li>
|
|||
<li><p>Andre Weissflog (<a class="reference external" href="https://github.com/floooh">@floooh</a>) - Alternative build system fips.</p></li>
|
||||
<li><p>Andrew Johnson (<a class="reference external" href="https://github.com/ajohnson23">@ajohnson23</a>) - TeamCity build.</p></li>
|
||||
<li><p>Tony McCrary (<a class="reference external" href="https://github.com/enleeten">@enleeten</a>) - Java language API bindings.</p></li>
|
||||
<li><p>Attila Kocsis (<a class="reference external" href="https://github.com/attilaz">@attilaz</a>) - Metal rendering backend, various OSX
|
||||
<li><p>Attila Kocsis (<a class="reference external" href="https://github.com/attilaz">@attilaz</a>) - Metal rendering backend, various macOS
|
||||
and iOS improvements and bug fixes, <a class="reference external" href="examples.html#assao">39-assao</a> example.</p></li>
|
||||
<li><p>Richard Gale (<a class="reference external" href="https://github.com/RichardGale">@RichardGale</a>) - Emscripten entry input
|
||||
handling.</p></li>
|
||||
|
@ -529,7 +530,7 @@ and <a class="reference external" href="examples.html#bokeh">45-bokeh</a> exampl
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Search — bgfx 1.118.8367 documentation</title>
|
||||
<title>Search — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
@ -31,7 +31,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="#" method="get">
|
||||
|
@ -94,7 +94,7 @@
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
File diff suppressed because one or more lines are too long
94
tools.html
94
tools.html
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Tools — bgfx 1.118.8367 documentation</title>
|
||||
<title>Tools — bgfx 1.118.8481 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
|
@ -31,7 +31,7 @@
|
|||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
</a>
|
||||
<div class="version">
|
||||
1.118.8367
|
||||
1.118.8481
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
|
@ -52,6 +52,8 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="#shader-compiler-shaderc">Shader Compiler (shaderc)</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#defines">Defines</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#predefined-uniforms">Predefined Uniforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#vertex-shader-attributes">Vertex Shader Attributes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#options">Options</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#building-shaders">Building shaders</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
@ -372,6 +374,92 @@ This file cannot include comments, and typically only one is necessary.</p></li>
|
|||
</table>
|
||||
</div></blockquote>
|
||||
<p>For more info, see the <a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/src/bgfx_shader.sh">shader helper macros</a>.</p>
|
||||
</section>
|
||||
<section id="vertex-shader-attributes">
|
||||
<h3>Vertex Shader Attributes<a class="headerlink" href="#vertex-shader-attributes" title="Permalink to this heading">¶</a></h3>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">$input</span></code> tokens for vertex shader can be only following:</p>
|
||||
<blockquote>
|
||||
<div><table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 46%" />
|
||||
<col style="width: 54%" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
|
||||
<th class="head"><p>bgfx::Attrib::Enum</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>a_position</p></td>
|
||||
<td><p>Position</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_normal</p></td>
|
||||
<td><p>Normal</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_tangent</p></td>
|
||||
<td><p>Tangent</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_bitangent</p></td>
|
||||
<td><p>Bitangent</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_color0</p></td>
|
||||
<td><p>Color0</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_color1</p></td>
|
||||
<td><p>Color1</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_color2</p></td>
|
||||
<td><p>Color2</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_color3</p></td>
|
||||
<td><p>Color3</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_indices</p></td>
|
||||
<td><p>Indices</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_weight</p></td>
|
||||
<td><p>Weight</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_texcoord0</p></td>
|
||||
<td><p>TexCoord0</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_texcoord1</p></td>
|
||||
<td><p>TexCoord1</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_texcoord2</p></td>
|
||||
<td><p>TexCoord2</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_texcoord3</p></td>
|
||||
<td><p>TexCoord3</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_texcoord4</p></td>
|
||||
<td><p>TexCoord4</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_texcoord5</p></td>
|
||||
<td><p>TexCoord5</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>a_texcoord6</p></td>
|
||||
<td><p>TexCoord6</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>a_texcoord7</p></td>
|
||||
<td><p>TexCoord7</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></blockquote>
|
||||
<p>In <code class="docutils literal notranslate"><span class="pre">varying.def.sc</span></code>, instance buffer input must use <code class="docutils literal notranslate"><span class="pre">i_dataN</span></code> as identifier where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the index
|
||||
of the attribute in the buffer. Type must be <code class="docutils literal notranslate"><span class="pre">vec4</span></code>, and the stride must be multiple of 16.
|
||||
The semantic must be <code class="docutils literal notranslate"><span class="pre">TEXCOORDN</span></code> with a decreasing index starting from <code class="docutils literal notranslate"><span class="pre">TEXCOORD7</span></code>.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">vec4</span> <span class="n">i_data0</span> <span class="p">:</span> <span class="n">TEXCOORD7</span><span class="p">;</span>
|
||||
<span class="n">vec4</span> <span class="n">i_data1</span> <span class="p">:</span> <span class="n">TEXCOORD6</span><span class="p">;</span>
|
||||
<span class="n">vec4</span> <span class="n">i_data2</span> <span class="p">:</span> <span class="n">TEXCOORD5</span><span class="p">;</span>
|
||||
<span class="n">vec4</span> <span class="n">i_data3</span> <span class="p">:</span> <span class="n">TEXCOORD4</span><span class="p">;</span>
|
||||
<span class="n">vec4</span> <span class="n">i_data4</span> <span class="p">:</span> <span class="n">TEXCOORD3</span><span class="p">;</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="options">
|
||||
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Options:</p>
|
||||
<blockquote>
|
||||
<div><dl class="option-list">
|
||||
|
@ -607,7 +695,7 @@ aspect ratio will be preserved)</p>
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2010-2022, Branimir Karadžić.</p>
|
||||
<p>© Copyright 2010-2023, Branimir Karadžić.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue