Updated docs.
This commit is contained in:
Branimir Karadžić
parent
9417029700
commit
d9ca505ad2
34
bgfx.html
34
bgfx.html
@ -1277,39 +1277,45 @@
|
||||
</p>
|
||||
<div class="breathe-sectiondef container">
|
||||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats12cpuTimeFrameE">
|
||||
<span id="bgfx::Stats::cpuTimeFrame__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a8d65ca9e1dcc56a9d2ac505abfa678f9"></span>int64_t <code class="descname">cpuTimeFrame</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimeFrameE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>CPU time between two <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. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats12cpuTimeBeginE">
|
||||
<span id="bgfx::Stats::cpuTimeBegin__uint64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a3ca21838fdd43b962a6b22869e6fe97b"></span>uint64_t <code class="descname">cpuTimeBegin</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimeBeginE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>CPU frame begin time. </p>
|
||||
<span id="bgfx::Stats::cpuTimeBegin__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1acefc6f6fb9aca5e607a46119162d8a81"></span>int64_t <code class="descname">cpuTimeBegin</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimeBeginE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Render thread CPU submit begin time. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats10cpuTimeEndE">
|
||||
<span id="bgfx::Stats::cpuTimeEnd__uint64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a37da0b114f76a989d098b65a80072e48"></span>uint64_t <code class="descname">cpuTimeEnd</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10cpuTimeEndE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>CPU frame end time. </p>
|
||||
<span id="bgfx::Stats::cpuTimeEnd__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1ab5275e59d5ebe68200fd3b63ed59cbd2"></span>int64_t <code class="descname">cpuTimeEnd</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10cpuTimeEndE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Render thread CPU submit end time. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats12cpuTimerFreqE">
|
||||
<span id="bgfx::Stats::cpuTimerFreq__uint64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a0e62b1361829901d9f79f62ba557c7bd"></span>uint64_t <code class="descname">cpuTimerFreq</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimerFreqE" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Stats::cpuTimerFreq__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a0ca3b1b43511aa10c9f2ff0f30680ef0"></span>int64_t <code class="descname">cpuTimerFreq</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimerFreqE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>CPU timer frequency. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats12gpuTimeBeginE">
|
||||
<span id="bgfx::Stats::gpuTimeBegin__uint64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1aa995ea357564126351d9665b3664f2c5"></span>uint64_t <code class="descname">gpuTimeBegin</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuTimeBeginE" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Stats::gpuTimeBegin__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a8748ff45b30e72fc6103ceb80b5642b0"></span>int64_t <code class="descname">gpuTimeBegin</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuTimeBeginE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>GPU frame begin time. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats10gpuTimeEndE">
|
||||
<span id="bgfx::Stats::gpuTimeEnd__uint64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a620911049a1ce9e8edf87ba47954df4d"></span>uint64_t <code class="descname">gpuTimeEnd</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10gpuTimeEndE" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Stats::gpuTimeEnd__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a0588c269d4eefdef1dbe31d3be4c211b"></span>int64_t <code class="descname">gpuTimeEnd</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10gpuTimeEndE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>GPU frame end time. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats12gpuTimerFreqE">
|
||||
<span id="bgfx::Stats::gpuTimerFreq__uint64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a832843b2601fa8c81ba6794e7780b563"></span>uint64_t <code class="descname">gpuTimerFreq</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuTimerFreqE" title="Permalink to this definition">¶</a></dt>
|
||||
<span id="bgfx::Stats::gpuTimerFreq__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a98cdb3d5fd558bb7482e01b28ae5751c"></span>int64_t <code class="descname">gpuTimerFreq</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuTimerFreqE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>GPU timer frequency. </p>
|
||||
</dd></dl>
|
||||
|
||||
@ -1343,6 +1349,18 @@
|
||||
<dd><p>GPU driver latency. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats12gpuMemoryMaxE">
|
||||
<span id="bgfx::Stats::gpuMemoryMax__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1afe5fd057109b00d5a4f760a034c59c8b"></span>int64_t <code class="descname">gpuMemoryMax</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuMemoryMaxE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Maximum available GPU memory. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats13gpuMemoryUsedE">
|
||||
<span id="bgfx::Stats::gpuMemoryUsed__int64_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1aa936cf20a5da4419936958f67a594bc1"></span>int64_t <code class="descname">gpuMemoryUsed</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats13gpuMemoryUsedE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Available GPU memory. </p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="member">
|
||||
<dt id="_CPPv2N4bgfx5Stats5widthE">
|
||||
<span id="bgfx::Stats::width__uint16_t"></span><span class="target" id="bgfxstructbgfx_1_1_stats_1a8a225ad7ff3fad833cd7fb783550d4f3"></span>uint16_t <code class="descname">width</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats5widthE" title="Permalink to this definition">¶</a></dt>
|
||||
|
||||
@ -127,6 +127,8 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#particles">32-particles</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#pom">33-pom</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#mvs">34-mvs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#dynamic">35-dynamic</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#sky">36-sky</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a></li>
|
||||
@ -1094,6 +1096,20 @@ off programatically.</p>
|
||||
<img alt="example-34-mvs" src="https://github.com/bkaradzic/bgfx/raw/master/examples/34-mvs/screenshot.png" />
|
||||
</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>
|
||||
<div class="figure">
|
||||
<img alt="example-35-dynamic" src="https://github.com/bkaradzic/bgfx/raw/master/examples/35-dynamic/screenshot.png" />
|
||||
</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>
|
||||
<div class="figure">
|
||||
<img alt="example-36-sky" src="https://github.com/bkaradzic/bgfx/raw/master/examples/36-sky/screenshot.png" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
@ -919,10 +919,22 @@
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimeFrameE">bgfx::Stats::cpuTimeFrame (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimerFreqE">bgfx::Stats::cpuTimerFreq (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12gpuMemoryMaxE">bgfx::Stats::gpuMemoryMax (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats13gpuMemoryUsedE">bgfx::Stats::gpuMemoryUsed (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12gpuTimeBeginE">bgfx::Stats::gpuTimeBegin (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
@ -946,6 +958,8 @@
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats10numComputeE">bgfx::Stats::numCompute (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats7numDrawE">bgfx::Stats::numDraw (C++ member)</a>
|
||||
</dt>
|
||||
@ -954,8 +968,6 @@
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats8numViewsE">bgfx::Stats::numViews (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats10textHeightE">bgfx::Stats::textHeight (C++ member)</a>
|
||||
</dt>
|
||||
|
||||
@ -239,6 +239,8 @@ licensed under permissive BSD-2 clause open source license.</p>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#particles">32-particles</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#pom">33-pom</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mvs">34-mvs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#dynamic">35-dynamic</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples.html#sky">36-sky</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">API Reference</a><ul>
|
||||
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user