mirror of
https://github.com/bkaradzic/bgfx.git
synced 2026-02-18 21:13:02 +01:00
Updated docs.
This commit is contained in:
Branimir Karadžić
68
bgfx.html
68
bgfx.html
@@ -32,7 +32,7 @@
|
||||
|
||||
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
|
||||
<link rel="next" title="Tools" href="tools.html"/>
|
||||
<link rel="prev" title="Building" href="build.html"/>
|
||||
<link rel="prev" title="Examples" href="examples.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -73,7 +73,16 @@
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -82,6 +91,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
@@ -107,6 +118,38 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -174,6 +217,25 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -3645,7 +3707,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||||
<a href="tools.html" class="btn btn-neutral float-right" title="Tools" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="build.html" class="btn btn-neutral" title="Building" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="examples.html" class="btn btn-neutral" title="Examples" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
68
build.html
68
build.html
@@ -31,7 +31,7 @@
|
||||
|
||||
|
||||
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
|
||||
<link rel="next" title="API Reference" href="bgfx.html"/>
|
||||
<link rel="next" title="Examples" href="examples.html"/>
|
||||
<link rel="prev" title="Overview" href="overview.html"/>
|
||||
|
||||
|
||||
@@ -73,7 +73,16 @@
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -82,6 +91,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Building</a><ul>
|
||||
@@ -107,6 +118,38 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -174,6 +217,25 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -411,7 +473,7 @@ enviroment variable:</p>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="bgfx.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
<a href="examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="overview.html" class="btn btn-neutral" title="Overview" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
1031
examples.html
Normal file
1031
examples.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -72,7 +72,16 @@
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -81,6 +90,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
@@ -106,6 +117,38 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -173,6 +216,25 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
152
index.html
152
index.html
@@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>bgfx - Documentation — bgfx 1.0 documentation</title>
|
||||
<title>Documentation — bgfx 1.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -72,7 +72,16 @@
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -81,6 +90,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
@@ -106,6 +117,38 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -173,6 +216,25 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -197,7 +259,7 @@
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="#">Docs</a> »</li>
|
||||
|
||||
<li>bgfx - Documentation</li>
|
||||
<li>Documentation</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
@@ -208,16 +270,32 @@
|
||||
</div>
|
||||
<div role="main" class="document">
|
||||
|
||||
<div class="section" id="bgfx-documentation">
|
||||
<h1>bgfx - Documentation<a class="headerlink" href="#bgfx-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>bgfx is Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework” style
|
||||
rendering library.</p>
|
||||
<p><a class="reference external" href="https://github.com/bkaradzic/bgfx">https://github.com/bkaradzic/bgfx</a></p>
|
||||
<p>Contents:</p>
|
||||
<div class="section" id="documentation">
|
||||
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework” style rendering library,
|
||||
licensed under permissive BSD-2 clause open source license.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Source at GitHub:</dt>
|
||||
<dd><ul class="first last simple">
|
||||
<li><a class="reference external" href="https://github.com/bkaradzic/bgfx">https://github.com/bkaradzic/bgfx</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -226,6 +304,8 @@ rendering library.</p>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
@@ -251,6 +331,38 @@ rendering library.</p>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -294,7 +406,27 @@ rendering library.</p>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
572
license.html
Normal file
572
license.html
Normal file
@@ -0,0 +1,572 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>License — bgfx 1.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
|
||||
<link rel="prev" title="Tools" href="tools.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav" role="document">
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#renderdoc">RenderDoc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#intelgpa">IntelGPA</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#dependencies">Dependencies</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#getting-source">Getting source</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#quick-start">Quick start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#prerequisites">Prerequisites</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#android">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#linux">Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#native-client">Native Client</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#windows">Windows</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#build">Build</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#general">General</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#id1">Windows</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#xcode-5">Xcode 5</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#id2">Linux</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="build.html#winrt-windows-phone-8-1">WinRT / Windows Phone 8.1</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#amalgamated-build">Amalgamated build</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#reset">Reset</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#frame">Frame</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#debug">Debug</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-features">Debug Features</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-flags">Debug Flags</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-text-display">Debug Text Display</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#querying-information">Querying information</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#renderer">Renderer</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#capabilities">Capabilities</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#statistics">Statistics</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#head-mounted-display">Head Mounted Display</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#platform-specific">Platform specific</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#miscellaneous">Miscellaneous</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#views">Views</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#draw">Draw</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#state">State</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#id1">Debug</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#id2">State</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#state-flags">State Flags</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#stencil">Stencil</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#stencil-flags">Stencil Flags</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#scissor">Scissor</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#transform">Transform</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#buffers">Buffers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#textures">Textures</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#submit">Submit</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#compute">Compute</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id3">Buffers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#images">Images</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#dispatch">Dispatch</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#resources">Resources</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#vertex-buffers">Vertex Buffers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame Buffers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#instance-buffer">Instance Buffer</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#indirect-buffer">Indirect Buffer</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tools.html">Tools</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#shader-compiler-shaderc">Shader Compiler (shaderc)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#texture-compiler-texturec">Texture Compiler (texturec)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">bgfx</a>
|
||||
</nav>
|
||||
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li>License</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document">
|
||||
|
||||
<div class="section" id="license">
|
||||
<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-python"><div class="highlight"><pre>Copyright 2010-2015 Branimir Karadzic. All rights reserved.
|
||||
|
||||
https://github.com/bkaradzic/bgfx
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
|
||||
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
|
||||
EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
||||
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
||||
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="rd-party-libraries">
|
||||
<h2>3rd Party Libraries<a class="headerlink" href="#rd-party-libraries" title="Permalink to this headline">¶</a></h2>
|
||||
<p>All required 3rd party libraries are included in bgfx repository in
|
||||
<a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/3rdparty">3rdparty/</a>
|
||||
directory.</p>
|
||||
<div class="section" id="blendish-mit">
|
||||
<h3>Blendish (MIT)<a class="headerlink" href="#blendish-mit" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Blendish - Blender 2.5 UI based theming functions for NanoVG.</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://bitbucket.org/duangle/oui-blendish">https://bitbucket.org/duangle/oui-blendish</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="edtaa3-mit">
|
||||
<h3>edtaa3 (MIT)<a class="headerlink" href="#edtaa3-mit" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Contour Rendering by Distance Fields</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/OpenGLInsights/OpenGLInsightsCode/tree/master/Chapter%2012%202D%20Shape%20Rendering%20by%20Distance%20Fields">https://github.com/OpenGLInsights/OpenGLInsightsCode/tree/master/Chapter%2012%202D%20Shape%20Rendering%20by%20Distance%20Fields</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="fcpp-bsd">
|
||||
<h3>fcpp (BSD)<a class="headerlink" href="#fcpp-bsd" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Frexx C preprocessor</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/bagder/fcpp">https://github.com/bagder/fcpp</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="forsyth-triangle-order-optimizer-public-domain">
|
||||
<h3>Forsyth Triangle Order Optimizer (Public Domain)<a class="headerlink" href="#forsyth-triangle-order-optimizer-public-domain" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://gameangst.com/?p=9">http://gameangst.com/?p=9</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="freetype">
|
||||
<h3>FreeType<a class="headerlink" href="#freetype" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.freetype.org/">http://www.freetype.org/</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="glsl-optimizer-mit">
|
||||
<h3>glsl-optimizer (MIT)<a class="headerlink" href="#glsl-optimizer-mit" title="Permalink to this headline">¶</a></h3>
|
||||
<p>GLSL optimizer based on Mesa’s GLSL compiler. Used in Unity for mobile
|
||||
shader optimization.</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/aras-p/glsl-optimizer">https://github.com/aras-p/glsl-optimizer</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="nanovg-zlib">
|
||||
<h3>NanoVG (ZLIB)<a class="headerlink" href="#nanovg-zlib" title="Permalink to this headline">¶</a></h3>
|
||||
<p>NanoVG is small antialiased vector graphics rendering library.</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/memononen/nanovg">https://github.com/memononen/nanovg</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="imgui-mit">
|
||||
<h3>ImGui (MIT)<a class="headerlink" href="#imgui-mit" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Bloat-free Immediate Mode Graphical User interface for C++ with minimal
|
||||
dependencies.</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/ocornut/imgui">https://github.com/ocornut/imgui</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="sdf-mit">
|
||||
<h3>SDF (MIT)<a class="headerlink" href="#sdf-mit" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Sweep-and-update Euclidean distance transform of an antialised image for
|
||||
contour texturing.</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/memononen/SDF">https://github.com/memononen/SDF</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="stb-public-domain">
|
||||
<h3>stb (Public Domain)<a class="headerlink" href="#stb-public-domain" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://nothings.org">http://nothings.org</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="vertex-cache-optimised-index-buffer-compression-bsd">
|
||||
<h3>Vertex Cache Optimised Index Buffer Compression (BSD)<a class="headerlink" href="#vertex-cache-optimised-index-buffer-compression-bsd" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/ConorStokes/IndexBufferCompression">https://github.com/ConorStokes/IndexBufferCompression</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="assets">
|
||||
<h2>Assets<a class="headerlink" href="#assets" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Bunny</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www-graphics.stanford.edu/data/3Dscanrep/">Stanford University Computer Graphics Laboratory</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Uffizi</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.pauldebevec.com/Probes/">Light Probe Image Gallery</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Wells</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://dativ.at/lightprobes/">Bernhard Vogl Light probes</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Pisa, Ennis, Grace</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://gl.ict.usc.edu/Data/HighResProbes/">High-Resolution Light Probe Image Gallery</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Droid Sans Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.fontsquirrel.com/license/Droid-Sans">http://www.fontsquirrel.com/license/Droid-Sans</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Bleeding Cowboys Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.dafont.com/bleeding-cowboys.font">http://www.dafont.com/bleeding-cowboys.font</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Cheap Fire Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.dafont.com/cheap-fire.font">http://www.dafont.com/cheap-fire.font</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Five Minutes Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.fonts2u.com/fiveminutes.font">http://www.fonts2u.com/fiveminutes.font</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Mias Scribblings Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.dafont.com/mias-scribblings.font">http://www.dafont.com/mias-scribblings.font</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Ruritania Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.dafont.com/ruritania.font">http://www.dafont.com/ruritania.font</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Signika Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://fontfabric.com/signika-font/">http://fontfabric.com/signika-font/</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Visitor Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.dafont.com/visitor.font">http://www.dafont.com/visitor.font</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Special-Elite Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.fontspace.com/astigmatic-one-eye-typographic-institute/special-elite">http://www.fontspace.com/astigmatic-one-eye-typographic-institute/special-elite</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>FontAwesome Font</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://fontawesome.io/">http://fontawesome.io/</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Sherlock Holmes text</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.gutenberg.org/ebooks/1661">http://www.gutenberg.org/ebooks/1661</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>Tree Pack 1</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="http://www.turbosquid.com/3d-models/free-obj-mode-tree-pack/506851">http://www.turbosquid.com/3d-models/free-obj-mode-tree-pack/506851</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
|
||||
<a href="tools.html" class="btn btn-neutral" title="Tools" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2015, Branimir Karadžić.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'1.0',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: false
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.StickyNav.enable();
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
150
overview.html
150
overview.html
@@ -32,7 +32,7 @@
|
||||
|
||||
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
|
||||
<link rel="next" title="Building" href="build.html"/>
|
||||
<link rel="prev" title="bgfx - Documentation" href="index.html"/>
|
||||
<link rel="prev" title="Documentation" href="index.html"/>
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
@@ -73,7 +73,16 @@
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -82,6 +91,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
@@ -107,6 +118,38 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -174,6 +217,25 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -213,9 +275,10 @@
|
||||
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="what-is-it">
|
||||
<h2>What is it?<a class="headerlink" href="#what-is-it" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework”
|
||||
style rendering library.</p>
|
||||
<p>Supported rendering backends:</p>
|
||||
<p>Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework” style rendering library,
|
||||
licensed under permissive BSD-2 clause open source license.</p>
|
||||
<div class="section" id="supported-rendering-backends">
|
||||
<h3>Supported rendering backends<a class="headerlink" href="#supported-rendering-backends" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Direct3D 9</li>
|
||||
<li>Direct3D 11</li>
|
||||
@@ -226,11 +289,15 @@ style rendering library.</p>
|
||||
<li>OpenGL ES 3.1</li>
|
||||
<li>WebGL 1.0</li>
|
||||
</ul>
|
||||
<p>Supported HMD:</p>
|
||||
</div>
|
||||
<div class="section" id="supported-hmd">
|
||||
<h3>Supported HMD<a class="headerlink" href="#supported-hmd" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>OculusVR (0.4.2+)</li>
|
||||
</ul>
|
||||
<p>Supported platforms:</p>
|
||||
</div>
|
||||
<div class="section" id="supported-platforms">
|
||||
<h3>Supported platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Android (14+, ARM, x86, MIPS)</li>
|
||||
<li>asm.js/Emscripten (1.25.0)</li>
|
||||
@@ -243,13 +310,17 @@ style rendering library.</p>
|
||||
<li>Windows (XP, Vista, 7, 8, 10)</li>
|
||||
<li>WinRT (WinPhone 8.0+)</li>
|
||||
</ul>
|
||||
<p>Supported compilers:</p>
|
||||
</div>
|
||||
<div class="section" id="supported-compilers">
|
||||
<h3>Supported compilers<a class="headerlink" href="#supported-compilers" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Clang 3.3 and above</li>
|
||||
<li>GCC 4.6 and above</li>
|
||||
<li>vs2008 and above</li>
|
||||
</ul>
|
||||
<p>Languages:</p>
|
||||
</div>
|
||||
<div class="section" id="supported-languages">
|
||||
<h3>Supported languages<a class="headerlink" href="#supported-languages" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://bkaradzic.github.io/bgfx/bgfx.html">C/C++ API
|
||||
documentation</a></li>
|
||||
@@ -262,6 +333,22 @@ bindings</a></li>
|
||||
bindings</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="project-page">
|
||||
<h3>Project page<a class="headerlink" href="#project-page" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/bkaradzic/bgfx">https://github.com/bkaradzic/bgfx</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contact">
|
||||
<h3>Contact<a class="headerlink" href="#contact" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li>Twitter <a class="reference external" href="https://twitter.com/bkaradzic">@bkaradzic</a></li>
|
||||
<li>GitHub <a class="reference external" href="https://github.com/bkaradzic">@bkaradzic</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="internals">
|
||||
<h2>Internals<a class="headerlink" href="#internals" title="Permalink to this headline">¶</a></h2>
|
||||
<p>bgfx is using sort-based draw call bucketing. This means that submission
|
||||
@@ -412,15 +499,15 @@ in GPA directory and add <code class="docutils literal"><span class="pre">exampl
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="line-block">
|
||||
<div class="line">Download:</div>
|
||||
<div class="line"><a class="reference external" href="https://apitrace.github.io/">APITrace</a></div>
|
||||
<div class="line"><a class="reference external" href="http://developer.amd.com/tools-and-sdks/opencl-zone/codexl/">CodeXL</a></div>
|
||||
<div class="line"><a class="reference external" href="https://github.com/imccown/Dissector">Dissector</a></div>
|
||||
<div class="line"><a class="reference external" href="https://developer.nvidia.com/nvidia-nsight-visual-studio-edition">Nsight</a></div>
|
||||
<div class="line"><a class="reference external" href="https://developer.nvidia.com/nvidia-perfhud">PerfHUD</a></div>
|
||||
<div class="line"><a class="reference external" href="https://github.com/ValveSoftware/vogl">vogl</a></div>
|
||||
</div>
|
||||
<p>Download:</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://apitrace.github.io/">APITrace</a></li>
|
||||
<li><a class="reference external" href="http://developer.amd.com/tools-and-sdks/opencl-zone/codexl/">CodeXL</a></li>
|
||||
<li><a class="reference external" href="https://github.com/imccown/Dissector">Dissector</a></li>
|
||||
<li><a class="reference external" href="https://developer.nvidia.com/nvidia-nsight-visual-studio-edition">Nsight</a></li>
|
||||
<li><a class="reference external" href="https://developer.nvidia.com/nvidia-perfhud">PerfHUD</a></li>
|
||||
<li><a class="reference external" href="https://github.com/ValveSoftware/vogl">vogl</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="sdl-glfw-etc">
|
||||
@@ -459,6 +546,31 @@ be and how multithreading interacts with context/device. To disable
|
||||
multithreaded render use <code class="docutils literal"><span class="pre">BGFX_CONFIG_MULTITHREDED=0</span></code> preprocessor
|
||||
define.</p>
|
||||
</div>
|
||||
<div class="section" id="todo">
|
||||
<h2>Todo<a class="headerlink" href="#todo" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Blit between textures.</li>
|
||||
<li>Occlusion queries.</li>
|
||||
<li>Fullscreen mode.</li>
|
||||
<li>ETC2, PVRTC1/2 decoding fallback for targets that don’t support it
|
||||
natively.</li>
|
||||
<li>shaderc as library for runtime shader building.</li>
|
||||
<li>texturec tool with support for all supported texture formats.</li>
|
||||
<li>Multiple vertex streams support.</li>
|
||||
<li>Animated mesh example.</li>
|
||||
<li>Metal renderer backend (you can follow progress
|
||||
<a class="reference external" href="https://github.com/attilaz/bgfx/tree/metal">here</a>).</li>
|
||||
<li>Vulkan renderer backend.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="getting-involved">
|
||||
<h2>Getting involved<a class="headerlink" href="#getting-involved" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Everyone is welcome to contribute to bgfx by submitting bug reports,
|
||||
testing on different platforms, writing examples, improving
|
||||
documentation, profiling and optimizing, etc.</p>
|
||||
<p><strong>When contributing to the bgfx project you must agree to the BSD 2-clause
|
||||
licensing terms.</strong></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -470,7 +582,7 @@ define.</p>
|
||||
<a href="build.html" class="btn btn-neutral float-right" title="Building" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="index.html" class="btn btn-neutral" title="bgfx - Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="index.html" class="btn btn-neutral" title="Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
64
search.html
64
search.html
@@ -71,7 +71,16 @@
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -80,6 +89,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
@@ -105,6 +116,38 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -172,6 +215,25 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
82
tools.html
82
tools.html
@@ -31,6 +31,7 @@
|
||||
|
||||
|
||||
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
|
||||
<link rel="next" title="License" href="license.html"/>
|
||||
<link rel="prev" title="API Reference" href="bgfx.html"/>
|
||||
|
||||
|
||||
@@ -72,7 +73,16 @@
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported platforms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported compilers</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported languages</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project page</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||||
@@ -81,6 +91,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting involved</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||||
@@ -106,6 +118,38 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR integration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||||
@@ -173,6 +217,25 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -237,14 +300,13 @@ macros</a>.</p>
|
||||
<h2>Texture Compiler (texturec)<a class="headerlink" href="#texture-compiler-texturec" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This tool doesn’t currently exist. To produce DDS, KTX or PVR textures
|
||||
use:</p>
|
||||
<div class="line-block">
|
||||
<div class="line"><a href="#id1"><span class="problematic" id="id2">`</span></a>.dds - nVidia Texture Tools - DDS</div>
|
||||
</div>
|
||||
<p>Utilities <<a class="reference external" href="https://developer.nvidia.com/legacy-texture-tools">https://developer.nvidia.com/legacy-texture-tools</a>>`__
|
||||
| <a class="reference external" href="http://malideveloper.arm.com/develop-for-mali/mali-gpu-texture-compression-tool/">.ktx - Mali GPU Texture Compression
|
||||
Tool</a>
|
||||
| <a class="reference external" href="http://www.imgtec.com/powervr/insider/sdkdownloads/index.asp">.pvr - PowerVR Insider
|
||||
SDK</a></p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><a class="reference external" href="https://developer.nvidia.com/legacy-texture-tools">.dds - nVidia Texture Tools - DDS Utilities</a></li>
|
||||
<li><a class="reference external" href="http://malideveloper.arm.com/develop-for-mali/mali-gpu-texture-compression-tool/">.ktx - Mali GPU Texture Compression Tool</a></li>
|
||||
<li><a class="reference external" href="http://www.imgtec.com/powervr/insider/sdkdownloads/index.asp">.pvr - PowerVR Insider SDK</a></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="geometry-compiler-geometryc">
|
||||
<h2>Geometry Compiler (geometryc)<a class="headerlink" href="#geometry-compiler-geometryc" title="Permalink to this headline">¶</a></h2>
|
||||
@@ -258,6 +320,8 @@ SDK</a></p>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="license.html" class="btn btn-neutral float-right" title="License" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="bgfx.html" class="btn btn-neutral" title="API Reference" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user