bgfx/index.html

312 lines
22 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentation &mdash; bgfx 1.127.8709 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/documentation_options.js?v=7ae1beac"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Overview" href="overview.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
bgfx
</a>
<div class="version">
1.127.8709
</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" aria-label="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="Navigation menu">
<ul>
<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"><a class="reference internal" href="examples.html">Examples</a></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="internals.html">Internals</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"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">bgfx</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Documentation</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></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="simple">
<dt>Source at GitHub:</dt><dd><ul class="simple">
<li><p><a class="reference external" href="https://github.com/bkaradzic/bgfx">https://github.com/bkaradzic/bgfx</a></p></li>
</ul>
</dd>
</dl>
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Link to this heading"></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><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-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#debugging-and-profiling">Debugging and Profiling</a><ul>
<li class="toctree-l3"><a class="reference internal" href="overview.html#renderdoc">RenderDoc</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#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#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-uwp">WinRT / UWP</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#tools">Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="build.html#alternative-build-systems">Alternative build systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="build.html#minimal-example-without-bgfx-s-example-harness">Minimal example without bgfxs example harness</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>
<li class="toctree-l2"><a class="reference internal" href="examples.html#c99">25-c99</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#occlusion">26-occlusion</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#terrain">27-terrain</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#wireframe">28-wireframe</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#debugdraw">29-debugdraw</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#picking">30-picking</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#rsm">31-rsm</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#particles">32-particles</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#pom">33-pom</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#mvs">34-mvs</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#dynamic">35-dynamic</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#sky">36-sky</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#gpudrivenrendering">37-gpudrivenrendering</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#bloom">38-bloom</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#assao">39-assao</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#svt">40-svt</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#tess">41-tess</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#bunnylod">42-bunnylod</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#denoise">43-denoise</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#sss">44-sss</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#bokeh">45-bokeh</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#fsr">46-fsr</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#pixelformats">47-pixelformats</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawindirect">48-drawindirect</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#hextile">49-hextile</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></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#debug">Debug</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#querying-information">Querying information</a></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><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx11setViewNameE6ViewIdPKc7int32_t"><code class="docutils literal notranslate"><span class="pre">setViewName()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx11setViewRectE6ViewId8uint16_t8uint16_t8uint16_t8uint16_t"><code class="docutils literal notranslate"><span class="pre">setViewRect()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx11setViewRectE6ViewId8uint16_t8uint16_tN15BackbufferRatio4EnumE"><code class="docutils literal notranslate"><span class="pre">setViewRect()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx14setViewScissorE6ViewId8uint16_t8uint16_t8uint16_t8uint16_t"><code class="docutils literal notranslate"><span class="pre">setViewScissor()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx12setViewClearE6ViewId8uint16_t8uint32_tf7uint8_t"><code class="docutils literal notranslate"><span class="pre">setViewClear()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx12setViewClearE6ViewId8uint16_tf7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t"><code class="docutils literal notranslate"><span class="pre">setViewClear()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx8ViewModeE"><code class="docutils literal notranslate"><span class="pre">ViewMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx11setViewModeE6ViewIdN8ViewMode4EnumE"><code class="docutils literal notranslate"><span class="pre">setViewMode()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx18setViewFrameBufferE6ViewId17FrameBufferHandle"><code class="docutils literal notranslate"><span class="pre">setViewFrameBuffer()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx16setViewTransformE6ViewIdPKvPKv"><code class="docutils literal notranslate"><span class="pre">setViewTransform()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx12setViewOrderE6ViewId8uint16_tPK6ViewId"><code class="docutils literal notranslate"><span class="pre">setViewOrder()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx9resetViewE6ViewId"><code class="docutils literal notranslate"><span class="pre">resetView()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#encoder">Encoder</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id1">Encoder</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#draw">Draw</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#compute">Compute</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#blit">Blit</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#_CPPv4N4bgfx6MemoryE"><code class="docutils literal notranslate"><span class="pre">Memory</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx5allocE8uint32_t"><code class="docutils literal notranslate"><span class="pre">alloc()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx4copyEPKv8uint32_t"><code class="docutils literal notranslate"><span class="pre">copy()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#_CPPv4N4bgfx7makeRefEPKv8uint32_t9ReleaseFnPv"><code class="docutils literal notranslate"><span class="pre">makeRef()</span></code></a></li>
<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#id5">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#geometry-viewer-geometryv">Geometry Viewer (geometryv)</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools.html#shader-compiler-shaderc">Shader Compiler (shaderc)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tools.html#defines">Defines</a></li>
<li class="toctree-l3"><a class="reference internal" href="tools.html#predefined-uniforms">Predefined Uniforms</a></li>
<li class="toctree-l3"><a class="reference internal" href="tools.html#vertex-shader-attributes">Vertex Shader Attributes</a></li>
<li class="toctree-l3"><a class="reference internal" href="tools.html#options">Options</a></li>
<li class="toctree-l3"><a class="reference internal" href="tools.html#building-shaders">Building shaders</a></li>
</ul>
</li>
<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="internals.html">Internals</a><ul>
<li class="toctree-l2"><a class="reference internal" href="internals.html#sort-based-draw-call-bucketing">Sort based draw call bucketing</a></li>
<li class="toctree-l2"><a class="reference internal" href="internals.html#api-and-render-thread">API and render thread</a></li>
<li class="toctree-l2"><a class="reference internal" href="internals.html#resource-api">Resource API</a></li>
<li class="toctree-l2"><a class="reference internal" href="internals.html#view-api">View API</a></li>
<li class="toctree-l2"><a class="reference internal" href="internals.html#encoder-api">Encoder API</a></li>
<li class="toctree-l2"><a class="reference internal" href="internals.html#customization">Customization</a><ul>
<li class="toctree-l3"><a class="reference internal" href="internals.html#options">Options</a></li>
</ul>
</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></li>
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="overview.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2010-2024, Branimir Karadžić.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>