mirror of https://github.com/bkaradzic/bgfx
Updated docs.
This commit is contained in:
Бранимир Караџић
parent
39d91615ef
commit
f45c04d84f
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -130,7 +130,7 @@ ul.search li a {
|
|||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li p.context {
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
|
|
@ -277,25 +277,25 @@ p.rubric {
|
|||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, figure.align-default, .figure.align-default {
|
||||
img.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
|
|
@ -319,8 +319,7 @@ img.align-default, figure.align-default, .figure.align-default {
|
|||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar,
|
||||
aside.sidebar {
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px;
|
||||
|
|
@ -378,14 +377,12 @@ div.body p.centered {
|
|||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
|
|
@ -458,22 +455,20 @@ td > :last-child {
|
|||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure, figure {
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption, figcaption {
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number,
|
||||
figcaption span.caption-number {
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text,
|
||||
figcaption span.caption-text {
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
|
@ -508,63 +503,6 @@ table.hlist td {
|
|||
vertical-align: top;
|
||||
}
|
||||
|
||||
/* -- object description styles --------------------------------------------- */
|
||||
|
||||
.sig {
|
||||
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
}
|
||||
|
||||
.sig-name, code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.sig-name {
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
.sig-prename, code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.sig-param.n {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* C++ specific styling */
|
||||
|
||||
.sig-inline.c-texpr,
|
||||
.sig-inline.cpp-texpr {
|
||||
font-family: unset;
|
||||
}
|
||||
|
||||
.sig.c .k, .sig.c .kt,
|
||||
.sig.cpp .k, .sig.cpp .kt {
|
||||
color: #0033B3;
|
||||
}
|
||||
|
||||
.sig.c .m,
|
||||
.sig.cpp .m {
|
||||
color: #1750EB;
|
||||
}
|
||||
|
||||
.sig.c .s, .sig.c .sc,
|
||||
.sig.cpp .s, .sig.cpp .sc {
|
||||
color: #067D17;
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
|
|
@ -691,6 +629,14 @@ dl.glossary dt {
|
|||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
|
@ -820,11 +766,7 @@ div.code-block-caption code {
|
|||
table.highlighttable td.linenos,
|
||||
span.linenos,
|
||||
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
||||
user-select: none;
|
||||
-webkit-user-select: text; /* Safari fallback only */
|
||||
-webkit-user-select: none; /* Chrome/Safari */
|
||||
-moz-user-select: none; /* Firefox */
|
||||
-ms-user-select: none; /* IE10+ */
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
|
|
@ -839,6 +781,16 @@ div.literal-block-wrapper {
|
|||
margin: 1em 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -29,14 +29,9 @@ if (!window.console || !console.firebug) {
|
|||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
if (!x) {
|
||||
return x
|
||||
}
|
||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
};
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -13,8 +13,7 @@
|
|||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
|
||||
/* Non-minified version is copied as a separate JS file, is available */
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
|
|
@ -200,6 +199,7 @@ var Stemmer = function() {
|
|||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
|
|
|
|||
|
|
@ -1,10 +1,5 @@
|
|||
pre { line-height: 125%; }
|
||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #eeffcc; }
|
||||
.highlight { background: #eeffcc; }
|
||||
.highlight .c { color: #408090; font-style: italic } /* Comment */
|
||||
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -248,7 +248,7 @@ var Search = {
|
|||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li></li>');
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
var requestUrl = "";
|
||||
var linkUrl = "";
|
||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||
|
|
@ -273,9 +273,9 @@ var Search = {
|
|||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.ajax({url: requestUrl,
|
||||
dataType: "text",
|
||||
|
|
@ -285,16 +285,16 @@ var Search = {
|
|||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
});
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
});
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
|
|
@ -379,13 +379,6 @@ var Search = {
|
|||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
||||
*/
|
||||
escapeRegExp : function(string) {
|
||||
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
|
|
@ -409,14 +402,13 @@ var Search = {
|
|||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
var word_regex = this.escapeRegExp(word);
|
||||
for (var w in terms) {
|
||||
if (w.match(word_regex) && !terms[word]) {
|
||||
if (w.match(word) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word_regex) && !titleterms[word]) {
|
||||
if (w.match(word) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
|
|
@ -509,7 +501,7 @@ var Search = {
|
|||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<p class="context"></p>').text(excerpt);
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
106
build.html
106
build.html
|
|
@ -3,10 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Building — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -14,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -57,7 +51,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -163,8 +157,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -176,7 +168,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -188,22 +180,22 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="building">
|
||||
<div class="section" id="building">
|
||||
<h1>Building<a class="headerlink" href="#building" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="dependencies">
|
||||
<div class="section" id="dependencies">
|
||||
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
|
||||
<p><a class="reference external" href="https://github.com/bkaradzic/bx">https://github.com/bkaradzic/bx</a></p>
|
||||
<p><a class="reference external" href="https://github.com/bkaradzic/bimg">https://github.com/bkaradzic/bimg</a></p>
|
||||
</section>
|
||||
<section id="getting-source">
|
||||
</div>
|
||||
<div class="section" id="getting-source">
|
||||
<h2>Getting Source<a class="headerlink" href="#getting-source" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">bkaradzic</span><span class="o">/</span><span class="n">bx</span><span class="o">.</span><span class="n">git</span>
|
||||
<span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">bkaradzic</span><span class="o">/</span><span class="n">bimg</span><span class="o">.</span><span class="n">git</span>
|
||||
<span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">bkaradzic</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">git</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="quick-start">
|
||||
</div>
|
||||
<div class="section" id="quick-start">
|
||||
<h2>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2>
|
||||
<p>These are step for users who use Windows with Visual Studio.</p>
|
||||
<p>Enter bgfx directory:</p>
|
||||
|
|
@ -222,10 +214,10 @@
|
|||
<p class="admonition-title">Note</p>
|
||||
<p>For more detailed prerequisites and build steps on other platforms see below.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="prerequisites">
|
||||
</div>
|
||||
<div class="section" id="prerequisites">
|
||||
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
|
||||
<section id="android">
|
||||
<div class="section" id="android">
|
||||
<h3>Android<a class="headerlink" href="#android" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Download AndroidNDK:</p>
|
||||
<blockquote>
|
||||
|
|
@ -246,14 +238,14 @@
|
|||
<li><p><a class="reference external" href="https://github.com/Nodrev/bgfx-android-activity#bgfx-android-activity---android-glue-for-bgfx">https://github.com/Nodrev/bgfx-android-activity#bgfx-android-activity—android-glue-for-bgfx</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="linux">
|
||||
</div>
|
||||
<div class="section" id="linux">
|
||||
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libgl1</span><span class="o">-</span><span class="n">mesa</span><span class="o">-</span><span class="n">dev</span> <span class="n">x11proto</span><span class="o">-</span><span class="n">core</span><span class="o">-</span><span class="n">dev</span> <span class="n">libx11</span><span class="o">-</span><span class="n">dev</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="windows">
|
||||
</div>
|
||||
<div class="section" id="windows">
|
||||
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Windows users download GnuWin32 utilities:</p>
|
||||
<blockquote>
|
||||
|
|
@ -264,14 +256,14 @@
|
|||
<li><p><a class="reference external" href="http://gnuwin32.sourceforge.net/packages/libintl.htm">http://gnuwin32.sourceforge.net/packages/libintl.htm</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</section>
|
||||
<section id="build">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="build">
|
||||
<h2>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h2>
|
||||
<p>bgfx uses <a class="reference external" href="https://github.com/bkaradzic/genie#genie---project-generator-tool">GENie - Project generator tool</a>
|
||||
to generate project files for various platform. Binaries for Linux, OSX, and Windows are included in
|
||||
bx repository.</p>
|
||||
<section id="general">
|
||||
<div class="section" id="general">
|
||||
<h3>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">bgfx</span>
|
||||
<span class="n">make</span>
|
||||
|
|
@ -288,8 +280,8 @@ directory structure. Deleting .build directory at any time is safe.</p>
|
|||
<span class="n">android</span><span class="o">-</span><span class="n">release</span><span class="p">,</span> <span class="n">etc</span><span class="o">.</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id1">
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h3>Windows<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Visual Studio 2017 command line:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">vs2017</span><span class="o">-</span><span class="n">release64</span>
|
||||
|
|
@ -299,8 +291,8 @@ directory structure. Deleting .build directory at any time is safe.</p>
|
|||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">start</span> <span class="o">.</span><span class="n">build</span><span class="o">/</span><span class="n">projects</span><span class="o">/</span><span class="n">vs2017</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">sln</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="xcode">
|
||||
</div>
|
||||
<div class="section" id="xcode">
|
||||
<h3>Xcode<a class="headerlink" href="#xcode" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Xcode command line:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">osx</span><span class="o">-</span><span class="n">release</span>
|
||||
|
|
@ -322,14 +314,14 @@ configuration file, it has to be set manually for each example project:</p>
|
|||
<li><p>Check <em>“Use custom working directory”</em> and enter following path:
|
||||
<code class="docutils literal notranslate"><span class="pre">${PROJECT_DIR}/../../../examples/runtime</span></code>.</p></li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="id2">
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h3>Linux<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">linux</span><span class="o">-</span><span class="n">release64</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="winrt-uwp">
|
||||
</div>
|
||||
<div class="section" id="winrt-uwp">
|
||||
<h3>WinRT / UWP<a class="headerlink" href="#winrt-uwp" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span>\<span class="n">bx</span>\<span class="n">tools</span>\<span class="nb">bin</span>\<span class="n">windows</span>\<span class="n">genie</span> <span class="o">--</span><span class="n">vs</span><span class="o">=</span><span class="n">winstore100</span> <span class="n">vs2017</span>
|
||||
</pre></div>
|
||||
|
|
@ -339,9 +331,9 @@ configuration file, it has to be set manually for each example project:</p>
|
|||
<p class="admonition-title">Note</p>
|
||||
<p>Shaders will need to be compiled with the appropriate target profile for your platform.</p>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="amalgamated-build">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="amalgamated-build">
|
||||
<h2>Amalgamated Build<a class="headerlink" href="#amalgamated-build" title="Permalink to this headline">¶</a></h2>
|
||||
<p>For ease of integration to other build system bgfx library can be built
|
||||
with single .cpp file. It’s only necessary to build
|
||||
|
|
@ -349,15 +341,15 @@ with single .cpp file. It’s only necessary to build
|
|||
(for OSX/iOS use
|
||||
<a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/src/amalgamated.mm">src/amalgamated.mm</a>
|
||||
instead) inside different build system.</p>
|
||||
</section>
|
||||
<section id="tools">
|
||||
</div>
|
||||
<div class="section" id="tools">
|
||||
<h2>Tools<a class="headerlink" href="#tools" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To build bgfx project files for tools, use <code class="docutils literal notranslate"><span class="pre">--with-tools</span></code> option:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span>\<span class="n">bx</span>\<span class="n">tools</span>\<span class="nb">bin</span>\<span class="n">windows</span>\<span class="n">genie</span> <span class="o">--</span><span class="k">with</span><span class="o">-</span><span class="n">tools</span> <span class="n">vs2017</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="alternative-build-systems">
|
||||
</div>
|
||||
<div class="section" id="alternative-build-systems">
|
||||
<h2>Alternative build systems<a class="headerlink" href="#alternative-build-systems" title="Permalink to this headline">¶</a></h2>
|
||||
<p><strong>CMake</strong></p>
|
||||
<blockquote>
|
||||
|
|
@ -373,36 +365,44 @@ instead) inside different build system.</p>
|
|||
<a class="reference external" href="https://github.com/floooh/fips#fips">https://github.com/floooh/fips#fips</a></p>
|
||||
<p><strong>Conan</strong> package
|
||||
<a class="reference external" href="https://github.com/firefalcom/bgfx-conan">https://github.com/firefalcom/bgfx-conan</a></p>
|
||||
</section>
|
||||
<section id="minimal-example-without-bgfx-example-harness">
|
||||
</div>
|
||||
<div class="section" id="minimal-example-without-bgfx-example-harness">
|
||||
<h2>Minimal example without bgfx’ example harness<a class="headerlink" href="#minimal-example-without-bgfx-example-harness" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This project demonstrates minimal amount of code needed to integrate bgfx with GLFW, but without
|
||||
any of existing bgfx example harness. It also demonstrates how to build bgfx with alternative build
|
||||
system.</p>
|
||||
<p><a class="reference external" href="https://github.com/jpcy/bgfx-minimal-example">https://github.com/jpcy/bgfx-minimal-example</a></p>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="overview.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
|
||||
<a href="examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="overview.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
399
examples.html
399
examples.html
|
|
@ -3,10 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Examples — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -14,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -57,7 +51,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -146,6 +140,7 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="#denoise">43-denoise</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#sss">44-sss</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#bokeh">45-bokeh</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#fsr">46-fsr</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a></li>
|
||||
|
|
@ -192,8 +187,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -205,7 +198,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -217,28 +210,28 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="examples">
|
||||
<div class="section" id="examples">
|
||||
<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Most of the examples require shader/texture/mesh data to be loaded. When
|
||||
running examples your current directory should be examples/runtime.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><bgfx_path>/examples/runtime $ ../../.build/<config>/bin/example-00-helloworldDebug
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="helloworld">
|
||||
<div class="section" id="helloworld">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/00-helloworld">00-helloworld</a><a class="headerlink" href="#helloworld" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Initialization and debug text.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-00-helloworld" src="https://github.com/bkaradzic/bgfx/raw/master/examples/00-helloworld/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="cubes">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="cubes">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/01-cubes/cubes.cpp">01-cubes</a><a class="headerlink" href="#cubes" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Rendering simple static mesh.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-01-cubes" src="https://github.com/bkaradzic/bgfx/raw/master/examples/01-cubes/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="metaballs">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="metaballs">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/02-metaballs">02-metaballs</a><a class="headerlink" href="#metaballs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Rendering with transient buffers and embedding shaders.</p>
|
||||
<div class="emscripten">
|
||||
|
|
@ -330,101 +323,101 @@ running examples your current directory should be examples/runtime.</p>
|
|||
};
|
||||
};
|
||||
</script>
|
||||
<script async type="text/javascript" src="example-02-metaballsRelease.bc.js"></script></section>
|
||||
<section id="raymarch">
|
||||
<script async type="text/javascript" src="example-02-metaballsRelease.bc.js"></script></div>
|
||||
<div class="section" id="raymarch">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/03-raymarch">03-raymarch</a><a class="headerlink" href="#raymarch" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Updating shader uniforms.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-03-raymarch" src="https://github.com/bkaradzic/bgfx/raw/master/examples/03-raymarch/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="mesh">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="mesh">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/04-mesh">04-mesh</a><a class="headerlink" href="#mesh" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Loading meshes.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-04-mesh" src="https://github.com/bkaradzic/bgfx/raw/master/examples/04-mesh/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="instancing">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="instancing">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/05-instancing">05-instancing</a><a class="headerlink" href="#instancing" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Geometry instancing.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-05-instancing" src="https://github.com/bkaradzic/bgfx/raw/master/examples/05-instancing/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="bump">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bump">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/06-bump">06-bump</a><a class="headerlink" href="#bump" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Loading textures.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-06-bump" src="https://github.com/bkaradzic/bgfx/raw/master/examples/06-bump/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="callback">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="callback">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/07-callback">07-callback</a><a class="headerlink" href="#callback" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Implementing application specific callbacks for taking screen shots,
|
||||
caching OpenGL binary shaders, and video capture.</p>
|
||||
</section>
|
||||
<section id="update">
|
||||
</div>
|
||||
<div class="section" id="update">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/08-update">08-update</a><a class="headerlink" href="#update" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Updating textures.</p>
|
||||
</section>
|
||||
<section id="hdr">
|
||||
</div>
|
||||
<div class="section" id="hdr">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/09-hdr">09-hdr</a><a class="headerlink" href="#hdr" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Using multiple views with frame buffers, and view order remapping.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-09-hdr" src="https://github.com/bkaradzic/bgfx/raw/master/examples/09-hdr/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="font">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="font">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/10-font">10-font</a><a class="headerlink" href="#font" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Use the font system to display text and styled text.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-10-font" src="https://github.com/bkaradzic/bgfx/raw/master/examples/10-font/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="fontsdf">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="fontsdf">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/11-fontsdf">11-fontsdf</a><a class="headerlink" href="#fontsdf" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Use a single distance field font to render text of various size.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-11-fontsdf" src="https://github.com/bkaradzic/bgfx/raw/master/examples/11-fontsdf/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="lod">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="lod">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/12-lod">12-lod</a><a class="headerlink" href="#lod" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Mesh LOD transitions.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-12-lod" src="https://github.com/bkaradzic/bgfx/raw/master/examples/12-lod/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="stencil">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="stencil">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/13-stencil">13-stencil</a><a class="headerlink" href="#stencil" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Stencil reflections and shadows.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-13-stencil" src="https://github.com/bkaradzic/bgfx/raw/master/examples/13-stencil/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="shadowvolumes">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="shadowvolumes">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/14-shadowvolumes">14-shadowvolumes</a><a class="headerlink" href="#shadowvolumes" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Shadow volumes.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-14-shadowvolumes" src="https://github.com/bkaradzic/bgfx/raw/master/examples/14-shadowvolumes/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="shadowmaps-simple">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="shadowmaps-simple">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/15-shadowmaps-simple">15-shadowmaps-simple</a><a class="headerlink" href="#shadowmaps-simple" title="Permalink to this headline">¶</a></h2>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-15-shadowmaps-simple" src="https://github.com/bkaradzic/bgfx/raw/master/examples/15-shadowmaps-simple/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="shadowmaps">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="shadowmaps">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/16-shadowmaps">16-shadowmaps</a><a class="headerlink" href="#shadowmaps" title="Permalink to this headline">¶</a></h2>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-16-shadowmaps" src="https://github.com/bkaradzic/bgfx/raw/master/examples/16-shadowmaps/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="drawstress">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="drawstress">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/examples/17-drawstress">17-drawstress</a><a class="headerlink" href="#drawstress" title="Permalink to this headline">¶</a></h2>
|
||||
<section id="hz">
|
||||
<div class="section" id="hz">
|
||||
<h3>60Hz<a class="headerlink" href="#hz" title="Permalink to this headline">¶</a></h3>
|
||||
<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
|
||||
|
|
@ -891,8 +884,8 @@ changing <code class="docutils literal notranslate"><span class="pre">BGFX_CONFI
|
|||
(on Windows), and <code class="docutils literal notranslate"><span class="pre">layout.frame_rate</span> <span class="pre">500</span></code>.</p></li>
|
||||
<li><p>Chrome 33 command line option: <code class="docutils literal notranslate"><span class="pre">--disable-gpu-vsync</span></code>.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="hz-test-for-browsers">
|
||||
</div>
|
||||
<div class="section" id="hz-test-for-browsers">
|
||||
<h3>30Hz (test for browsers)<a class="headerlink" href="#hz-test-for-browsers" title="Permalink to this headline">¶</a></h3>
|
||||
<p>By default browsers are using vsync, and don’t have option to turn it
|
||||
off programatically.</p>
|
||||
|
|
@ -1022,108 +1015,108 @@ off programatically.</p>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
</section>
|
||||
<section id="ibl">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="ibl">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/18-ibl">18-ibl</a><a class="headerlink" href="#ibl" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Image-based lighting.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-18-ibl" src="https://github.com/bkaradzic/bgfx/raw/master/examples/18-ibl/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="oit">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="oit">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/19-oit">19-oit</a><a class="headerlink" href="#oit" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Weighted, Blended Order-Independent Transparency</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-19-oit" src="https://github.com/bkaradzic/bgfx/raw/master/examples/19-oit/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="nanovg">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="nanovg">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/20-nanovg">20-nanovg</a><a class="headerlink" href="#nanovg" title="Permalink to this headline">¶</a></h2>
|
||||
<p>NanoVG is small antialiased vector graphics rendering library.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-20-nanovg" src="https://github.com/bkaradzic/bgfx/raw/master/examples/20-nanovg/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="deferred">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="deferred">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/21-deferred">21-deferred</a><a class="headerlink" href="#deferred" title="Permalink to this headline">¶</a></h2>
|
||||
<p>MRT rendering and deferred shading.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-21-deferred" src="https://github.com/bkaradzic/bgfx/raw/master/examples/21-deferred/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="windows">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="windows">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/22-windows">22-windows</a><a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Rendering into multiple windows.</p>
|
||||
</section>
|
||||
<section id="vectordisplay">
|
||||
</div>
|
||||
<div class="section" id="vectordisplay">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/23-vectordisplay">23-vectordisplay</a><a class="headerlink" href="#vectordisplay" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Rendering lines as oldschool vectors.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-23-vectordisplay" src="https://github.com/bkaradzic/bgfx/raw/master/examples/23-vectordisplay/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="nbody">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="nbody">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/24-nbody">24-nbody</a><a class="headerlink" href="#nbody" title="Permalink to this headline">¶</a></h2>
|
||||
<p>N-body simulation with compute shaders using buffers.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-24-nbody" src="https://github.com/bkaradzic/bgfx/raw/master/examples/24-nbody/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="c99">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="c99">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/25-c99">25-c99</a><a class="headerlink" href="#c99" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Initialization and debug text with C99 API.</p>
|
||||
</section>
|
||||
<section id="occlusion">
|
||||
</div>
|
||||
<div class="section" id="occlusion">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/26-occlusion">26-occlusion</a><a class="headerlink" href="#occlusion" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Using occlusion query for conditional rendering.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-26-occlusion" src="https://github.com/bkaradzic/bgfx/raw/master/examples/26-occlusion/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="terrain">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="terrain">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/27-terrain">27-terrain</a><a class="headerlink" href="#terrain" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Terrain painting example.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-27-terrain" src="https://github.com/bkaradzic/bgfx/raw/master/examples/27-terrain/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="wireframe">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="wireframe">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/28-wireframe">28-wireframe</a><a class="headerlink" href="#wireframe" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Drawing wireframe mesh.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-28-wireframe" src="https://github.com/bkaradzic/bgfx/raw/master/examples/28-wireframe/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="debugdraw">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="debugdraw">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/29-debugdraw">29-debugdraw</a><a class="headerlink" href="#debugdraw" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Debug draw.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-29-debugdraw" src="https://github.com/bkaradzic/bgfx/raw/master/examples/29-debugdraw/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="picking">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="picking">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/30-picking">30-picking</a><a class="headerlink" href="#picking" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Mouse picking via GPU readback.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-30-picking" src="https://github.com/bkaradzic/bgfx/raw/master/examples/30-picking/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="rsm">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="rsm">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/31-rsm">31-rsm</a><a class="headerlink" href="#rsm" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Global Illumination with Reflective Shadow Map.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-31-rsm" src="https://github.com/bkaradzic/bgfx/raw/master/examples/31-rsm/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="particles">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="particles">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/32-particles">32-particles</a><a class="headerlink" href="#particles" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Particles.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-32-particles" src="https://github.com/bkaradzic/bgfx/raw/master/examples/32-particles/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="pom">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="pom">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/33-pom">33-pom</a><a class="headerlink" href="#pom" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Parallax occlusion mapping.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1132,32 +1125,32 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-33-pom" src="https://github.com/bkaradzic/bgfx/raw/master/examples/33-pom/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="mvs">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="mvs">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/34-mvs">34-mvs</a><a class="headerlink" href="#mvs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Multiple vertex streams.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-34-mvs" src="https://github.com/bkaradzic/bgfx/raw/master/examples/34-mvs/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="dynamic">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="dynamic">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/35-dynamic">35-dynamic</a><a class="headerlink" href="#dynamic" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Dynamic buffers update.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-35-dynamic" src="https://github.com/bkaradzic/bgfx/raw/master/examples/35-dynamic/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="sky">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="sky">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/36-sky">36-sky</a><a class="headerlink" href="#sky" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Perez dynamic sky model.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-36-sky" src="https://github.com/bkaradzic/bgfx/raw/master/examples/36-sky/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="gpudrivenrendering">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="gpudrivenrendering">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/37-gpudrivenrendering">37-gpudrivenrendering</a><a class="headerlink" href="#gpudrivenrendering" title="Permalink to this headline">¶</a></h2>
|
||||
<p>GPU-Driven Rendering.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1168,11 +1161,11 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-37-gpudrivenrendering" src="https://github.com/bkaradzic/bgfx/raw/master/examples/37-gpudrivenrendering/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="bloom">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bloom">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/38-bloom">38-bloom</a><a class="headerlink" href="#bloom" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Bloom.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1181,11 +1174,11 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-38-bloom" src="https://github.com/bkaradzic/bgfx/raw/master/examples/38-bloom/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="assao">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="assao">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/39-assao">39-assao</a><a class="headerlink" href="#assao" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Adaptive Screen Space Ambient Occlusion.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1194,18 +1187,18 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-39-assao" src="https://github.com/bkaradzic/bgfx/raw/master/examples/39-assao/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="svt">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="svt">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/40-svt">40-svt</a><a class="headerlink" href="#svt" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Sparse Virtual Textures.</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-40-svt" src="https://github.com/bkaradzic/bgfx/raw/master/examples/40-svt/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="tess">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="tess">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/41-tess">41-tess</a><a class="headerlink" href="#tess" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Adaptive GPU Tessellation with Compute Shaders</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1214,11 +1207,11 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-41-tess" src="https://github.com/bkaradzic/bgfx/raw/master/examples/41-tess/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="bunnylod">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bunnylod">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/42-bunnylod">42-bunnylod</a><a class="headerlink" href="#bunnylod" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Simple Polygon Reduction</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1228,11 +1221,11 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-42-bunnylod" src="https://github.com/bkaradzic/bgfx/raw/master/examples/42-bunnylod/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="denoise">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="denoise">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/43-denoise">43-denoise</a><a class="headerlink" href="#denoise" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Denoise</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1243,18 +1236,18 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-43-denoise" src="https://github.com/bkaradzic/bgfx/raw/master/examples/43-denoise/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="sss">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="sss">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/44-sss">44-sss</a><a class="headerlink" href="#sss" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Screen-Space Shadows</p>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-44-sss" src="https://github.com/bkaradzic/bgfx/raw/master/examples/44-sss/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
<section id="bokeh">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bokeh">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/45-bokeh">45-bokeh</a><a class="headerlink" href="#bokeh" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Bokeh Depth of Field</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -1263,32 +1256,48 @@ off programatically.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<figure class="align-default">
|
||||
<div class="figure align-default">
|
||||
<img alt="example-45-bokeh" src="https://github.com/bkaradzic/bgfx/raw/master/examples/45-bokeh/screenshot.png" />
|
||||
</figure>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="fsr">
|
||||
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/tree/master/examples/46-fsr">46-fsr</a><a class="headerlink" href="#fsr" title="Permalink to this headline">¶</a></h2>
|
||||
<p>AMD FidelityFX Super Resolution - high-quality solution for producing high resolution frames
|
||||
from lower resolution inputs.</p>
|
||||
<div class="figure align-default">
|
||||
<img alt="example-46-fsr" src="https://github.com/bkaradzic/bgfx/raw/master/examples/46-fsr/screenshot.png" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<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" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="build.html" class="btn btn-neutral float-left" title="Building" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
|
||||
<a href="bgfx.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="build.html" class="btn btn-neutral float-left" title="Building" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Index — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -13,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -54,7 +49,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -137,8 +132,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -150,7 +143,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -601,6 +594,8 @@
|
|||
<li><a href="bgfx.html#_CPPv4N4bgfx12RendererTypeE">bgfx::RendererType (C++ struct)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx12RendererType4EnumE">bgfx::RendererType::Enum (C++ enum)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx12RendererType4Enum3AgcE">bgfx::RendererType::Enum::Agc (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx12RendererType4Enum5CountE">bgfx::RendererType::Enum::Count (C++ enumerator)</a>
|
||||
</li>
|
||||
|
|
@ -757,11 +752,11 @@
|
|||
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats11numTexturesE">bgfx::Stats::numTextures (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats11numUniformsE">bgfx::Stats::numUniforms (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats16numVertexBuffersE">bgfx::Stats::numVertexBuffers (C++ member)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats16numVertexBuffersE">bgfx::Stats::numVertexBuffers (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats16numVertexLayoutsE">bgfx::Stats::numVertexLayouts (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="bgfx.html#_CPPv4N4bgfx5Stats8numViewsE">bgfx::Stats::numViews (C++ member)</a>
|
||||
|
|
@ -1359,17 +1354,20 @@
|
|||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
40
index.html
40
index.html
|
|
@ -3,10 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Documentation — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -14,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -56,7 +50,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="#" class="icon icon-home"> bgfx
|
||||
<a href="#" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -139,8 +133,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -152,7 +144,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -164,7 +156,7 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="documentation">
|
||||
<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>
|
||||
|
|
@ -174,7 +166,7 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<section id="contents">
|
||||
<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>
|
||||
|
|
@ -277,6 +269,7 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<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>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
|
|
@ -355,28 +348,35 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<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>
|
||||
|
||||
<a href="overview.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,10 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Internals — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -14,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -57,7 +51,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -151,8 +145,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -164,7 +156,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -176,9 +168,9 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="internals">
|
||||
<div class="section" id="internals">
|
||||
<h1>Internals<a class="headerlink" href="#internals" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="sort-based-draw-call-bucketing">
|
||||
<div class="section" id="sort-based-draw-call-bucketing">
|
||||
<h2>Sort based draw call bucketing<a class="headerlink" href="#sort-based-draw-call-bucketing" title="Permalink to this headline">¶</a></h2>
|
||||
<p>bgfx is using sort-based draw call bucketing. This means that submission order doesn’t necessarily match the rendering order, but on the low-level they will be sorted and ordered correctly. On the high level bgfx uses <strong>declarative API</strong> and internal sorting allows more optimal way of submitting draw calls for all passes at one place, and on the low-level this allows better optimization of rendering order. This sometimes creates undesired results usually for GUI rendering, where draw order should usually match submit order. bgfx provides way to enable sequential rendering for these cases (see <code class="docutils literal notranslate"><span class="pre">bgfx::setViewMode</span></code>).</p>
|
||||
<blockquote>
|
||||
|
|
@ -186,59 +178,67 @@
|
|||
<li><p>More detailed description of sort-based draw call bucketing can be found at: <a class="reference external" href="http://realtimecollisiondetection.net/blog/?p=86">Order your graphics draw calls around!</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="api-and-render-thread">
|
||||
</div>
|
||||
<div class="section" id="api-and-render-thread">
|
||||
<h2>API and render thread<a class="headerlink" href="#api-and-render-thread" title="Permalink to this headline">¶</a></h2>
|
||||
<p>API thread is thread from which <code class="docutils literal notranslate"><span class="pre">bgfx::init</span></code> is called. Once <code class="docutils literal notranslate"><span class="pre">bgfx::init</span></code> is called on thread, internally bgfx assumes that all API calls will be called from the same thread with exception of Resource, View, and Encoder API.</p>
|
||||
<p>Render thread from where internal rendering <code class="docutils literal notranslate"><span class="pre">bgfx::renderFrame</span></code> is called. On most of OS’ it’s required that this call be called on thread that OS created when executing process (some refer to this thread as “main” thread, or thread where <code class="docutils literal notranslate"><span class="pre">main</span></code> function is called).</p>
|
||||
<p>When bgfx is compiled with option <code class="docutils literal notranslate"><span class="pre">BGFX_CONFIG_MULTITHREADED=1</span></code> (default is on) <code class="docutils literal notranslate"><span class="pre">bgfx::renderFrame</span></code> can be called by user. It’s required to be called before <code class="docutils literal notranslate"><span class="pre">bgfx::init</span></code> from thread that will be used as render thread. If both <code class="docutils literal notranslate"><span class="pre">bgfx::renderFrame</span></code> and <code class="docutils literal notranslate"><span class="pre">bgfx::init</span></code> are called from the same thread, bgfx will switch to execute in single threaded mode, and calling <code class="docutils literal notranslate"><span class="pre">bgfx::renderFrame</span></code> is not required, since it will be called automatically during <code class="docutils literal notranslate"><span class="pre">bgfx::frame</span></code> call.</p>
|
||||
</section>
|
||||
<section id="resource-api">
|
||||
</div>
|
||||
<div class="section" id="resource-api">
|
||||
<h2>Resource API<a class="headerlink" href="#resource-api" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Any API call starting with <code class="docutils literal notranslate"><span class="pre">bgfx::create*</span></code>, <code class="docutils literal notranslate"><span class="pre">bgfx::destroy*</span></code>, <code class="docutils literal notranslate"><span class="pre">bgfx::update*</span></code>, <code class="docutils literal notranslate"><span class="pre">bgfx::alloc*</span></code> is considered part of resource API. Internally resource API calls are guarded by mutex. There is no limit of number of threads that can call resource API simultaneously. Calling any resource API is infrequent, and functions are cheap since most of work with resource is done at later point on render thread.</p>
|
||||
</section>
|
||||
<section id="view-api">
|
||||
</div>
|
||||
<div class="section" id="view-api">
|
||||
<h2>View API<a class="headerlink" href="#view-api" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Any API call starting with <code class="docutils literal notranslate"><span class="pre">bgfx::setView*</span></code> is considered part of view API. View API is not designed to be thread safe at all since all views are independentent from each other. Calling any view API for different views from different threads is safe. What’s not safe is to update the same view from multiple threads. This will lead to undefined behavior. Only view API that has to be set before any draw calls are issued is view mode <code class="docutils literal notranslate"><span class="pre">bgfx::setViewMode</span></code>. Internal encoder requires view mode to select sort key encoding and if user changes view mode after submit it will cause incorrect sort behavior within the view.</p>
|
||||
</section>
|
||||
<section id="encoder-api">
|
||||
</div>
|
||||
<div class="section" id="encoder-api">
|
||||
<h2>Encoder API<a class="headerlink" href="#encoder-api" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Encoder API can be obtained by calling <code class="docutils literal notranslate"><span class="pre">bgfx::begin</span></code>. bgfx by default allows 8 simultaneous threads to use encoders. This can be configured by changing <code class="docutils literal notranslate"><span class="pre">Limits.maxEncoders</span></code> init option of <code class="docutils literal notranslate"><span class="pre">bgfx::Init</span></code> structure.</p>
|
||||
</section>
|
||||
<section id="customization">
|
||||
</div>
|
||||
<div class="section" id="customization">
|
||||
<h2>Customization<a class="headerlink" href="#customization" title="Permalink to this headline">¶</a></h2>
|
||||
<p>By default each platform has sane default values. For example on Windows default renderer is DirectX, on Linux it is OpenGL, and on OSX it’s Metal. On Windows platform almost all rendering backends are available. For OpenGL ES on desktop you can find more information at:- <a class="reference external" href="http://www.g-truc.net/post-0457.html">OpenGL ES 2.0 and EGL on desktop</a></p>
|
||||
<p>If you’re targeting specific mobile hardware, you can find GLES support in their official SDKs: <a class="reference external" href="http://developer.qualcomm.com/mobile-development/mobile-technologies/gaming-graphics-optimization-adreno/tools-and-resources">Adreno
|
||||
SDK</a>, <a class="reference external" href="http://www.malideveloper.com/">Mali SDK</a>, <a class="reference external" href="http://www.imgtec.com/powervr/insider/sdkdownloads/">PowerVR SDK</a>.</p>
|
||||
<p>All configuration settings are located inside <a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/src/config.h">src/config.h</a>.</p>
|
||||
<p>Every <code class="docutils literal notranslate"><span class="pre">BGFX_CONFIG_*</span></code> setting can be changed by passing defines thru compiler switches. For example setting preprocessor define <code class="docutils literal notranslate"><span class="pre">BGFX_CONFIG_RENDERER_OPENGL=1</span></code> will change backend renderer to OpenGL 2.1. on Windows. Since rendering APIs are platform specific, this obviously won’t work nor make sense in all cases.</p>
|
||||
<section id="options">
|
||||
<div class="section" id="options">
|
||||
<h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">BGFX_CONFIG_MULTITHREADED</span></code> is used to enable/disable threading support inside bgfx. By default set to 1 on all platforms that support threading.</p>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<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" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="tools.html" class="btn btn-neutral float-left" title="Tools" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
|
||||
<a href="license.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="tools.html" class="btn btn-neutral float-left" title="Tools" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
91
license.html
91
license.html
|
|
@ -3,10 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>License — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -14,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -56,7 +50,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -157,8 +151,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -170,7 +162,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -182,9 +174,9 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="license">
|
||||
<div class="section" id="license">
|
||||
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="license-bsd-2-clause">
|
||||
<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-default notranslate"><div class="highlight"><pre><span></span><span class="n">Copyright</span> <span class="mi">2010</span><span class="o">-</span><span class="mi">2020</span> <span class="n">Branimir</span> <span class="n">Karadzic</span>
|
||||
|
||||
|
|
@ -210,13 +202,13 @@
|
|||
<span class="n">OF</span> <span class="n">THE</span> <span class="n">POSSIBILITY</span> <span class="n">OF</span> <span class="n">SUCH</span> <span class="n">DAMAGE</span><span class="o">.</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="rd-party-libraries">
|
||||
</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>
|
||||
<section id="blendish-mit">
|
||||
<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>
|
||||
|
|
@ -224,8 +216,8 @@ directory.</p>
|
|||
<li><p><a class="reference external" href="https://bitbucket.org/duangle/oui-blendish">https://bitbucket.org/duangle/oui-blendish</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="edtaa3-mit">
|
||||
</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>
|
||||
|
|
@ -233,8 +225,8 @@ directory.</p>
|
|||
<li><p><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></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="fcpp-bsd">
|
||||
</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>
|
||||
|
|
@ -242,24 +234,24 @@ directory.</p>
|
|||
<li><p><a class="reference external" href="https://github.com/bagder/fcpp">https://github.com/bagder/fcpp</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="forsyth-triangle-order-optimizer-public-domain">
|
||||
</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><p><a class="reference external" href="http://gameangst.com/?p=9">http://gameangst.com/?p=9</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="freetype">
|
||||
</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><p><a class="reference external" href="http://www.freetype.org/">http://www.freetype.org/</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="glsl-optimizer-mit">
|
||||
</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>
|
||||
|
|
@ -268,8 +260,8 @@ shader optimization.</p>
|
|||
<li><p><a class="reference external" href="https://github.com/aras-p/glsl-optimizer">https://github.com/aras-p/glsl-optimizer</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="nanovg-zlib">
|
||||
</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>
|
||||
|
|
@ -277,8 +269,8 @@ shader optimization.</p>
|
|||
<li><p><a class="reference external" href="https://github.com/memononen/nanovg">https://github.com/memononen/nanovg</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="imgui-mit">
|
||||
</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>
|
||||
|
|
@ -287,8 +279,8 @@ dependencies.</p>
|
|||
<li><p><a class="reference external" href="https://github.com/ocornut/imgui">https://github.com/ocornut/imgui</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="sdf-mit">
|
||||
</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>
|
||||
|
|
@ -297,25 +289,25 @@ contour texturing.</p>
|
|||
<li><p><a class="reference external" href="https://github.com/memononen/SDF">https://github.com/memononen/SDF</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="stb-public-domain">
|
||||
</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><p><a class="reference external" href="http://nothings.org">http://nothings.org</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="vertex-cache-optimised-index-buffer-compression-bsd">
|
||||
</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><p><a class="reference external" href="https://github.com/ConorStokes/IndexBufferCompression">https://github.com/ConorStokes/IndexBufferCompression</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</section>
|
||||
<section id="assets">
|
||||
</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>
|
||||
|
|
@ -426,28 +418,35 @@ contour texturing.</p>
|
|||
<li><p><a class="reference external" href="https://commons.wikimedia.org/wiki/File:Normal_map_example_with_scene_and_result.png">https://commons.wikimedia.org/wiki/File:Normal_map_example_with_scene_and_result.png</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="internals.html" class="btn btn-neutral float-left" title="Internals" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
|
||||
|
||||
<a href="internals.html" class="btn btn-neutral float-left" title="Internals" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
|
|
@ -3,10 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Overview — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -14,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -57,7 +51,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -163,8 +157,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -176,7 +168,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -188,16 +180,16 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="overview">
|
||||
<div class="section" id="overview">
|
||||
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="what-is-it">
|
||||
<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><section id="supported-rendering-backends">
|
||||
</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>
|
||||
|
|
@ -214,8 +206,8 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<li><p>WebGL 2.0</p></li>
|
||||
<li><p>WebGPU/Dawn (experimental)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="supported-platforms">
|
||||
</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>
|
||||
|
|
@ -230,16 +222,16 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<li><p>Windows (XP, Vista, 7, 8, 10)</p></li>
|
||||
<li><p>UWP (Universal Windows, Xbox One)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="supported-compilers">
|
||||
</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>
|
||||
</section>
|
||||
<section id="supported-languages">
|
||||
</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>
|
||||
|
|
@ -257,14 +249,14 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<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/Akira13641/PasBGFX">Pascal language API bindings</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="project-page">
|
||||
</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>
|
||||
</section>
|
||||
<section id="contact">
|
||||
</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">
|
||||
|
|
@ -274,11 +266,11 @@ licensed under permissive BSD-2 clause open source license.</p>
|
|||
<li><p>Twitter <a class="reference external" href="https://twitter.com/bkaradzic">@bkaradzic</a></p></li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</section>
|
||||
<section id="debugging-and-profiling">
|
||||
</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>
|
||||
<section id="renderdoc">
|
||||
<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
|
||||
|
|
@ -289,16 +281,16 @@ initialization. This allows frame capture at any time by pressing
|
|||
<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>
|
||||
</section>
|
||||
<section id="intelgpa">
|
||||
</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>
|
||||
</section>
|
||||
<section id="other-debuggers-and-profilers">
|
||||
</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>
|
||||
|
|
@ -463,9 +455,9 @@ in GPA directory and add <code class="docutils literal notranslate"><span class=
|
|||
<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>
|
||||
</section>
|
||||
</section>
|
||||
<section id="sdl-glfw-etc">
|
||||
</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
|
||||
|
|
@ -489,8 +481,8 @@ Each platform has rules about where renderer can be and how multithreading inter
|
|||
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>
|
||||
</section>
|
||||
<section id="getting-involved">
|
||||
</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>),
|
||||
|
|
@ -500,7 +492,7 @@ 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>
|
||||
<section id="contributors">
|
||||
<div class="section" id="contributors">
|
||||
<h3>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Chrnonological order:</p>
|
||||
<blockquote>
|
||||
|
|
@ -590,38 +582,47 @@ bindings.</p></li>
|
|||
<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>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<p>and <a class="reference external" href="https://github.com/bkaradzic/bgfx/graphs/contributors">others</a>…</p>
|
||||
</section>
|
||||
<section id="repository-visualization">
|
||||
</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></section>
|
||||
</section>
|
||||
</section>
|
||||
</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" aria-hidden="true"></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" aria-hidden="true"></span> Previous</a>
|
||||
|
||||
<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-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
23
search.html
23
search.html
|
|
@ -3,9 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Search — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -13,18 +13,13 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
|
|
@ -32,16 +27,15 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="#" />
|
||||
</head>
|
||||
|
|
@ -57,7 +51,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -140,8 +134,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -153,6 +145,8 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
|
@ -180,17 +174,20 @@
|
|||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
64
tools.html
64
tools.html
|
|
@ -3,10 +3,9 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Tools — bgfx 1.0 documentation</title>
|
||||
|
||||
|
|
@ -14,28 +13,23 @@
|
|||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.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 data-url_root="./" id="documentation_options" 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>
|
||||
|
||||
|
|
@ -57,7 +51,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> bgfx
|
||||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> bgfx
|
||||
|
||||
|
||||
|
||||
|
|
@ -150,8 +144,6 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
|
@ -163,7 +155,7 @@
|
|||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -175,9 +167,9 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="tools">
|
||||
<div class="section" id="tools">
|
||||
<h1>Tools<a class="headerlink" href="#tools" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="geometry-compiler-geometryc">
|
||||
<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>
|
||||
<p>Converts Wavefront .obj, or glTF 2.0 mesh file to format optimal for using with bgfx.</p>
|
||||
<p>Usage:</p>
|
||||
|
|
@ -260,12 +252,12 @@ More steps slower calculation.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="geometry-viewer-geometryv">
|
||||
</div>
|
||||
<div class="section" id="geometry-viewer-geometryv">
|
||||
<h2>Geometry Viewer (geometryv)<a class="headerlink" href="#geometry-viewer-geometryv" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Geometry viewer.</p>
|
||||
</section>
|
||||
<section id="shader-compiler-shaderc">
|
||||
</div>
|
||||
<div class="section" id="shader-compiler-shaderc">
|
||||
<h2>Shader Compiler (shaderc)<a class="headerlink" href="#shader-compiler-shaderc" title="Permalink to this headline">¶</a></h2>
|
||||
<p>bgfx cross-platform shader language is based on GLSL syntax. It’s uses
|
||||
ANSI C preprocessor to transform GLSL like language syntax into HLSL.
|
||||
|
|
@ -327,7 +319,7 @@ macros</a>.</p>
|
|||
<dd><p>Do not process shader. No preprocessor, and no glsl-optimizer (GLSL only).</p>
|
||||
</dd>
|
||||
<dt><kbd><span class="option">--type <var><type></var></span></kbd></dt>
|
||||
<dd><p>Shader type (vertex, fragment)</p>
|
||||
<dd><p>Shader type (vertex, fragment, compute)</p>
|
||||
</dd>
|
||||
<dt><kbd><span class="option">--varyingdef <var><file path></var></span></kbd></dt>
|
||||
<dd><p>Path to varying.def.sc file.</p>
|
||||
|
|
@ -355,13 +347,13 @@ macros</a>.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<section id="building-shaders">
|
||||
<div class="section" id="building-shaders">
|
||||
<h3>Building shaders<a class="headerlink" href="#building-shaders" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Shaders must be compiled for all renderers by using <cite>shaderc</cite> tool. Makefile to simplify building
|
||||
shaders is provided in examples. D3D shaders can be only compiled on Windows.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="texture-compiler-texturec">
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="texture-compiler-texturec">
|
||||
<h2>Texture Compiler (texturec)<a class="headerlink" href="#texture-compiler-texturec" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Convert PNG, TGA, DDS, KTX, PVR texture into bgfx supported texture formats.</p>
|
||||
<p>Usage:</p>
|
||||
|
|
@ -498,33 +490,41 @@ shaders is provided in examples. D3D shaders can be only compiled on Windows.</p
|
|||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="texture-viewer-texturev">
|
||||
</div>
|
||||
<div class="section" id="texture-viewer-texturev">
|
||||
<h2>Texture Viewer (texturev)<a class="headerlink" href="#texture-viewer-texturev" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Texture viewer.</p>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="internals.html" class="btn btn-neutral float-right" title="Internals" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="bgfx.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
|
||||
<a href="internals.html" class="btn btn-neutral float-right" title="Internals" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="bgfx.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2010-2020, Branimir Karadžić.
|
||||
|
||||
© Copyright 2010-2020, Branimir Karadžić
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue