mirror of
https://github.com/bkaradzic/bgfx.git
synced 2026-02-17 20:52:36 +01:00
649 lines
30 KiB
HTML
649 lines
30 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>Overview — bgfx 1.115.8268 documentation</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" 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="Building" href="build.html" />
|
||
<link rel="prev" title="Documentation" href="index.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="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
1.115.8268
|
||
</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" />
|
||
<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 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><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-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="#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#renderdoc">RenderDoc</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#intelgpa">IntelGPA</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#other-debuggers-and-profilers">Other Debuggers and Profilers</a></li>
|
||
</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="#getting-involved">Getting Involved</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#contributors">Contributors</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#repository-visualization">Repository visualization</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</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="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" class="icon icon-home"></a> »</li>
|
||
|
||
<li>Overview</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">
|
||
|
||
<div class="section" id="overview">
|
||
<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,
|
||
licensed under permissive BSD-2 clause open source license.</p>
|
||
<p>
|
||
<iframe src="https://ghbtns.com/github-btn.html?user=bkaradzic&repo=bgfx&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
|
||
<iframe src="https://ghbtns.com/github-btn.html?user=bkaradzic&repo=bgfx&type=fork&count=true&size=large" frameborder="0" scrolling="0" width="158px" height="30px"></iframe>
|
||
</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><p>Direct3D 9</p></li>
|
||
<li><p>Direct3D 11</p></li>
|
||
<li><p>Direct3D 12</p></li>
|
||
<li><p>GNM (only for licensed PS4 developers, search DevNet forums for source)</p></li>
|
||
<li><p>Metal</p></li>
|
||
<li><p>OpenGL 2.1</p></li>
|
||
<li><p>OpenGL 3.1+</p></li>
|
||
<li><p>OpenGL ES 2</p></li>
|
||
<li><p>OpenGL ES 3.1</p></li>
|
||
<li><p>Vulkan</p></li>
|
||
<li><p>WebGL 1.0</p></li>
|
||
<li><p>WebGL 2.0</p></li>
|
||
<li><p>WebGPU/Dawn (experimental)</p></li>
|
||
</ul>
|
||
</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><p>Android (14+, ARM, x86, MIPS)</p></li>
|
||
<li><p>FreeBSD</p></li>
|
||
<li><p>iOS (iPhone, iPad, AppleTV)</p></li>
|
||
<li><p>Linux</p></li>
|
||
<li><p>MIPS Creator CI20</p></li>
|
||
<li><p>OSX (10.12+)</p></li>
|
||
<li><p>PlayStation 4</p></li>
|
||
<li><p>RaspberryPi</p></li>
|
||
<li><p>UWP (Universal Windows, Xbox One)</p></li>
|
||
<li><p>Wasm/Emscripten</p></li>
|
||
<li><p>Windows (XP, Vista, 7, 8, 10)</p></li>
|
||
</ul>
|
||
</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><p>Clang 3.3 and above</p></li>
|
||
<li><p>GCC 5 and above</p></li>
|
||
<li><p>vs2017 and above</p></li>
|
||
</ul>
|
||
</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><p><a class="reference external" href="https://bkaradzic.github.io/bgfx/bgfx.html">C/C++ API documentation</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/bindings/bf">Beef API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/bindings/cs">C# language API bindings #1</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/GoaLitiuM/bindbc-bgfx">D language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/james4k/go-bgfx">Go language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/haskell-game/bgfx">Haskell language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/LWJGL/lwjgl3#lwjgl---lightweight-java-game-library-3">Lightweight Java Game Library 3 bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/cloudwu/lua-bgfx">Lua language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/Halsys/nim-bgfx">Nim language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/Akira13641/PasBGFX">Pascal language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/fbertola/bgfx-python#-----bgfx-python--">Python language API bindings #1</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/jnadro/pybgfx#pybgfx">Python language API bindings #2</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/rhoot/bgfx-rs#bgfx-rs">Rust language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/stuartcarnie/SwiftBGFX">Swift language API bindings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/bindings/zig">Zig language API bindings</a></p></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><p><a class="reference external" href="https://github.com/bkaradzic/bgfx">https://github.com/bkaradzic/bgfx</a></p></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><p><a class="reference external" href="https://github.com/bkaradzic/bgfx/discussions">GitHub Discussions</a></p></li>
|
||
<li><p><a class="reference external" href="https://discord.gg/9eMbv7J">Discord Chat</a></p></li>
|
||
<li><p>GitHub <a class="reference external" href="https://github.com/bkaradzic">@bkaradzic</a></p></li>
|
||
<li><p>Twitter <a class="reference external" href="https://twitter.com/bkaradzic">@bkaradzic</a></p></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="debugging-and-profiling">
|
||
<h2>Debugging and Profiling<a class="headerlink" href="#debugging-and-profiling" title="Permalink to this headline">¶</a></h2>
|
||
<div class="section" id="renderdoc">
|
||
<h3>RenderDoc<a class="headerlink" href="#renderdoc" title="Permalink to this headline">¶</a></h3>
|
||
<p>Loading of RenderDoc is integrated in bgfx when using DX11 or OpenGL
|
||
renderer. You can drop in <code class="docutils literal notranslate"><span class="pre">renderdoc.dll</span></code> from RenderDoc distribution
|
||
into working directory, and it will be automatically loaded during bgfx
|
||
initialization. This allows frame capture at any time by pressing
|
||
<strong>F11</strong>.</p>
|
||
<p>Download: <a class="reference external" href="https://renderdoc.org/builds">RenderDoc</a></p>
|
||
<p>RenderDoc <a class="reference external" href="https://renderdoc.org/docs/how/index.html">How do I …?</a> documentation.</p>
|
||
<p><a class="reference external" href="https://software.intel.com/en-us/articles/shader-debugging-for-bgfx-rendering-engine">Shader debugging</a>
|
||
with RenderDoc and MSVC.</p>
|
||
</div>
|
||
<div class="section" id="intelgpa">
|
||
<h3>IntelGPA<a class="headerlink" href="#intelgpa" title="Permalink to this headline">¶</a></h3>
|
||
<p>Right click <strong>Intel GPA Monitor</strong> tray icon, choose preferences, check
|
||
“Auto-detect launched applications” option. Find <code class="docutils literal notranslate"><span class="pre">InjectionList.txt</span></code>
|
||
in GPA directory and add <code class="docutils literal notranslate"><span class="pre">examples-*</span></code> to the list.</p>
|
||
<p>Download:
|
||
<a class="reference external" href="https://software.intel.com/en-us/vcsource/tools/intel-gpa">IntelGPA</a></p>
|
||
</div>
|
||
<div class="section" id="other-debuggers-and-profilers">
|
||
<h3>Other Debuggers and Profilers<a class="headerlink" href="#other-debuggers-and-profilers" title="Permalink to this headline">¶</a></h3>
|
||
<table class="docutils align-default">
|
||
<colgroup>
|
||
<col style="width: 15%" />
|
||
<col style="width: 20%" />
|
||
<col style="width: 8%" />
|
||
<col style="width: 9%" />
|
||
<col style="width: 7%" />
|
||
<col style="width: 8%" />
|
||
<col style="width: 7%" />
|
||
<col style="width: 7%" />
|
||
<col style="width: 8%" />
|
||
<col style="width: 9%" />
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Name</p></th>
|
||
<th class="head"><p>OS</p></th>
|
||
<th class="head"><p>DX9</p></th>
|
||
<th class="head"><p>DX11</p></th>
|
||
<th class="head"><p>DX12</p></th>
|
||
<th class="head"><p>Metal</p></th>
|
||
<th class="head"><p>GL</p></th>
|
||
<th class="head"><p>GLES</p></th>
|
||
<th class="head"><p>Vulkan</p></th>
|
||
<th class="head"><p>Source</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>APITrace</p></td>
|
||
<td><p>Linux/OSX/Win</p></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>CodeXL</p></td>
|
||
<td><p>Linux/Win</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Dissector</p></td>
|
||
<td><p>Win</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>IntelGPA</p></td>
|
||
<td><p>Linux/OSX/Win</p></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Nsight</p></td>
|
||
<td><p>Win</p></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>PerfHUD</p></td>
|
||
<td><p>Win</p></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>PerfStudio</p></td>
|
||
<td><p>Win</p></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>PIX</p></td>
|
||
<td><p>Win</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>RGP</p></td>
|
||
<td><p>Win</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>RenderDoc</p></td>
|
||
<td><p>Win/Linux</p></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td><p>✓</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>vogl</p></td>
|
||
<td><p>Linux</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
<td></td>
|
||
<td></td>
|
||
<td><p>✓</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Download:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://apitrace.github.io/">APITrace</a></p></li>
|
||
<li><p><a class="reference external" href="http://developer.amd.com/tools-and-sdks/opencl-zone/codexl/">CodeXL</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/imccown/Dissector">Dissector</a></p></li>
|
||
<li><p><a class="reference external" href="http://developer.amd.com/tools-and-sdks/graphics-development/gpu-perfstudio/">GPU PerfStudio</a></p></li>
|
||
<li><p><a class="reference external" href="https://developer.nvidia.com/linux-graphics-debugger">Linux Graphics Debugger</a></p></li>
|
||
<li><p><a class="reference external" href="https://developer.nvidia.com/nsight-graphics">Nsight</a></p></li>
|
||
<li><p><a class="reference external" href="https://blogs.msdn.microsoft.com/pix/">PIX</a></p></li>
|
||
<li><p><a class="reference external" href="https://developer.nvidia.com/nvidia-perfhud">PerfHUD</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/GPUOpen-Tools/Radeon-GPUProfiler/releases">RGP (Radeon GPU Profiler)</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/ValveSoftware/vogl">vogl</a></p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="sdl-glfw-etc">
|
||
<h2>SDL, GLFW, etc.<a class="headerlink" href="#sdl-glfw-etc" title="Permalink to this headline">¶</a></h2>
|
||
<p>It is possible to use bgfx with SDL, GLFW and similar cross platform
|
||
windowing libraries. The main requirement is that windowing library
|
||
provides access to native window handle that’s used to create Direct3D
|
||
device or OpenGL context.</p>
|
||
<p>For more info see: <a class="reference internal" href="bgfx.html"><span class="doc">API Reference</span></a>.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>You can use <code class="docutils literal notranslate"><span class="pre">--with-sdl</span></code> when running GENie to enable SDL2 integration with examples:
|
||
<code class="docutils literal notranslate"><span class="pre">genie</span> <span class="pre">--with-sdl</span> <span class="pre">vs2012</span></code></p>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p><code class="docutils literal notranslate"><span class="pre">--with-glfw</span></code> is also available, but it’s just simple stub to be used to test GLFW
|
||
integration API.</p>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>Special care is necessary to make custom windowing to work with multithreaded renderer.
|
||
Each platform has rules about where renderer can be and how multithreading interacts
|
||
with context/device. To disable multithreaded render use <code class="docutils literal notranslate"><span class="pre">BGFX_CONFIG_MULTITHREADED=0</span></code>
|
||
preprocessor define.</p>
|
||
</div>
|
||
</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 (see <a class="reference external" href="https://github.com/bkaradzic/bgfx/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+needed%22">ideas</a>),
|
||
improving documentation, profiling and optimizing, etc.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p><strong>When contributing to the bgfx project you must agree to the BSD 2-clause
|
||
licensing terms.</strong></p>
|
||
</div>
|
||
<div class="section" id="contributors">
|
||
<h3>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline">¶</a></h3>
|
||
<p>Chronological order:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li><p>Branimir Karadžić (<a class="reference external" href="https://github.com/bkaradzic">@bkaradzic</a>)</p></li>
|
||
<li><p>Garett Bass (<a class="reference external" href="https://github.com/garettbass">@garettbass</a>) - OSX port.</p></li>
|
||
<li><p>Jeremie Roy (<a class="reference external" href="https://github.com/jeremieroy">@jeremieroy</a>) -
|
||
<a class="reference external" href="examples.html#font">10-font</a>,
|
||
and <a class="reference external" href="examples.html#fontsdf">11-fontsdf</a> examples.</p></li>
|
||
<li><p>Miloš Tošić (<a class="reference external" href="https://github.com/milostosic">@milostosic</a>) -
|
||
<a class="reference external" href="examples.html#lod">12-lod</a> example.</p></li>
|
||
<li><p>Dario Manesku (<a class="reference external" href="https://github.com/dariomanesku">@dariomanesku</a>) -
|
||
<a class="reference external" href="examples.html#stencil">13-stencil</a>,
|
||
<a class="reference external" href="examples.html#shadowvolumes">14-shadowvolumes</a>,
|
||
<a class="reference external" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a>,
|
||
<a class="reference external" href="examples.html#shadowmaps">16-shadowmaps</a>,
|
||
<a class="reference external" href="examples.html#ibl">18-ibl</a>,
|
||
and <a class="reference external" href="examples.html#wireframe">28-wireframe</a> example.</p></li>
|
||
<li><p>James Gray (<a class="reference external" href="https://github.com/james4k">@james4k</a>) - Go language API bindings.</p></li>
|
||
<li><p>Guillaume Piolat (<a class="reference external" href="https://github.com/p0nce">@p0nce</a>) - D language API bindings.</p></li>
|
||
<li><p>Mike Popoloski (<a class="reference external" href="https://github.com/MikePopoloski">@MikePopoloski</a>) - C#/VB/F# language API
|
||
bindings, WinRT/WinPhone support.</p></li>
|
||
<li><p>Kai Jourdan (<a class="reference external" href="https://github.com/questor">@questor</a>) -
|
||
<a class="reference external" href="examples.html#vectordisplay">23-vectordisplay</a> example.</p></li>
|
||
<li><p>Stanlo Slasinski (<a class="reference external" href="https://github.com/stanlo">@stanlo</a>) -
|
||
<a class="reference external" href="examples.html#nbody">24-nbody</a> example.</p></li>
|
||
<li><p>Daniel Collin (<a class="reference external" href="https://github.com/emoon">@emoon</a>) - Port of Ocornut’s ImGui to bgfx.</p></li>
|
||
<li><p>Andre Weissflog (<a class="reference external" href="https://github.com/floooh">@floooh</a>) - Alternative build system fips.</p></li>
|
||
<li><p>Andrew Johnson (<a class="reference external" href="https://github.com/ajohnson23">@ajohnson23</a>) - TeamCity build.</p></li>
|
||
<li><p>Tony McCrary (<a class="reference external" href="https://github.com/enleeten">@enleeten</a>) - Java language API bindings.</p></li>
|
||
<li><p>Attila Kocsis (<a class="reference external" href="https://github.com/attilaz">@attilaz</a>) - Metal rendering backend, various OSX
|
||
and iOS improvements and bug fixes, <a class="reference external" href="examples.html#assao">39-assao</a> example.</p></li>
|
||
<li><p>Richard Gale (<a class="reference external" href="https://github.com/RichardGale">@RichardGale</a>) - Emscripten entry input
|
||
handling.</p></li>
|
||
<li><p>Andrew Mac (<a class="reference external" href="https://github.com/andr3wmac">@andr3wmac</a>) -
|
||
<a class="reference external" href="examples.html#terrain">27-terrain</a> example.</p></li>
|
||
<li><p>Oliver Charles (<a class="reference external" href="https://github.com/ocharles">@ocharles</a>) - Haskel language API bindings.</p></li>
|
||
<li><p>Johan Sköld (<a class="reference external" href="https://github.com/rhoot">@rhoot</a>) - Rust language API bindings.</p></li>
|
||
<li><p>Jean-François Verdon (<a class="reference external" href="https://github.com/Nodrev">@Nodrev</a>) - Alternative deployment for
|
||
Android.</p></li>
|
||
<li><p>Jason Nadro (<a class="reference external" href="https://github.com/jnadro">@jnadro</a>) - Python language API bindings.</p></li>
|
||
<li><p>Krzysztof Kondrak (<a class="reference external" href="https://github.com/kondrak">@kondrak</a>) - OculusVR integration.</p></li>
|
||
<li><p>Colby Klein (<a class="reference external" href="https://github.com/excessive">@excessive</a>) - Lua language API bindings.</p></li>
|
||
<li><p>Stuart Carnie (<a class="reference external" href="https://github.com/stuartcarnie">@stuartcarnie</a>) - Swift language API
|
||
bindings.</p></li>
|
||
<li><p>Joseph Cherlin (<a class="reference external" href="https://github.com/jcherlin">@jcherlin</a>) -
|
||
<a class="reference external" href="examples.html#picking">30-picking</a>,
|
||
and <a class="reference external" href="examples.html#rsm">31-rsm</a> example.</p></li>
|
||
<li><p>Olli Wang (<a class="reference external" href="https://github.com/olliwang">@olliwang</a>) - Various NanoVG integration improvements.</p></li>
|
||
<li><p>Cory Golden (<a class="reference external" href="https://github.com/Halsys">@Halsys</a>) - Nim language API bindings.</p></li>
|
||
<li><p>Camilla Berglund (<a class="reference external" href="https://github.com/elmindreda">@elmindreda</a>) - GLFW support.</p></li>
|
||
<li><p>Daniel Ludwig (<a class="reference external" href="https://github.com/code-disaster">@code-disaster</a>) - Lightweight Java Game
|
||
Library 3 bindings.</p></li>
|
||
<li><p>Benoit Jacquier (<a class="reference external" href="https://github.com/benoitjacquier">@benoitjacquier</a>) - Added support for
|
||
cubemap as texture 2D array in a compute shader.</p></li>
|
||
<li><p>Apoorva Joshi (<a class="reference external" href="https://github.com/ApoorvaJ">@ApoorvaJ</a>) -
|
||
<a class="reference external" href="examples.html#pom">33-pom</a> example.</p></li>
|
||
<li><p>Stanislav Pidhorsky (<a class="reference external" href="https://github.com/podgorskiy">@podgorskiy</a>) -
|
||
<a class="reference external" href="examples.html#sky">36-sky</a> example.</p></li>
|
||
<li><p>云风 (<a class="reference external" href="https://github.com/cloudwu">@cloudwu</a>) - Alternative Lua bindings, bgfx IDL scripts,
|
||
<a class="reference external" href="examples.html#bunnylod">42-bunnylod</a> example.</p></li>
|
||
<li><p>Kostas Anagnostou (<a class="reference external" href="https://github.com/KostasAAA">@KostasAAA</a>) -
|
||
<a class="reference external" href="examples.html#gpudrivenrendering">37-gpudrivenrendering</a> example.</p></li>
|
||
<li><p>Andrew Willmott (<a class="reference external" href="https://github.com/andrewwillmott">@andrewwillmott</a>) - ATC and ASTC support.</p></li>
|
||
<li><p>Aleš Mlakar (<a class="reference external" href="https://github.com/jazzbre">@jazzbre</a>) -
|
||
<a class="reference external" href="examples.html#svt">40-svt</a> example.</p></li>
|
||
<li><p>Matt Chiasson (<a class="reference external" href="https://github.com/mchiasson">@mchiasson</a>) - Various fixes and improvements.</p></li>
|
||
<li><p>Phil Peron (<a class="reference external" href="https://github.com/pperon">@pperon</a>) - Tutorial how to use bgfx API.</p></li>
|
||
<li><p>Vincent Cruz (<a class="reference external" href="https://github.com/BlockoS">@BlockoS</a>) - Wayland support.</p></li>
|
||
<li><p>Jonathan Young (<a class="reference external" href="https://github.com/jpcy">@jpcy</a>) - Renderer for ioquake3 that uses bgfx,
|
||
minimal bgfx example.</p></li>
|
||
<li><p>Nick Waanders (<a class="reference external" href="https://github.com/NickWaanders">@NickWaanders</a>) - shaderc: Metal fixes.</p></li>
|
||
<li><p>Vladimir Vukićević (<a class="reference external" href="https://github.com/vvuk">@vvuk</a>) - HTML5 context.</p></li>
|
||
<li><p>Daniel Gavin (<a class="reference external" href="https://github.com/DanielGavin">@DanielGavin</a>) - <a class="reference external" href="examples.html#tess">41-tess</a> example.</p></li>
|
||
<li><p>Ji-yong Kwon (<a class="reference external" href="https://github.com/rinthel">@rinthel</a>) - Vulkan rendering backend.</p></li>
|
||
<li><p>Leandro Freire (<a class="reference external" href="https://github.com/leandrolfre">@leandrolfre</a>).</p></li>
|
||
<li><p>Ari Vuollet (<a class="reference external" href="https://github.com/GoaLitiuM">@GoaLitiuM</a>) IDL generator for D language
|
||
bindings.</p></li>
|
||
<li><p>Sebastian Marketsmueller (<a class="reference external" href="https://github.com/sebastianmunity3d">@sebastianmunity3d</a>).</p></li>
|
||
<li><p>Cedric Guillemet (<a class="reference external" href="https://github.com/CedricGuillemet">@CedricGuillemet</a>).</p></li>
|
||
<li><p>Pablo Escobar (<a class="reference external" href="https://github.com/pezcode">@pezcode</a>) - Various Vulkan fixes.</p></li>
|
||
<li><p>Paul Gruenbacher (<a class="reference external" href="https://github.com/pgruenbacher">@pgruenbacher</a>) - Various bug fixes.</p></li>
|
||
<li><p>Jukka Jylänki (<a class="reference external" href="https://github.com/juj">@juj</a>) - Various WebGL optimizations and fixes.</p></li>
|
||
<li><p>Hugo Amnov (<a class="reference external" href="https://github.com/hugoam">@hugoam</a>) - WebGPU/Dawn rendering backend.</p></li>
|
||
<li><p>Christophe Dehais (<a class="reference external" href="https://github.com/goodartistscopy">@goodartistscopy</a>) - Various bug fixes.</p></li>
|
||
<li><p>elvencache (<a class="reference external" href="https://github.com/elvencache">@elvencache</a>) -
|
||
<a class="reference external" href="examples.html#denoise">43-denoise</a>,
|
||
<a class="reference external" href="examples.html#sss">44-sss</a>,
|
||
and <a class="reference external" href="examples.html#bokeh">45-bokeh</a> example.</p></li>
|
||
<li><p>Richard Schubert (<a class="reference external" href="https://github.com/Hemofektik">@Hemofektik</a>) - <a class="reference external" href="examples.html#fsr">46-fsr</a> example.</p></li>
|
||
<li><p>Sandy Carter (<a class="reference external" href="https://github.com/bwrsandman">@bwrsandman</a>) - <a class="reference external" href="examples.html#pixelformats">47-pixelformats</a> example, and various fixes and improvements.</p></li>
|
||
<li><p>Liam Twigger (<a class="reference external" href="https://github.com/SnapperTT">@SnapperTT</a>) - <a class="reference external" href="examples.html#drawindirect">48-drawindirect</a> example.</p></li>
|
||
</ul>
|
||
</div></blockquote>
|
||
<p>and <a class="reference external" href="https://github.com/bkaradzic/bgfx/graphs/contributors">others</a>…</p>
|
||
</div>
|
||
<div class="section" id="repository-visualization">
|
||
<h3>Repository visualization<a class="headerlink" href="#repository-visualization" title="Permalink to this headline">¶</a></h3>
|
||
<p>
|
||
<iframe width="694" height="390" src="https://www.youtube.com/embed/5ZeN_d_-BHo" frameborder="0" allowfullscreen></iframe>
|
||
</p></div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="build.html" class="btn btn-neutral float-right" title="Building" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="index.html" class="btn btn-neutral float-left" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
|
||
© Copyright 2010-2022, Branimir Karadžić
|
||
|
||
</p>
|
||
</div>
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |