Mirrors/bgfx
1
0
Fork 0
mirror of https://github.com/bkaradzic/bgfx.git synced 2026-02-18 13:03:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić
2017-07-09 23:27:22 -07:00
parent 49ed25c4ab
commit fcc31b65fa
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
bgfx.html
View File

@@ -1252,6 +1252,8 @@
<dd><p>Returns performance counters. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>Pointer returned is valid 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. </dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_stats</span></code>. </dd>
</dl>
</p>
@@ -2580,11 +2582,13 @@ 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 class="std std-ref"><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. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>index into matrix cache.</dd>
<dt><strong>Attention</strong></dt>
<dd>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. </dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_transform</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
@@ -3435,6 +3439,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</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>Data passed must be 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. </dd>
<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>
</dl>
</p>