Updated docs.

This commit is contained in:
Branimir Karadžić
2016-11-04 09:58:00 -07:00
parent d76ca54044
commit b83eab8c1b
17 changed files with 233 additions and 11901 deletions

View File

@@ -52,6 +52,8 @@ div.sphinxsidebar {
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
}
div.sphinxsidebar #searchbox input[type="submit"] {
width: 30px;
}
img {
border: 0;
max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
/* -- general body styles --------------------------------------------------- */
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
@@ -489,6 +494,13 @@ pre {
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
}
td.linenos pre {
padding: 5px 0px;
border: 0;

View File

@@ -124,6 +124,7 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
},
/**
@@ -252,6 +253,29 @@ var Documentation = {
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
},
initOnKeyListeners: function() {
$(document).keyup(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
}
}
});
}
};
@@ -260,4 +284,4 @@ _ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});
});

10355
_static/jquery.js vendored

File diff suppressed because one or more lines are too long

View File

@@ -2,7 +2,7 @@
* searchtools.js_t
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilties for the full-text search.
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
@@ -324,7 +324,7 @@ var Search = {
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = query.split(/\s+/);
var tmp = query.split(/\W+/);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
@@ -623,7 +623,7 @@ var Search = {
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurance, the
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {

File diff suppressed because it is too large Load Diff

View File

@@ -2,7 +2,7 @@
* websupport.js
* ~~~~~~~~~~~~~
*
* sphinx.websupport utilties for all documentation.
* sphinx.websupport utilities for all documentation.
*
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.

165
bgfx.html
View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
<link rel="next" title="Tools" href="tools.html"/>
<link rel="prev" title="Examples" href="examples.html"/>
@@ -85,7 +88,7 @@
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">API Reference</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#general">General</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#initialization-and-shutdown">Initialization and Shutdown</a></li>
<li class="toctree-l3"><a class="reference internal" href="#updating">Updating</a><ul>
@@ -210,7 +213,7 @@
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_init</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_type</span></code> - <p>Select rendering backend. When set to RendererType::Count default rendering backend will be selected. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_renderer_type"><span><span class="pre">bgfx::RendererType</span></span></a></code></p>
<li><code class="first docutils literal"><span class="pre">_type</span></code> - <p>Select rendering backend. When set to RendererType::Count default rendering backend will be selected. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_renderer_type"><span class="std std-ref"><span class="pre">bgfx::RendererType</span></span></a></code></p>
</li>
<li><code class="first docutils literal"><span class="pre">_vendorId</span></code> - <p>Vendor PCI id. If set to <code class="docutils literal"><span class="pre">BGFX_PCI_ID_NONE</span></code> it will select the first device.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_NONE</span></code> - Autoselect adapter.</li>
@@ -223,7 +226,7 @@
</li>
<li><code class="first docutils literal"><span class="pre">_deviceId</span></code> - <p>Device id. If set to 0 it will select first device, or device with matching id.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_callback</span></code> - <p>Provide application specific callback interface. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_callback_i"><span><span class="pre">bgfx::CallbackI</span></span></a></code></p>
<li><code class="first docutils literal"><span class="pre">_callback</span></code> - <p>Provide application specific callback interface. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_callback_i"><span class="std std-ref"><span class="pre">bgfx::CallbackI</span></span></a></code></p>
</li>
<li><code class="first docutils literal"><span class="pre">_allocator</span></code> - <p>Custom allocator. When custom allocator is not specified, library uses default CRT allocator. The library assumes custom allocator is thread safe.</p>
</li>
@@ -496,9 +499,9 @@
<li><code class="docutils literal"><span class="pre">BGFX_RESET_VSYNC</span></code> - Enable V-Sync.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_MAXANISOTROPY</span></code> - Turn on/off max anisotropy.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_CAPTURE</span></code> - Begin screen capture.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD</span></code> - <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span>HMD</span></a> stereo rendering.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD_DEBUG</span></code> - <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span>HMD</span></a> stereo rendering debug mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD_RECENTER</span></code> - <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span>HMD</span></a> calibration.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD</span></code> - <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span class="std std-ref">HMD</span></a> stereo rendering.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD_DEBUG</span></code> - <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span class="std std-ref">HMD</span></a> stereo rendering debug mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD_RECENTER</span></code> - <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span class="std std-ref">HMD</span></a> calibration.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_FLUSH_AFTER_RENDER</span></code> - Flush rendering after submitting to GPU.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_FLIP_AFTER_RENDER</span></code> - This flag specifies where flip occurs. Default behavior is that flip occurs before rendering new frame. This flag only has effect when <code class="docutils literal"><span class="pre">BGFX_CONFIG_MULTITHREADED=0</span></code>.</li>
<li><code class="docutils literal"><span class="pre">BGFX_RESET_SRGB_BACKBUFFER</span></code> - Enable sRGB backbuffer.</li>
@@ -622,7 +625,7 @@
<dd><p>Advance to next frame. When using multithreaded renderer, this call just swaps internal buffers, kicks render thread, and returns. In singlethreaded renderer this call does frame rendering. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Current frame number. This might be used in conjunction with double/multi buffering data outside the library and passing it to library via <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span><span class="pre">bgfx::makeRef</span></span></a></code> calls.</dd>
<dd>Current frame number. This might be used in conjunction with double/multi buffering data outside the library and passing it to library via <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span class="std std-ref"><span class="pre">bgfx::makeRef</span></span></a></code> calls.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_frame</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
@@ -886,7 +889,7 @@
<dd><p>Returns renderer capabilities. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Pointer to static <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_caps"><span><span class="pre">bgfx::Caps</span></span></a></code> structure.</dd>
<dd>Pointer to static <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_caps"><span class="std std-ref"><span class="pre">bgfx::Caps</span></span></a></code> structure.</dd>
<dt><strong>Remark</strong></dt>
<dd>Library must be initialized.</dd>
<dt><strong>Attention</strong></dt>
@@ -909,7 +912,7 @@
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps12rendererTypeE">
<span id="bgfx::Caps::rendererType__RendererType::Enum"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1a68960bb9621a6e4b0cad7e0f326ab3fd"></span><a class="reference internal" href="#_CPPv2N4bgfx12RendererTypeE" title="bgfx::RendererType">RendererType</a>::<a class="reference internal" href="#_CPPv2N4bgfx12RendererType4EnumE" title="bgfx::RendererType::Enum">Enum</a> <code class="descname">rendererType</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps12rendererTypeE" title="Permalink to this definition"></a></dt>
<dd><p>Renderer backend type. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_renderer_type"><span><span class="pre">bgfx::RendererType</span></span></a></code> </p>
<dd><p>Renderer backend type. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_renderer_type"><span class="std std-ref"><span class="pre">bgfx::RendererType</span></span></a></code> </p>
</dd></dl>
<dl class="member">
@@ -926,13 +929,13 @@
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps8vendorIdE">
<span id="bgfx::Caps::vendorId__uint16_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1ac51fdd2bed74e1e71480409bd40bc4bc"></span>uint16_t <code class="descname">vendorId</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps8vendorIdE" title="Permalink to this definition"></a></dt>
<dd><p>Selected <a class="reference internal" href="#bgfxstructbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> vendor PCI id. </p>
<dd><p>Selected <a class="reference internal" href="#bgfxstructbgfx_1_1_caps_1_1_g_p_u"><span class="std std-ref">GPU</span></a> vendor PCI id. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps8deviceIdE">
<span id="bgfx::Caps::deviceId__uint16_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1a7c63448a97f4d09b275c353cdb295a8b"></span>uint16_t <code class="descname">deviceId</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps8deviceIdE" title="Permalink to this definition"></a></dt>
<dd><p>Selected <a class="reference internal" href="#bgfxstructbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> device id. </p>
<dd><p>Selected <a class="reference internal" href="#bgfxstructbgfx_1_1_caps_1_1_g_p_u"><span class="std std-ref">GPU</span></a> device id. </p>
</dd></dl>
<dl class="member">
@@ -987,7 +990,7 @@
<dl class="class">
<dt id="_CPPv2N4bgfx4Caps3GPUE">
<span id="bgfx::Caps::GPU"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1_1_g_p_u"></span><em class="property">struct </em><code class="descname">GPU</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps3GPUE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> info. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_caps_1_1_g_p_u"><span class="std std-ref">GPU</span></a> info. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_caps_gpu_t</span></code>. </dd>
@@ -1321,7 +1324,7 @@
<dl class="function">
<dt id="_CPPv2N4bgfx6getHMDEv">
<span id="bgfx::getHMD"></span><span class="target" id="bgfxnamespacebgfx_1a4da6ccef4febaf717d877852ac6b2b25"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx3HMDE" title="bgfx::HMD">HMD</a> *<code class="descclassname">bgfx::</code><code class="descname">getHMD</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6getHMDEv" title="Permalink to this definition"></a></dt>
<dd><p>Returns <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span>HMD</span></a> info. </p>
<dd><p>Returns <a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span class="std std-ref">HMD</span></a> info. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_hmd</span></code>. </dd>
@@ -1332,7 +1335,7 @@
<dl class="class">
<dt id="_CPPv2N4bgfx3HMDE">
<span id="bgfx::HMD"></span><span class="target" id="bgfxstructbgfx_1_1_h_m_d"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">HMD</code><a class="headerlink" href="#_CPPv2N4bgfx3HMDE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span>HMD</span></a> info. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d"><span class="std std-ref">HMD</span></a> info. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_hmd_t</span></code>. </dd>
@@ -1374,7 +1377,7 @@
<dl class="class">
<dt id="_CPPv2N4bgfx3HMD3EyeE">
<span id="bgfx::HMD::Eye"></span><span class="target" id="bgfxstructbgfx_1_1_h_m_d_1_1_eye"></span><em class="property">struct </em><code class="descname">Eye</code><a class="headerlink" href="#_CPPv2N4bgfx3HMD3EyeE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a>. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span class="std std-ref">Eye</span></a>. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_hmd_eye_t</span></code>. </dd>
@@ -1385,13 +1388,13 @@
<dl class="member">
<dt id="_CPPv2N4bgfx3HMD3Eye8rotationE">
<span id="bgfx::HMD::Eye::rotation__floatA"></span><span class="target" id="bgfxstructbgfx_1_1_h_m_d_1_1_eye_1a5cd423f29878115cce05edd155e7323d"></span>float <code class="descname">rotation</code>[4]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye8rotationE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a> rotation represented as quaternion. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span class="std std-ref">Eye</span></a> rotation represented as quaternion. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx3HMD3Eye11translationE">
<span id="bgfx::HMD::Eye::translation__floatA"></span><span class="target" id="bgfxstructbgfx_1_1_h_m_d_1_1_eye_1a668e56a83e86667feb2475d4f7023da8"></span>float <code class="descname">translation</code>[3]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye11translationE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a> translation. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span class="std std-ref">Eye</span></a> translation. </p>
</dd></dl>
<dl class="member">
@@ -1403,13 +1406,13 @@
<dl class="member">
<dt id="_CPPv2N4bgfx3HMD3Eye10viewOffsetE">
<span id="bgfx::HMD::Eye::viewOffset__floatA"></span><span class="target" id="bgfxstructbgfx_1_1_h_m_d_1_1_eye_1a66c74ef9fc006582cbb89dc1a66d9802"></span>float <code class="descname">viewOffset</code>[3]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye10viewOffsetE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a> view matrix translation adjustment. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span class="std std-ref">Eye</span></a> view matrix translation adjustment. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx3HMD3Eye10projectionE">
<span id="bgfx::HMD::Eye::projection__floatA"></span><span class="target" id="bgfxstructbgfx_1_1_h_m_d_1_1_eye_1aba4db0b11b3793e075464e34e307eebb"></span>float <code class="descname">projection</code>[16]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye10projectionE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a> projection matrix. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_h_m_d_1_1_eye"><span class="std std-ref">Eye</span></a> projection matrix. </p>
</dd></dl>
</div>
@@ -1447,9 +1450,9 @@ creating windows.</p>
<dd><p>Render frame. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Current renderer state. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_render_frame"><span><span class="pre">bgfx::RenderFrame</span></span></a></code>.</dd>
<dd>Current renderer state. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_render_frame"><span class="std std-ref"><span class="pre">bgfx::RenderFrame</span></span></a></code>.</dd>
<dt><strong>Warning</strong></dt>
<dd>This call should be only used on platforms that don&#8217;t allow creating separate rendering thread. If it is called before to <a class="reference internal" href="#bgfxnamespacebgfx_1a7b8a6d9f8eaf252f1b1f62d2a5c5d548"><span>bgfx::init</span></a>, render thread won&#8217;t be created by <a class="reference internal" href="#bgfxnamespacebgfx_1a7b8a6d9f8eaf252f1b1f62d2a5c5d548"><span>bgfx::init</span></a> call. </dd>
<dd>This call should be only used on platforms that don&#8217;t allow creating separate rendering thread. If it is called before to <a class="reference internal" href="#bgfxnamespacebgfx_1a7b8a6d9f8eaf252f1b1f62d2a5c5d548"><span class="std std-ref">bgfx::init</span></a>, render thread won&#8217;t be created by <a class="reference internal" href="#bgfxnamespacebgfx_1a7b8a6d9f8eaf252f1b1f62d2a5c5d548"><span class="std std-ref">bgfx::init</span></a> call. </dd>
</dl>
</p>
</dd></dl>
@@ -1471,7 +1474,7 @@ creating windows.</p>
<dd><p>Set platform data. </p>
<p><dl class="docutils">
<dt><strong>Warning</strong></dt>
<dd>Must be called before <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b8a6d9f8eaf252f1b1f62d2a5c5d548"><span><span class="pre">bgfx::init</span></span></a></code>.</dd>
<dd>Must be called before <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b8a6d9f8eaf252f1b1f62d2a5c5d548"><span class="std std-ref"><span class="pre">bgfx::init</span></span></a></code>.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_platform_data</span></code>. </dd>
</dl>
@@ -1617,7 +1620,7 @@ creating windows.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_numMips</span></code> - <p>Number of mip-maps. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
@@ -1769,7 +1772,7 @@ creating windows.</p>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_topology_convert</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_conversion</span></code> - <p>Conversion type, see <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153"><span><span class="pre">TopologyConvert::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_conversion</span></code> - <p>Conversion type, see <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153"><span class="std std-ref"><span class="pre">TopologyConvert::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_dst</span></code> - <p>Destination index buffer. If this argument it NULL function will return number of indices after conversion. </p>
</li>
@@ -1882,7 +1885,7 @@ creating windows.</p>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_topology_sort_tri_list</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_sort</span></code> - <p>Sort order, see <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1"><span><span class="pre">TopologySort::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_sort</span></code> - <p>Sort order, see <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1"><span class="std std-ref"><span class="pre">TopologySort::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_dst</span></code> - <p>Destination index buffer. </p>
</li>
@@ -2000,12 +2003,12 @@ creating windows.</p>
<dd><p>Request screen shot. </p>
<p><dl class="docutils">
<dt><strong>Remark</strong></dt>
<dd><code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"><span><span class="pre">bgfx::CallbackI::screenShot</span></span></a></code> must be implemented.</dd>
<dd><code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"><span class="std std-ref"><span class="pre">bgfx::CallbackI::screenShot</span></span></a></code> must be implemented.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_save_screen_shot</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_filePath</span></code> - <p>Will be passed to <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"><span><span class="pre">bgfx::CallbackI::screenShot</span></span></a></code> callback.</p>
<li><code class="first docutils literal"><span class="pre">_filePath</span></code> - <p>Will be passed to <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"><span class="std std-ref"><span class="pre">bgfx::CallbackI::screenShot</span></span></a></code> callback.</p>
</li>
</ul>
</dd>
@@ -2033,11 +2036,11 @@ known until the last moment, view ids can be remaped to arbitrary order by calli
<span id="bgfx::setViewName__uint8_t.cCP"></span><span class="target" id="bgfxnamespacebgfx_1ab0d0a3f61f5adc31ee7f59f2893cfcd9"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewName</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, <em class="property">const</em> char *<em>_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11setViewNameE7uint8_tPKc" title="Permalink to this definition"></a></dt>
<dd><p>Set view name. </p>
<p>
In graphics debugger view name will appear as: <div class="highlight-python"><div class="highlight"><pre>&quot;nnnce &lt;view name&gt;&quot;
^ ^^ ^
| |+-- eye (L/R)
| +--- compute (C)
+------ view id
In graphics debugger view name will appear as: <div class="highlight-default"><div class="highlight"><pre><span></span><span class="s2">&quot;nnnce &lt;view name&gt;&quot;</span>
<span class="o">^</span> <span class="o">^^</span> <span class="o">^</span>
<span class="o">|</span> <span class="o">|+--</span> <span class="n">eye</span> <span class="p">(</span><span class="n">L</span><span class="o">/</span><span class="n">R</span><span class="p">)</span>
<span class="o">|</span> <span class="o">+---</span> <span class="n">compute</span> <span class="p">(</span><span class="n">C</span><span class="p">)</span>
<span class="o">+------</span> <span class="n">view</span> <span class="nb">id</span>
</pre></div>
</div>
<dl class="docutils">
@@ -2251,7 +2254,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
<dd><p>Set view frame buffer. </p>
<p><dl class="docutils">
<dt><strong>Remark</strong></dt>
<dd>Not persistent after <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1ab2506f91853a4c3bb0f25b581638291c"><span><span class="pre">bgfx::reset</span></span></a></code> call.</dd>
<dd>Not persistent after <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1ab2506f91853a4c3bb0f25b581638291c"><span class="std std-ref"><span class="pre">bgfx::reset</span></span></a></code> call.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_frame_buffer</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
@@ -2391,7 +2394,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx10setScissorE8uint16_t8uint16_t8uint16_t8uint16_t">
<span id="bgfx::setScissor__uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="bgfxnamespacebgfx_1a044469089552c76b36ec5e5ac57cf695"></span>uint16_t <code class="descclassname">bgfx::</code><code class="descname">setScissor</code><span class="sig-paren">(</span>uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setScissorE8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition"></a></dt>
<dd><p>Set scissor for draw primitive. For scissor for all primitives in view see <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a3d1b68d9678d716e25795aa3eef2bfe1"><span><span class="pre">bgfx::setViewScissor</span></span></a></code>. </p>
<dd><p>Set scissor for draw primitive. For scissor for all primitives in view see <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a3d1b68d9678d716e25795aa3eef2bfe1"><span class="std std-ref"><span class="pre">bgfx::setViewScissor</span></span></a></code>. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Scissor cache index.</dd>
@@ -2436,7 +2439,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx14allocTransformEP9Transform8uint16_t">
<span id="bgfx::allocTransform__TransformP.uint16_t"></span><span class="target" id="bgfxnamespacebgfx_1a659b2048c1d0720027307fcdc5ce65e5"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">allocTransform</code><span class="sig-paren">(</span>Transform *<em>_transform</em>, uint16_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14allocTransformEP9Transform8uint16_t" title="Permalink to this definition"></a></dt>
<dd><p>Reserve <code class="docutils literal"><span class="pre">_num</span></code> matrices in internal matrix cache. Pointer returned can be modifed until <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> is called. </p>
<dd><p>Reserve <code class="docutils literal"><span class="pre">_num</span></code> matrices in internal matrix cache. Pointer returned can be modifed until <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span class="std std-ref"><span class="pre">bgfx::frame</span></span></a></code> is called. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>index into matrix cache.</dd>
@@ -3064,7 +3067,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Texture access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
</li>
</ul>
</dd>
@@ -3091,7 +3094,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Texture access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
</li>
</ul>
</dd>
@@ -3348,7 +3351,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="class">
<dt id="_CPPv2N4bgfx6MemoryE">
<span id="bgfx::Memory"></span><span class="target" id="bgfxstructbgfx_1_1_memory"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Memory</code><a class="headerlink" href="#_CPPv2N4bgfx6MemoryE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_memory"><span>Memory</span></a> obtained by calling <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code>, <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1abef77615b85f71391e7eda16f24dc5b7"><span><span class="pre">bgfx::copy</span></span></a></code>, or <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span><span class="pre">bgfx::makeRef</span></span></a></code>. </p>
<dd><p><a class="reference internal" href="#bgfxstructbgfx_1_1_memory"><span class="std std-ref">Memory</span></a> obtained by calling <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span class="std std-ref"><span class="pre">bgfx::alloc</span></span></a></code>, <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1abef77615b85f71391e7eda16f24dc5b7"><span class="std std-ref"><span class="pre">bgfx::copy</span></span></a></code>, or <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span class="std std-ref"><span class="pre">bgfx::makeRef</span></span></a></code>. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_memory_t</span></code>. </dd>
@@ -3381,7 +3384,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx7makeRefEPKv8uint32_t9ReleaseFnPv">
<span id="bgfx::makeRef__voidCP.uint32_t.ReleaseFn.voidP"></span><span class="target" id="bgfxnamespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<code class="descclassname">bgfx::</code><code class="descname">makeRef</code><span class="sig-paren">(</span><em class="property">const</em> void *<em>_data</em>, uint32_t <em>_size</em>, ReleaseFn <em>_releaseFn</em> = NULL, void *<em>_userData</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7makeRefEPKv8uint32_t9ReleaseFnPv" title="Permalink to this definition"></a></dt>
<dd><p>Make reference to data to pass to bgfx. Unlike <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code> this call doesn&#8217;t allocate memory for data. It just copies pointer to data. You can pass <code class="docutils literal"><span class="pre">ReleaseFn</span></code> function pointer to release this memory after it&#8217;s consumed, or you must make sure data is available for at least 2 <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> calls. <code class="docutils literal"><span class="pre">ReleaseFn</span></code> function must be able to be called from any thread. </p>
<dd><p>Make reference to data to pass to bgfx. Unlike <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span class="std std-ref"><span class="pre">bgfx::alloc</span></span></a></code> this call doesn&#8217;t allocate memory for data. It just copies pointer to data. You can pass <code class="docutils literal"><span class="pre">ReleaseFn</span></code> function pointer to release this memory after it&#8217;s consumed, or you must make sure data is available for at least 2 <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span class="std std-ref"><span class="pre">bgfx::frame</span></span></a></code> calls. <code class="docutils literal"><span class="pre">ReleaseFn</span></code> function must be able to be called from any thread. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent are <code class="docutils literal"><span class="pre">bgfx_make_ref</span></code>, <code class="docutils literal"><span class="pre">bgfx_make_ref_release</span></code>. </dd>
@@ -3525,7 +3528,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_name</span></code> - <p>Uniform name in shader. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_type</span></code> - <p>Type of uniform (See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_uniform_type"><span><span class="pre">bgfx::UniformType</span></span></a></code>). </p>
<li><code class="first docutils literal"><span class="pre">_type</span></code> - <p>Type of uniform (See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_uniform_type"><span class="std std-ref"><span class="pre">bgfx::UniformType</span></span></a></code>). </p>
</li>
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of elements in array.</p>
</li>
@@ -3719,7 +3722,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx10VertexDecl5beginEN12RendererType4EnumE">
<span id="bgfx::VertexDecl::begin__RendererType::Enum"></span><span class="target" id="bgfxstructbgfx_1_1_vertex_decl_1ab5794ea5c4dab7dfb20f0e125b64733d"></span><a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<code class="descname">begin</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx12RendererTypeE" title="bgfx::RendererType">RendererType</a>::<a class="reference internal" href="#_CPPv2N4bgfx12RendererType4EnumE" title="bgfx::RendererType::Enum">Enum</a> <em>_renderer</em> = RendererType::Noop<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl5beginEN12RendererType4EnumE" title="Permalink to this definition"></a></dt>
<dd><p>Start <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span>VertexDecl</span></a>. </p>
<dd><p>Start <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span class="std std-ref">VertexDecl</span></a>. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_begin</span></code>. </dd>
@@ -3730,7 +3733,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx10VertexDecl3endEv">
<span id="bgfx::VertexDecl::end"></span><span class="target" id="bgfxstructbgfx_1_1_vertex_decl_1a8f2871fedb1d0e9bfa586f51d071848d"></span>void <code class="descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl3endEv" title="Permalink to this definition"></a></dt>
<dd><p>End <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span>VertexDecl</span></a>. </p>
<dd><p>End <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span class="std std-ref">VertexDecl</span></a>. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_end</span></code>. </dd>
@@ -3741,7 +3744,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx10VertexDecl3addEN6Attrib4EnumE7uint8_tN10AttribType4EnumEbb">
<span id="bgfx::VertexDecl::add__Attrib::Enum.uint8_t.AttribType::Enum.b.b"></span><span class="target" id="bgfxstructbgfx_1_1_vertex_decl_1a4a640620e8cda3742e465ba9109de72f"></span><a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<code class="descname">add</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attrib</em>, uint8_t <em>_num</em>, AttribType::Enum <em>_type</em>, bool <em>_normalized</em> = false, bool <em>_asInt</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl3addEN6Attrib4EnumE7uint8_tN10AttribType4EnumEbb" title="Permalink to this definition"></a></dt>
<dd><p>Add attribute to <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span>VertexDecl</span></a>. </p>
<dd><p>Add attribute to <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span class="std std-ref">VertexDecl</span></a>. </p>
<p><dl class="docutils">
<dt><strong>Remark</strong></dt>
<dd>Must be called between begin/end.</dd>
@@ -3749,7 +3752,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_add</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_attrib</span></code> - <p>Attribute semantics. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_attrib"><span><span class="pre">bgfx::Attrib</span></span></a></code> </p>
<li><code class="first docutils literal"><span class="pre">_attrib</span></code> - <p>Attribute semantics. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_attrib"><span class="std std-ref"><span class="pre">bgfx::Attrib</span></span></a></code> </p>
</li>
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of elements 1, 2, 3 or 4. </p>
</li>
@@ -3790,7 +3793,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx10VertexDecl3hasEN6Attrib4EnumE">
<span id="bgfx::VertexDecl::has__Attrib::Enum"></span><span class="target" id="bgfxstructbgfx_1_1_vertex_decl_1a49f2052830fd5d4676b7f3c23190f436"></span>bool <code class="descname">has</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attrib</em><span class="sig-paren">)</span> const<a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl3hasEN6Attrib4EnumE" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span>VertexDecl</span></a> contains attribute. </p>
<dd><p>Returns true if <a class="reference internal" href="#bgfxstructbgfx_1_1_vertex_decl"><span class="std std-ref">VertexDecl</span></a> contains attribute. </p>
</dd></dl>
<dl class="function">
@@ -4250,21 +4253,21 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dt id="_CPPv2N4bgfx13TextureFormatE">
<span id="bgfx::TextureFormat"></span><span class="target" id="bgfxstructbgfx_1_1_texture_format"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">TextureFormat</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormatE" title="Permalink to this definition"></a></dt>
<dd><p>Texture format enum. </p>
<p>Notation: <div class="highlight-python"><div class="highlight"><pre> RGBA16S
^ ^ ^
| | +-- [ ]Unorm
| | [F]loat
| | [S]norm
| | [I]nt
| | [U]int
| +---- Number of bits per component
+-------- Components
<p>Notation: <div class="highlight-default"><div class="highlight"><pre><span></span> <span class="n">RGBA16S</span>
<span class="o">^</span> <span class="o">^</span> <span class="o">^</span>
<span class="o">|</span> <span class="o">|</span> <span class="o">+--</span> <span class="p">[</span> <span class="p">]</span><span class="n">Unorm</span>
<span class="o">|</span> <span class="o">|</span> <span class="p">[</span><span class="n">F</span><span class="p">]</span><span class="n">loat</span>
<span class="o">|</span> <span class="o">|</span> <span class="p">[</span><span class="n">S</span><span class="p">]</span><span class="n">norm</span>
<span class="o">|</span> <span class="o">|</span> <span class="p">[</span><span class="n">I</span><span class="p">]</span><span class="n">nt</span>
<span class="o">|</span> <span class="o">|</span> <span class="p">[</span><span class="n">U</span><span class="p">]</span><span class="nb">int</span>
<span class="o">|</span> <span class="o">+----</span> <span class="n">Number</span> <span class="n">of</span> <span class="n">bits</span> <span class="n">per</span> <span class="n">component</span>
<span class="o">+--------</span> <span class="n">Components</span>
</pre></div>
</div>
</p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>Availability depends on <a class="reference internal" href="#bgfxstructbgfx_1_1_caps"><span>Caps</span></a> (see: formats).</dd>
<dd>Availability depends on <a class="reference internal" href="#bgfxstructbgfx_1_1_caps"><span class="std std-ref">Caps</span></a> (see: formats).</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_texture_format_t</span></code>. </dd>
</dl>
@@ -4706,7 +4709,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_numLayers</span></code> - <p>Number of layers in texture array. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
</li>
</ul>
</dd>
@@ -4760,7 +4763,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_numLayers</span></code> - <p>Number of layers in texture array. Must be 1 if caps <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_2D_ARRAY</span></code> flag is not set. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
@@ -4791,7 +4794,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_numLayers</span></code> - <p>Number of layers in texture array. Must be 1 if caps <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_2D_ARRAY</span></code> flag is not set. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
@@ -4855,7 +4858,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_hasMips</span></code> - <p>Indicates that texture contains full mip-map chain. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
@@ -4919,7 +4922,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_numLayers</span></code> - <p>Number of layers in texture array. Must be 1 if caps <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_CUBE_ARRAY</span></code> flag is not set. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
@@ -4948,22 +4951,22 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_layer</span></code> - <p>Layers in texture array. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_side</span></code> - <p>Cubemap side <code class="docutils literal"><span class="pre">BGFX_CUBE_MAP_&lt;POSITIVE</span> <span class="pre">or</span> <span class="pre">NEGATIVE&gt;_&lt;X,</span> <span class="pre">Y</span> <span class="pre">or</span> <span class="pre">Z&gt;</span></code>, where 0 is +X, 1 is -X, 2 is +Y, 3 is -Y, 4 is +Z, and 5 is -Z. <div class="highlight-python"><div class="highlight"><pre> +----------+
|-z 2|
| ^ +y |
| | |
| +----&gt;+x |
+----------+----------+----------+----------+
|+y 1|+y 4|+y 0|+y 5|
| ^ -x | ^ +z | ^ +x | ^ -z |
| | | | | | | | |
| +----&gt;+z | +----&gt;+x | +----&gt;-z | +----&gt;-x |
+----------+----------+----------+----------+
|+z 3|
| ^ -y |
| | |
| +----&gt;+x |
+----------+
<li><code class="first docutils literal"><span class="pre">_side</span></code> - <p>Cubemap side <code class="docutils literal"><span class="pre">BGFX_CUBE_MAP_&lt;POSITIVE</span> <span class="pre">or</span> <span class="pre">NEGATIVE&gt;_&lt;X,</span> <span class="pre">Y</span> <span class="pre">or</span> <span class="pre">Z&gt;</span></code>, where 0 is +X, 1 is -X, 2 is +Y, 3 is -Y, 4 is +Z, and 5 is -Z. <div class="highlight-default"><div class="highlight"><pre><span></span> <span class="o">+----------+</span>
<span class="o">|-</span><span class="n">z</span> <span class="mi">2</span><span class="o">|</span>
<span class="o">|</span> <span class="o">^</span> <span class="o">+</span><span class="n">y</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">+----&gt;+</span><span class="n">x</span> <span class="o">|</span>
<span class="o">+----------+----------+----------+----------+</span>
<span class="o">|+</span><span class="n">y</span> <span class="mi">1</span><span class="o">|+</span><span class="n">y</span> <span class="mi">4</span><span class="o">|+</span><span class="n">y</span> <span class="mi">0</span><span class="o">|+</span><span class="n">y</span> <span class="mi">5</span><span class="o">|</span>
<span class="o">|</span> <span class="o">^</span> <span class="o">-</span><span class="n">x</span> <span class="o">|</span> <span class="o">^</span> <span class="o">+</span><span class="n">z</span> <span class="o">|</span> <span class="o">^</span> <span class="o">+</span><span class="n">x</span> <span class="o">|</span> <span class="o">^</span> <span class="o">-</span><span class="n">z</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">+----&gt;+</span><span class="n">z</span> <span class="o">|</span> <span class="o">+----&gt;+</span><span class="n">x</span> <span class="o">|</span> <span class="o">+----&gt;-</span><span class="n">z</span> <span class="o">|</span> <span class="o">+----&gt;-</span><span class="n">x</span> <span class="o">|</span>
<span class="o">+----------+----------+----------+----------+</span>
<span class="o">|+</span><span class="n">z</span> <span class="mi">3</span><span class="o">|</span>
<span class="o">|</span> <span class="o">^</span> <span class="o">-</span><span class="n">y</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
<span class="o">|</span> <span class="o">+----&gt;+</span><span class="n">x</span> <span class="o">|</span>
<span class="o">+----------+</span>
</pre></div>
</div>
</p>
@@ -4994,7 +4997,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><p>Read back texture content. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Frame number when the result will be available. See: <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code>.</dd>
<dd>Frame number when the result will be available. See: <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span class="std std-ref"><span class="pre">bgfx::frame</span></span></a></code>.</dd>
<dt><strong>Attention</strong></dt>
<dd>Texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_READ_BACK</span></code> flag. </dd>
<dt><strong>Attention</strong></dt>
@@ -5021,7 +5024,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><p>Read back texture content. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Frame number when the result will be available. See: <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code>.</dd>
<dd>Frame number when the result will be available. See: <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span class="std std-ref"><span class="pre">bgfx::frame</span></span></a></code>.</dd>
<dt><strong>Attention</strong></dt>
<dd>Texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_READ_BACK</span></code> flag. </dd>
<dt><strong>Attention</strong></dt>
@@ -5077,7 +5080,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</li>
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Texture height. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_textureFlags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
@@ -5104,7 +5107,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_ratio</span></code> - <p>Frame buffer size in respect to back-buffer size. See: <code class="docutils literal"><span class="pre">BackbufferRatio::Enum</span></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span class="std std-ref"><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_textureFlags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
@@ -5213,7 +5216,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of texture attachments. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_attachment</span></code> - <p><a class="reference internal" href="#bgfxstructbgfx_1_1_attachment"><span>Attachment</span></a> texture info. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_attachment"><span><span class="pre">Attachment</span></span></a></code>. </p>
<li><code class="first docutils literal"><span class="pre">_attachment</span></code> - <p><a class="reference internal" href="#bgfxstructbgfx_1_1_attachment"><span class="std std-ref">Attachment</span></a> texture info. See: <code class="docutils literal"><a class="reference internal" href="#bgfxstructbgfx_1_1_attachment"><span class="std std-ref"><span class="pre">Attachment</span></span></a></code>. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_destroyTextures</span></code> - <p>If true, textures will be destroyed when frame buffer is destroyed.</p>
</li>

View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
<link rel="next" title="Examples" href="examples.html"/>
<link rel="prev" title="Overview" href="overview.html"/>
@@ -83,7 +86,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Building</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Building</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getting-source">Getting Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="#quick-start">Quick Start</a></li>
@@ -162,8 +165,8 @@
</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-python"><div class="highlight"><pre>git clone git://github.com/bkaradzic/bx.git
git clone git://github.com/bkaradzic/bgfx.git
<div class="highlight-default"><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">bgfx</span><span class="o">.</span><span class="n">git</span>
</pre></div>
</div>
</div>
@@ -171,15 +174,15 @@ git clone git://github.com/bkaradzic/bgfx.git
<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>
<div class="highlight-python"><div class="highlight"><pre>cd bgfx
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">bgfx</span>
</pre></div>
</div>
<p>Generate Visual Studio 2015 project files:</p>
<div class="highlight-python"><div class="highlight"><pre>..\bx\tools\bin\windows\genie --with-examples vs2015
<div class="highlight-default"><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">examples</span> <span class="n">vs2015</span>
</pre></div>
</div>
<p>Open bgfx solution in Visual Studio 2015:</p>
<div class="highlight-python"><div class="highlight"><pre>start .build\projects\vs2015\bgfx.sln
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">start</span> <span class="o">.</span><span class="n">build</span>\<span class="n">projects</span>\<span class="n">vs2015</span>\<span class="n">bgfx</span><span class="o">.</span><span class="n">sln</span>
</pre></div>
</div>
<div class="admonition note">
@@ -198,10 +201,10 @@ git clone git://github.com/bkaradzic/bgfx.git
</ul>
</div></blockquote>
<p>Set following enironment variables:</p>
<div class="highlight-python"><div class="highlight"><pre>setx ANDROID_NDK_ROOT &lt;path to AndroidNDK directory&gt;
setx ANDROID_NDK_ARM &lt;path to AndroidNDK directory&gt;\toolchains\arm-linux-androideabi-4.7\prebuilt\windows-x86_64
setx ANDROID_NDK_MIPS &lt;path to AndroidNDK directory&gt;\toolchains\mipsel-linux-android-4.7\prebuilt\windows-x86_64
setx ANDROID_NDK_X86 &lt;path to AndroidNDK directory&gt;\toolchains\x86-4.7\prebuilt\windows-x86_64
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">setx</span> <span class="n">ANDROID_NDK_ROOT</span> <span class="o">&lt;</span><span class="n">path</span> <span class="n">to</span> <span class="n">AndroidNDK</span> <span class="n">directory</span><span class="o">&gt;</span>
<span class="n">setx</span> <span class="n">ANDROID_NDK_ARM</span> <span class="o">&lt;</span><span class="n">path</span> <span class="n">to</span> <span class="n">AndroidNDK</span> <span class="n">directory</span><span class="o">&gt;</span>\<span class="n">toolchains</span>\<span class="n">arm</span><span class="o">-</span><span class="n">linux</span><span class="o">-</span><span class="n">androideabi</span><span class="o">-</span><span class="mf">4.7</span>\<span class="n">prebuilt</span>\<span class="n">windows</span><span class="o">-</span><span class="n">x86_64</span>
<span class="n">setx</span> <span class="n">ANDROID_NDK_MIPS</span> <span class="o">&lt;</span><span class="n">path</span> <span class="n">to</span> <span class="n">AndroidNDK</span> <span class="n">directory</span><span class="o">&gt;</span>\<span class="n">toolchains</span>\<span class="n">mipsel</span><span class="o">-</span><span class="n">linux</span><span class="o">-</span><span class="n">android</span><span class="o">-</span><span class="mf">4.7</span>\<span class="n">prebuilt</span>\<span class="n">windows</span><span class="o">-</span><span class="n">x86_64</span>
<span class="n">setx</span> <span class="n">ANDROID_NDK_X86</span> <span class="o">&lt;</span><span class="n">path</span> <span class="n">to</span> <span class="n">AndroidNDK</span> <span class="n">directory</span><span class="o">&gt;</span>\<span class="n">toolchains</span>\<span class="n">x86</span><span class="o">-</span><span class="mf">4.7</span>\<span class="n">prebuilt</span>\<span class="n">windows</span><span class="o">-</span><span class="n">x86_64</span>
</pre></div>
</div>
<p>To deploy on Android you can use bgfx android activity:</p>
@@ -213,7 +216,7 @@ setx ANDROID_NDK_X86 &lt;path to AndroidNDK directory&gt;\toolchains\x86-4.7\pre
</div>
<div class="section" id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline"></a></h3>
<div class="highlight-python"><div class="highlight"><pre>sudo apt-get install libgl1-mesa-dev x11proto-core-dev libx11-dev
<div class="highlight-default"><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>
</div>
@@ -226,7 +229,7 @@ setx ANDROID_NDK_X86 &lt;path to AndroidNDK directory&gt;\toolchains\x86-4.7\pre
</ul>
</div></blockquote>
<p>Set following enironment variables:</p>
<div class="highlight-python"><div class="highlight"><pre>setx NACL_SDK_ROOT &lt;path to Native Client SDK directory&gt;
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">setx</span> <span class="n">NACL_SDK_ROOT</span> <span class="o">&lt;</span><span class="n">path</span> <span class="n">to</span> <span class="n">Native</span> <span class="n">Client</span> <span class="n">SDK</span> <span class="n">directory</span><span class="o">&gt;</span>
</pre></div>
</div>
</div>
@@ -254,36 +257,36 @@ to generate project files for various platform. Binaries for Linux, OSX, and Win
bx repository.</p>
<div class="section" id="general">
<h3>General<a class="headerlink" href="#general" title="Permalink to this headline"></a></h3>
<div class="highlight-python"><div class="highlight"><pre>cd bgfx
make
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">bgfx</span>
<span class="n">make</span>
</pre></div>
</div>
<p>After calling <code class="docutils literal"><span class="pre">make</span></code>, .build/projects/* directory will be generated.
All intermediate files generated by compiler will be inside .build
directory structure. Deleting .build directory at any time is safe.</p>
<div class="highlight-python"><div class="highlight"><pre>make &lt;configuration&gt;
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="o">&lt;</span><span class="n">configuration</span><span class="o">&gt;</span>
</pre></div>
</div>
<p>Configuration is <code class="docutils literal"><span class="pre">&lt;platform&gt;-&lt;debug/release&gt;[32/64]</span></code>. For example:</p>
<div class="highlight-python"><div class="highlight"><pre>linux-release32, nacl-debug64, nacl-arm-debug, pnacl-release,
android-release, etc.
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">linux</span><span class="o">-</span><span class="n">release32</span><span class="p">,</span> <span class="n">nacl</span><span class="o">-</span><span class="n">debug64</span><span class="p">,</span> <span class="n">nacl</span><span class="o">-</span><span class="n">arm</span><span class="o">-</span><span class="n">debug</span><span class="p">,</span> <span class="n">pnacl</span><span class="o">-</span><span class="n">release</span><span class="p">,</span>
<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>
</div>
<div class="section" id="id1">
<h3>Windows<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<p>Visual Studio 2008 command line:</p>
<div class="highlight-python"><div class="highlight"><pre>make vs2008-release64
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">vs2008</span><span class="o">-</span><span class="n">release64</span>
</pre></div>
</div>
<p>Visual Studio 2008 IDE:</p>
<div class="highlight-python"><div class="highlight"><pre><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">vs2008</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">sln</span>
<div class="highlight-default"><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">vs2008</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">sln</span>
</pre></div>
</div>
</div>
<div class="section" id="xcode">
<h3>Xcode<a class="headerlink" href="#xcode" title="Permalink to this headline"></a></h3>
<div class="highlight-python"><div class="highlight"><pre><span class="nb">open</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">xcode4</span><span class="o">-</span><span class="n">osx</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">xcworkspace</span>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">open</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">xcode4</span><span class="o">-</span><span class="n">osx</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">xcworkspace</span>
</pre></div>
</div>
<p>Due to <a class="reference external" href="https://github.com/bkaradzic/genie/blob/master/docs/scripting-reference.md#debugdirpath">inability</a>
@@ -298,13 +301,13 @@ configuration file, it has to be set manually for each example project:</p>
</div>
<div class="section" id="id2">
<h3>Linux<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="highlight-python"><div class="highlight"><pre>make linux-release64
<div class="highlight-default"><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>
</div>
<div class="section" id="winrt-windows-phone-8-1">
<h3>WinRT / Windows Phone 8.1<a class="headerlink" href="#winrt-windows-phone-8-1" title="Permalink to this headline"></a></h3>
<div class="highlight-python"><div class="highlight"><pre>../bx/tools/bin/windows/genie --vs=winphone81 vs2015
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">../</span><span class="n">bx</span><span class="o">/</span><span class="n">tools</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">windows</span><span class="o">/</span><span class="n">genie</span> <span class="o">--</span><span class="n">vs</span><span class="o">=</span><span class="n">winphone81</span> <span class="n">vs2015</span>
</pre></div>
</div>
<p>Build the resulting solution and deploy to device.</p>
@@ -326,18 +329,18 @@ instead) inside different build system.</p>
<div class="section" id="oculusvr-integration">
<h2>OculusVR Integration<a class="headerlink" href="#oculusvr-integration" title="Permalink to this headline"></a></h2>
<p>To build with OculusVR HMD support enabled you must set <code class="docutils literal"><span class="pre">OVR_DIR</span></code> enviroment variable:</p>
<div class="highlight-python"><div class="highlight"><pre>set OVR_DIR=&lt;path to OculusSDK&gt;
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">OVR_DIR</span><span class="o">=&lt;</span><span class="n">path</span> <span class="n">to</span> <span class="n">OculusSDK</span><span class="o">&gt;</span>
</pre></div>
</div>
<p>And generate project files with <code class="docutils literal"><span class="pre">--with-ovr</span></code> option:</p>
<div class="highlight-python"><div class="highlight"><pre>genie --with-ovr vs2015
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">genie</span> <span class="o">--</span><span class="k">with</span><span class="o">-</span><span class="n">ovr</span> <span class="n">vs2015</span>
</pre></div>
</div>
</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"><span class="pre">--with-tools</span></code> option:</p>
<div class="highlight-python"><div class="highlight"><pre>genie --with-tools vs2015
<div class="highlight-default"><div class="highlight"><pre><span></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">vs2015</span>
</pre></div>
</div>
</div>

View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
<link rel="next" title="API Reference" href="bgfx.html"/>
<link rel="prev" title="Building" href="build.html"/>
@@ -84,7 +87,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Examples</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#helloworld">00-helloworld</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cubes">01-cubes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#metaballs">02-metaballs</a></li>
@@ -172,7 +175,7 @@
<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-python"><div class="highlight"><pre>&lt;bgfx_path&gt;/examples/runtime $ ../../.build/&lt;config&gt;/bin/example-00-helloworldDebug
<div class="highlight-default"><div class="highlight"><pre><span></span>&lt;bgfx_path&gt;/examples/runtime $ ../../.build/&lt;config&gt;/bin/example-00-helloworldDebug
</pre></div>
</div>
<div class="section" id="helloworld">

View File

@@ -31,6 +31,9 @@
<link rel="index" title="Index"
href="#"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
@@ -911,12 +914,12 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimerFreqE">bgfx::Stats::cpuTimerFreq (C++ member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12gpuTimeBeginE">bgfx::Stats::gpuTimeBegin (C++ member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats10gpuTimeEndE">bgfx::Stats::gpuTimeEnd (C++ member)</a>
</dt>

View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="#"/>
<link rel="next" title="Overview" href="overview.html"/>

View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
<link rel="prev" title="Tools" href="tools.html"/>
@@ -86,7 +89,7 @@
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools.html">Tools</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">License</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">License</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#license-bsd-2-clause">License (BSD 2-clause)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#rd-party-libraries">3rd Party Libraries</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#blendish-mit">Blendish (MIT)</a></li>
@@ -151,7 +154,7 @@
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
<div class="section" id="license-bsd-2-clause">
<h2><a class="reference external" href="https://github.com/bkaradzic/bgfx/blob/master/LICENSE">License (BSD 2-clause)</a><a class="headerlink" href="#license-bsd-2-clause" title="Permalink to this headline"></a></h2>
<div class="highlight-python"><div class="highlight"><pre>Copyright 2010-2016 Branimir Karadzic. All rights reserved.
<div class="highlight-default"><div class="highlight"><pre><span></span>Copyright 2010-2016 Branimir Karadzic. All rights reserved.
https://github.com/bkaradzic/bgfx

Binary file not shown.

View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
<link rel="next" title="Building" href="build.html"/>
<link rel="prev" title="Documentation" href="index.html"/>
@@ -82,7 +85,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">Overview</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-is-it">What is it?</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#supported-rendering-backends">Supported rendering backends</a></li>
<li class="toctree-l3"><a class="reference internal" href="#supported-hmd">Supported HMD</a></li>
@@ -457,20 +460,20 @@ windowing libraries. The main requirement is that windowing library
provides access to native window handle that&#8217;s used to create Direct3D
device or OpenGL context.</p>
<p>Using bgfx with SDL example:</p>
<div class="highlight-python"><div class="highlight"><pre>#include &lt;SDL.h&gt;
#include &lt;bgfx/bgfxplatform.h&gt; // it must be included after SDL to enable SDL
// integration code path.
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1">#include &lt;SDL.h&gt;</span>
<span class="c1">#include &lt;bgfx/bgfxplatform.h&gt; // it must be included after SDL to enable SDL</span>
<span class="o">//</span> <span class="n">integration</span> <span class="n">code</span> <span class="n">path</span><span class="o">.</span>
#include &lt;bgfx/bgfx.h&gt;
...
<span class="c1">#include &lt;bgfx/bgfx.h&gt;</span>
<span class="o">...</span>
int main(...
{
SDL_window* window = SDL_CreateWindow(...
bgfx::sdlSetWindow(window);
<span class="nb">int</span> <span class="n">main</span><span class="p">(</span><span class="o">...</span>
<span class="p">{</span>
<span class="n">SDL_window</span><span class="o">*</span> <span class="n">window</span> <span class="o">=</span> <span class="n">SDL_CreateWindow</span><span class="p">(</span><span class="o">...</span>
<span class="n">bgfx</span><span class="p">::</span><span class="n">sdlSetWindow</span><span class="p">(</span><span class="n">window</span><span class="p">);</span>
...
bgfx::init();
<span class="o">...</span>
<span class="n">bgfx</span><span class="p">::</span><span class="n">init</span><span class="p">();</span>
</pre></div>
</div>
<div class="admonition note">

View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="#"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>

File diff suppressed because one or more lines are too long

View File

@@ -30,6 +30,9 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
<link rel="next" title="License" href="license.html"/>
<link rel="prev" title="API Reference" href="bgfx.html"/>
@@ -86,7 +89,7 @@
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Tools</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#shader-compiler-shaderc">Shader Compiler (shaderc)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#building-shaders">Building shaders</a></li>