Updated docs.

This commit is contained in:
Бранимир Караџић 2022-09-02 08:11:57 -07:00
parent 274da4c0a2
commit 68fb9154e6
13 changed files with 244 additions and 66 deletions

View File

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

View File

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

View File

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

View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Examples &mdash; bgfx 1.115.8268 documentation</title> <title>Examples &mdash; bgfx 1.115.8277 documentation</title>
@ -61,7 +61,7 @@
<div class="version"> <div class="version">
1.115.8268 1.115.8277
</div> </div>
@ -141,7 +141,7 @@
<li class="toctree-l2"><a class="reference internal" href="#sss">44-sss</a></li> <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="#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="#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="#pixelformats">47-pixelformats</a></li>
<li class="toctree-l2"><a class="reference internal" href="#drawindirect">48-drawindirect</a></li> <li class="toctree-l2"><a class="reference internal" href="#drawindirect">48-drawindirect</a></li>
</ul> </ul>
</li> </li>
@ -1270,8 +1270,8 @@ from lower resolution inputs.</p>
<img alt="example-46-fsr" src="https://github.com/bkaradzic/bgfx/raw/master/examples/46-fsr/screenshot.png" /> <img alt="example-46-fsr" src="https://github.com/bkaradzic/bgfx/raw/master/examples/46-fsr/screenshot.png" />
</div> </div>
</div> </div>
<div class="section" id="pixel-formats"> <div class="section" id="pixelformats">
<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> <h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/47-pixelformats">47-pixelformats</a><a class="headerlink" href="#pixelformats" title="Permalink to this headline"></a></h2>
<p>Pixel Formats</p> <p>Pixel Formats</p>
<p>View and test texture formats</p> <p>View and test texture formats</p>
<div class="figure align-default"> <div class="figure align-default">

View File

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

View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documentation &mdash; bgfx 1.115.8268 documentation</title> <title>Documentation &mdash; bgfx 1.115.8277 documentation</title>
@ -60,7 +60,7 @@
<div class="version"> <div class="version">
1.115.8268 1.115.8277
</div> </div>
@ -270,7 +270,7 @@ 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#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#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#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#pixelformats">47-pixelformats</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawindirect">48-drawindirect</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#drawindirect">48-drawindirect</a></li>
</ul> </ul>
</li> </li>
@ -310,6 +310,8 @@ licensed under permissive BSD-2 clause open source license.</p>
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li> <li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-viewer-geometryv">Geometry Viewer (geometryv)</a></li> <li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-viewer-geometryv">Geometry Viewer (geometryv)</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools.html#shader-compiler-shaderc">Shader Compiler (shaderc)</a><ul> <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#building-shaders">Building shaders</a></li> <li class="toctree-l3"><a class="reference internal" href="tools.html#building-shaders">Building shaders</a></li>
</ul> </ul>
</li> </li>

View File

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

View File

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

Binary file not shown.

View File

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

View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; bgfx 1.115.8268 documentation</title> <title>Search &mdash; bgfx 1.115.8277 documentation</title>
@ -61,7 +61,7 @@
<div class="version"> <div class="version">
1.115.8268 1.115.8277
</div> </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"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Tools &mdash; bgfx 1.115.8268 documentation</title> <title>Tools &mdash; bgfx 1.115.8277 documentation</title>
@ -61,7 +61,7 @@
<div class="version"> <div class="version">
1.115.8268 1.115.8277
</div> </div>
@ -95,6 +95,8 @@
<li class="toctree-l2"><a class="reference internal" href="#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li> <li class="toctree-l2"><a class="reference internal" href="#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#geometry-viewer-geometryv">Geometry Viewer (geometryv)</a></li> <li class="toctree-l2"><a class="reference internal" href="#geometry-viewer-geometryv">Geometry Viewer (geometryv)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#shader-compiler-shaderc">Shader Compiler (shaderc)</a><ul> <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="#building-shaders">Building shaders</a></li> <li class="toctree-l3"><a class="reference internal" href="#building-shaders">Building shaders</a></li>
</ul> </ul>
</li> </li>
@ -218,7 +220,7 @@
</dd> </dd>
<dt><kbd><span class="option">-s</span>, <span class="option">--scale <var>&lt;num&gt;</var></span></kbd></dt> <dt><kbd><span class="option">-s</span>, <span class="option">--scale <var>&lt;num&gt;</var></span></kbd></dt>
<dd><p>Scale factor.</p> <dd><p>Scale factor.</p>
</dd> <dl class="option-list">
<dt><kbd><span class="option">--ccw</span></kbd></dt> <dt><kbd><span class="option">--ccw</span></kbd></dt>
<dd><p>Front face is counter-clockwise winding order.</p> <dd><p>Front face is counter-clockwise winding order.</p>
</dd> </dd>
@ -226,30 +228,38 @@
<dd><p>Flip texture coordinate V.</p> <dd><p>Flip texture coordinate V.</p>
</dd> </dd>
<dt><kbd><span class="option">--obb <var>&lt;num&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--obb <var>&lt;num&gt;</var></span></kbd></dt>
<dd><p>Number of steps for calculating oriented bounding box.</p> <dd><div class="line-block">
<p>Defaults to 17.</p> <div class="line">Number of steps for calculating oriented bounding box.</div>
<p>Less steps = less precise OBB.</p> <div class="line">Defaults to 17.</div>
<p>More steps = slower calculation.</p> <div class="line">Less steps = less precise OBB.</div>
<div class="line">More steps = slower calculation.</div>
</div>
</dd> </dd>
<dt><kbd><span class="option">--packnormal <var>&lt;num&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--packnormal <var>&lt;num&gt;</var></span></kbd></dt>
<dd><p>Normal packing. <dd><div class="line-block">
0 - unpacked 12 bytes. (Default) <div class="line">Normal packing.</div>
1 - packed 4 bytes.</p> <div class="line">0 - unpacked 12 bytes. (default)</div>
<div class="line">1 - packed 4 bytes.</div>
</div>
</dd> </dd>
<dt><kbd><span class="option">--packuv <var>&lt;num&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--packuv <var>&lt;num&gt;</var></span></kbd></dt>
<dd><p>Texture coordinate packing. <dd><div class="line-block">
0 - unpacked 8 bytes. (Default) <div class="line">Texture coordinate packing.</div>
1 - packed 4 bytes.</p> <div class="line">0 - unpacked 8 bytes. (default)</div>
<div class="line">1 - packed 4 bytes.</div>
</div>
</dd> </dd>
<dt><kbd><span class="option">--tangent</span></kbd></dt> <dt><kbd><span class="option">--tangent</span></kbd></dt>
<dd><p>Calculate tangent vectors. (Packing mode is the same as normal)</p> <dd><p>Calculate tangent vectors. (packing mode is the same as normal)</p>
</dd> </dd>
<dt><kbd><span class="option">--barycentric</span></kbd></dt> <dt><kbd><span class="option">--barycentric</span></kbd></dt>
<dd><p>Adds barycentric vertex attribute. (Packed in bgfx::Attrib::Color1)</p> <dd><p>Adds barycentric vertex attribute. (Packed in bgfx::Attrib::Color1)</p>
</dd> </dd>
</dl>
</dd>
<dt><kbd><span class="option">-c</span>, <span class="option">--compress</span></kbd></dt> <dt><kbd><span class="option">-c</span>, <span class="option">--compress</span></kbd></dt>
<dd><p>Compress indices. <dd><p>Compress indices.</p>
[l/r]h-up+[y/z] Coordinate system. Defaults to lh-up+y — Left-Handed +Y is up.</p> <p>[l/r]h-up+[y/z] Coordinate system. Defaults to lh-up+y — Left-Handed +Y is up.</p>
</dd> </dd>
</dl> </dl>
</div></blockquote> </div></blockquote>
@ -279,6 +289,171 @@ This file cannot include comments, and typically only one is necessary.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">$input/$output</span></code> tokens corresponding to inputs and outputs defined in <li><p><code class="docutils literal notranslate"><span class="pre">$input/$output</span></code> tokens corresponding to inputs and outputs defined in
<code class="docutils literal notranslate"><span class="pre">varying.def.sc</span></code> must be used at the beginning of shader.</p></li> <code class="docutils literal notranslate"><span class="pre">varying.def.sc</span></code> must be used at the beginning of shader.</p></li>
</ul> </ul>
<div class="section" id="defines">
<h3>Defines<a class="headerlink" href="#defines" title="Permalink to this headline"></a></h3>
<p>Shader Compiler also has the following default defines (default value is set to 0):</p>
<blockquote>
<div><table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 24%" />
<col style="width: 43%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Define symbol</p></th>
<th class="head"><p>Description</p></th>
<th class="head"><p>Option</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_ANDROID</span></code></p></td>
<td><p>Android platform</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">android</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_EMSCRIPTEN</span></code></p></td>
<td><p>Emscripten platform</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">asm.js</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_IOS</span></code></p></td>
<td><p>iOS platform</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">ios</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_LINUX</span></code></p></td>
<td><p>Linux platform</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">linux</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_OSX</span></code></p></td>
<td><p>macOS platform</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">osx</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_PS4</span></code></p></td>
<td><p>PlayStation 4 platform</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">orbis</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_WINDOWS</span></code></p></td>
<td><p>Windows platform</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">windows</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BX_PLATFORM_XBOXONE</span></code></p></td>
<td><p><em>Not implemented</em></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_LANGUAGE_GLSL</span></code></p></td>
<td><p>GLSL profile</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">NNN</span></code> and <code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">NNN_es</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_LANGUAGE_HLSL</span></code></p></td>
<td><p>HLSL profile</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">s_N_N</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_LANGUAGE_METAL</span></code></p></td>
<td><p>Metal profile</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">metal</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_LANGUAGE_PSSL</span></code></p></td>
<td><p>PSSL profile</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">pssl</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_LANGUAGE_SPIRV</span></code></p></td>
<td><p>SPIR-V profile</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">spirv</span></code> and <code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">spirvNN-NN</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_TYPE_COMPUTE</span></code></p></td>
<td><p>Compute shader</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--type</span> <span class="pre">compute</span></code> or <code class="docutils literal notranslate"><span class="pre">--type</span> <span class="pre">c</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_TYPE_FRAGMENT</span></code></p></td>
<td><p>Fragment shader</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--type</span> <span class="pre">fragment</span></code> or <code class="docutils literal notranslate"><span class="pre">--type</span> <span class="pre">f</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BGFX_SHADER_TYPE_VERTEX</span></code></p></td>
<td><p>Vertex shader</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">--type</span> <span class="pre">vertex</span></code> or <code class="docutils literal notranslate"><span class="pre">--type</span> <span class="pre">v</span></code></p></td>
</tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="predefined-uniforms">
<h3>Predefined Uniforms<a class="headerlink" href="#predefined-uniforms" title="Permalink to this headline"></a></h3>
<blockquote>
<div><table class="docutils align-default">
<colgroup>
<col style="width: 7%" />
<col style="width: 20%" />
<col style="width: 72%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>vec4</p></td>
<td><p>u_viewRect</p></td>
<td><div class="line-block">
<div class="line">View rectangle.</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">u_viewRect.xy</span></code> - xy offset in screen space.</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">u_viewRect.zw</span></code> - width/height size in screen space.</div>
</div>
</td>
</tr>
<tr class="row-odd"><td><p>vec4</p></td>
<td><p>u_viewTexel</p></td>
<td><div class="line-block">
<div class="line">Screen-to-texel space conversion.</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">u_viewTexel.xy</span> <span class="pre">=</span> <span class="pre">1.0/u_viewRect.zw;</span></code></div>
</div>
</td>
</tr>
<tr class="row-even"><td><p>mat4</p></td>
<td><p>u_view</p></td>
<td><p>Transform world-to-view space.</p></td>
</tr>
<tr class="row-odd"><td><p>mat4</p></td>
<td><p>u_invView</p></td>
<td><p>Transform view-to-world space.</p></td>
</tr>
<tr class="row-even"><td><p>mat4</p></td>
<td><p>u_proj</p></td>
<td><p>Transform view-to-clip space.</p></td>
</tr>
<tr class="row-odd"><td><p>mat4</p></td>
<td><p>u_invProj</p></td>
<td><p>Transform clip-to-view space.</p></td>
</tr>
<tr class="row-even"><td><p>mat4</p></td>
<td><p>u_viewProj</p></td>
<td><p>Transform world-to-clip space.</p></td>
</tr>
<tr class="row-odd"><td><p>mat4</p></td>
<td><p>u_invViewProj</p></td>
<td><p>Transform clip-to-world space.</p></td>
</tr>
<tr class="row-even"><td><p>mat4[N]</p></td>
<td><p>u_model</p></td>
<td><p>Transform local-to-world space array.</p></td>
</tr>
<tr class="row-odd"><td><p>mat4</p></td>
<td><p>u_modelView</p></td>
<td><p>Transform local-to-view space.</p></td>
</tr>
<tr class="row-even"><td><p>mat4</p></td>
<td><p>u_modelViewProj</p></td>
<td><p>Transform local-to-clip space.</p></td>
</tr>
<tr class="row-odd"><td><p>float</p></td>
<td><p>u_alphaRef</p></td>
<td><div class="line-block">
<div class="line">The reference value to which incoming alpha</div>
<div class="line">values are compared.</div>
</div>
</td>
</tr>
</tbody>
</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> <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>
<p>Options:</p> <p>Options:</p>
<blockquote> <blockquote>
@ -308,8 +483,8 @@ This file cannot include comments, and typically only one is necessary.</p></li>
<dd><p>Target platform.</p> <dd><p>Target platform.</p>
</dd> </dd>
<dt><kbd><span class="option">-p</span>, <span class="option">--profile <var>&lt;profile&gt;</var></span></kbd></dt> <dt><kbd><span class="option">-p</span>, <span class="option">--profile <var>&lt;profile&gt;</var></span></kbd></dt>
<dd><p>Shader model.</p> <dd><p>Shader model.
<p>Defaults to GLSL.</p> Defaults to GLSL.</p>
</dd> </dd>
<dt><kbd><span class="option">--preprocess</span></kbd></dt> <dt><kbd><span class="option">--preprocess</span></kbd></dt>
<dd><p>Only pre-process.</p> <dd><p>Only pre-process.</p>
@ -321,8 +496,8 @@ This file cannot include comments, and typically only one is necessary.</p></li>
<dd><p>Do not process shader. No preprocessor, and no glsl-optimizer. (GLSL only)</p> <dd><p>Do not process shader. No preprocessor, and no glsl-optimizer. (GLSL only)</p>
</dd> </dd>
<dt><kbd><span class="option">--type <var>&lt;type&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--type <var>&lt;type&gt;</var></span></kbd></dt>
<dd><p>Shader type.</p> <dd><p>Shader type.
<p>Can be vertex, fragment, or compute.</p> Can be vertex, fragment, or compute.</p>
</dd> </dd>
<dt><kbd><span class="option">--varyingdef <var>&lt;file path&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--varyingdef <var>&lt;file path&gt;</var></span></kbd></dt>
<dd><p>A varying.def.scs file path.</p> <dd><p>A varying.def.scs file path.</p>
@ -342,14 +517,15 @@ This file cannot include comments, and typically only one is necessary.</p></li>
<dd><p>Disassemble a compiled shader.</p> <dd><p>Disassemble a compiled shader.</p>
</dd> </dd>
<dt><kbd><span class="option">-O <var>&lt;level&gt;</var></span></kbd></dt> <dt><kbd><span class="option">-O <var>&lt;level&gt;</var></span></kbd></dt>
<dd><p>Set optimization level.</p> <dd><p>Set optimization level.
<p>Can be 03.</p> Can be 03.</p>
</dd> </dd>
<dt><kbd><span class="option">--Werror</span></kbd></dt> <dt><kbd><span class="option">--Werror</span></kbd></dt>
<dd><p>Treat warnings as errors.</p> <dd><p>Treat warnings as errors.</p>
</dd> </dd>
</dl> </dl>
</div></blockquote> </div></blockquote>
</div>
<div class="section" id="building-shaders"> <div class="section" id="building-shaders">
<h3>Building shaders<a class="headerlink" href="#building-shaders" title="Permalink to this headline"></a></h3> <h3>Building shaders<a class="headerlink" href="#building-shaders" title="Permalink to this headline"></a></h3>
<p>Shaders can be compiled for all renderers by using the <code class="docutils literal notranslate"><span class="pre">shaderc</span></code> tool. <p>Shaders can be compiled for all renderers by using the <code class="docutils literal notranslate"><span class="pre">shaderc</span></code> tool.
@ -427,41 +603,38 @@ D3D shaders can be only compiled on Windows.</p>
</table> </table>
</div></blockquote> </div></blockquote>
<p>Options:</p> <p>Options:</p>
<blockquote> <dl>
<div><dl class="option-list"> <dt>Options:</dt><dd><dl class="option-list">
<dt><kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></dt> <dt><kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></dt>
<dd><p>Display this help and exit.</p> <dd><p>Help.</p>
</dd> </dd>
<dt><kbd><span class="option">-v</span>, <span class="option">--version</span></kbd></dt> <dt><kbd><span class="option">-v</span>, <span class="option">--version</span></kbd></dt>
<dd><p>Output version information and exit.</p> <dd><p>Version information only.</p>
</dd> </dd>
<dt><kbd><span class="option">-f <var>&lt;file path&gt;</var></span></kbd></dt> <dt><kbd><span class="option">-f <var>&lt;file path&gt;</var></span></kbd></dt>
<dd><p>Inputs file path.</p> <dd><p>Input file path.</p>
</dd> </dd>
<dt><kbd><span class="option">-o <var>&lt;file path&gt;</var></span></kbd></dt> <dt><kbd><span class="option">-o <var>&lt;file path&gt;</var></span></kbd></dt>
<dd><p>Outputs file path.</p> <dd><p>Output file path.</p>
</dd> </dd>
<dt><kbd><span class="option">-t <var>&lt;format&gt;</var></span></kbd></dt> <dt><kbd><span class="option">-t <var>&lt;format&gt;</var></span></kbd></dt>
<dd><p>Output format type. (BC1/2/3/4/5, ETC1, PVR14, etc.)</p> <dd><p>Output format type (BC1/2/3/4/5, ETC1, PVR14, etc.).</p>
</dd> </dd>
<dt><kbd><span class="option">-q <var>&lt;quality&gt;</var></span></kbd></dt> <dt><kbd><span class="option">-q <var>&lt;quality&gt;</var></span></kbd></dt>
<dd><p>Encoding quality.</p> <dd><p>Encoding quality (default, fastest, highest).</p>
<p>Can be default, fastest, or highest.</p>
</dd> </dd>
<dt><kbd><span class="option">-m</span>, <span class="option">--mips</span></kbd></dt> <dt><kbd><span class="option">-m</span>, <span class="option">--mips</span></kbd></dt>
<dd><p>Generate mip-maps.</p> <dd><p>Generate mip-maps.
</dd> mipskip &lt;N&gt; Skip &lt;N&gt; number of mips.</p>
<dt><kbd><span class="option">--mipskip <var>&lt;N&gt;</var></span></kbd></dt>
<dd><p>Skip &lt;N&gt; number of mips.</p>
</dd> </dd>
<dt><kbd><span class="option">-n</span>, <span class="option">--normalmap</span></kbd></dt> <dt><kbd><span class="option">-n</span>, <span class="option">--normalmap</span></kbd></dt>
<dd><p>Input texture is normal map. (Implies linear)</p> <dd><p>Input texture is normal map. (Implies linear)</p>
</dd> <dl class="option-list">
<dt><kbd><span class="option">--equirect</span></kbd></dt> <dt><kbd><span class="option">--equirect</span></kbd></dt>
<dd><p>Input texture is equirectangular projection of cubemap.</p> <dd><p>Input texture is equirectangular projection of cubemap.</p>
</dd> </dd>
<dt><kbd><span class="option">--strip</span></kbd></dt> <dt><kbd><span class="option">--strip</span></kbd></dt>
<dd><p>Input texture is horizontal strip of cubemap.</p> <dd><p>Input texture is horizontal or vertical strip of cubemap.</p>
</dd> </dd>
<dt><kbd><span class="option">--sdf</span></kbd></dt> <dt><kbd><span class="option">--sdf</span></kbd></dt>
<dd><p>Compute SDF texture.</p> <dd><p>Compute SDF texture.</p>
@ -476,14 +649,14 @@ D3D shaders can be only compiled on Windows.</p>
<dd><p>Premultiply alpha into RGB channel.</p> <dd><p>Premultiply alpha into RGB channel.</p>
</dd> </dd>
<dt><kbd><span class="option">--linear</span></kbd></dt> <dt><kbd><span class="option">--linear</span></kbd></dt>
<dd><p>Input and output texture is linear color space. (Gamma correction wont be applied)</p> <dd><p>Input and output texture is linear color space (gamma correction wont be applied).</p>
</dd> </dd>
<dt><kbd><span class="option">--max <var>&lt;max size&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--max <var>&lt;max size&gt;</var></span></kbd></dt>
<dd><p>Maximum width/height. (Image will be scaled down and aspect ratio will be preserved)</p> <dd><p>Maximum width/height (image will be scaled down and
aspect ratio will be preserved)</p>
</dd> </dd>
<dt><kbd><span class="option">--radiance <var>&lt;model&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--radiance <var>&lt;model&gt;</var></span></kbd></dt>
<dd><p>Radiance cubemap filter.</p> <dd><p>Radiance cubemap filter. (Lighting model: Phong, PhongBrdf, Blinn, BlinnBrdf, GGX)</p>
<p>Model can be Phong, PhongBrdf, Blinn, BlinnBrdf, or GGX.</p>
</dd> </dd>
<dt><kbd><span class="option">--as <var>&lt;extension&gt;</var></span></kbd></dt> <dt><kbd><span class="option">--as <var>&lt;extension&gt;</var></span></kbd></dt>
<dd><p>Save as.</p> <dd><p>Save as.</p>
@ -495,7 +668,10 @@ D3D shaders can be only compiled on Windows.</p>
<dd><p><strong>DEBUG</strong> Validate that output image produced matches after loading.</p> <dd><p><strong>DEBUG</strong> Validate that output image produced matches after loading.</p>
</dd> </dd>
</dl> </dl>
</div></blockquote> </dd>
</dl>
</dd>
</dl>
</div> </div>
<div class="section" id="texture-viewer-texturev"> <div class="section" id="texture-viewer-texturev">
<h2>Texture Viewer (texturev)<a class="headerlink" href="#texture-viewer-texturev" title="Permalink to this headline"></a></h2> <h2>Texture Viewer (texturev)<a class="headerlink" href="#texture-viewer-texturev" title="Permalink to this headline"></a></h2>