mirror of
https://github.com/bkaradzic/bgfx.git
synced 2026-02-17 20:52:36 +01:00
Updated docs.
This commit is contained in:
Branimir Karadžić
215
examples.html
215
examples.html
@@ -45,17 +45,27 @@
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.0
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@@ -64,66 +74,16 @@
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
<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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#other-debuggers-and-profilers">Other Debuggers and Profilers</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><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contributors">Contributors</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="overview.html#repository-visualization">Repository visualization</a></li>
|
||||
</ul>
|
||||
</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">Xcode</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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="build.html#alternative-build-systems">Alternative build systems</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="">Examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#helloworld">00-helloworld</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#cubes">01-cubes</a></li>
|
||||
@@ -161,105 +121,15 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#debugdraw">29-debugdraw</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>
|
||||
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#conditional-rendering">Conditional Rendering</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#blit">Blit</a></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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#occlusion-query">Occlusion Query</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#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tools.html#shader-compiler-shaderc">Shader Compiler (shaderc)</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tools.html#building-shaders">Building shaders</a></li>
|
||||
</ul>
|
||||
</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#texture-viewer-texturev">Texture Viewer (texturev)</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>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tools.html">Tools</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
@@ -274,7 +144,13 @@
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
@@ -287,7 +163,8 @@
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document">
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="examples">
|
||||
<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h1>
|
||||
@@ -501,7 +378,7 @@ caching OpenGL binary shaders, and video capture.</p>
|
||||
<p>Draw stress is CPU stress test to show what is the maximimum number of
|
||||
draw calls while maintaining 60Hz frame rate. bgfx currently has default
|
||||
limit of 64K draw calls per frame. You can increase this limit by
|
||||
changing <code class="docutils literal"><span class="pre">BGFX_CONFIG_MAX_DRAW_CALLS</span></code>.</p>
|
||||
changing <tt class="docutils literal"><span class="pre">BGFX_CONFIG_MAX_DRAW_CALLS</span></tt>.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="19%" />
|
||||
@@ -924,9 +801,9 @@ changing <code class="docutils literal"><span class="pre">BGFX_CONFIG_MAX_DRAW_C
|
||||
</table>
|
||||
<p>To test browsers in 60Hz mode following changes were made:</p>
|
||||
<ul class="simple">
|
||||
<li>Firefox 27 <a class="reference external" href="about:config">about:config</a> adjustments: <code class="docutils literal"><span class="pre">webgl.prefer-native-gl</span> <span class="pre">true</span></code>
|
||||
(on Windows), and <code class="docutils literal"><span class="pre">layout.frame_rate</span> <span class="pre">500</span></code>.</li>
|
||||
<li>Chrome 33 command line option: <code class="docutils literal"><span class="pre">--disable-gpu-vsync</span></code>.</li>
|
||||
<li>Firefox 27 <a class="reference external" href="about:config">about:config</a> adjustments: <tt class="docutils literal"><span class="pre">webgl.prefer-native-gl</span> <span class="pre">true</span></tt>
|
||||
(on Windows), and <tt class="docutils literal"><span class="pre">layout.frame_rate</span> <span class="pre">500</span></tt>.</li>
|
||||
<li>Chrome 33 command line option: <tt class="docutils literal"><span class="pre">--disable-gpu-vsync</span></tt>.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="hz-test-for-browsers">
|
||||
@@ -1142,6 +1019,7 @@ off programatically.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
@@ -1160,8 +1038,9 @@ off programatically.</p>
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2016, Branimir Karadžić.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user