mirrors/bgfx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić 2016-11-02 00:15:07 -07:00
parent b3d973d700
commit d76ca54044
5 changed files with 76 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
bgfx.html
View File

@ -3381,7 +3381,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 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><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>
<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>
@ -3535,6 +3535,25 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14getUniformInfoE13UniformHandleR11UniformInfo">
<span id="bgfx::getUniformInfo__UniformHandle.UniformInfoR"></span><span class="target" id="bgfxnamespacebgfx_1aa57213d4971e397983c217ee97326e37"></span>void <code class="descclassname">bgfx::</code><code class="descname">getUniformInfo</code><span class="sig-paren">(</span>UniformHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx11UniformInfoE" title="bgfx::UniformInfo">UniformInfo</a> &amp;<em>_info</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14getUniformInfoE13UniformHandleR11UniformInfo" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve uniform info. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_uniform_info</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Handle to uniform object. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_info</span></code> - <p>Uniform info.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14destroyUniformE13UniformHandle">
<span id="bgfx::destroyUniform__UniformHandle"></span><span class="target" id="bgfxnamespacebgfx_1a55c0d21cc00b4d7f8a05879e2114d37b"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyUniform</code><span class="sig-paren">(</span>UniformHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14destroyUniformE13UniformHandle" title="Permalink to this definition"></a></dt>
@ -3603,6 +3622,38 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</div>
</dd></dl>
<dl class="class">
<dt id="_CPPv2N4bgfx11UniformInfoE">
<span id="bgfx::UniformInfo"></span><span class="target" id="bgfxstructbgfx_1_1_uniform_info"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">UniformInfo</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformInfoE" title="Permalink to this definition"></a></dt>
<dd><p>Uniform info. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_uniform_info_t</span></code>. </dd>
</dl>
</p>
<div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="member">
<dt id="_CPPv2N4bgfx11UniformInfo4nameE">
<span id="bgfx::UniformInfo::name__cA"></span><span class="target" id="bgfxstructbgfx_1_1_uniform_info_1a31297c5b74a406c6a3aeb992524076ad"></span>char <code class="descname">name</code>[256]<a class="headerlink" href="#_CPPv2N4bgfx11UniformInfo4nameE" title="Permalink to this definition"></a></dt>
<dd><p>Uniform name. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx11UniformInfo4typeE">
<span id="bgfx::UniformInfo::type__UniformType::Enum"></span><span class="target" id="bgfxstructbgfx_1_1_uniform_info_1a0f485153be537102d0350111bb58efbd"></span><a class="reference internal" href="#_CPPv2N4bgfx11UniformTypeE" title="bgfx::UniformType">UniformType</a>::<a class="reference internal" href="#_CPPv2N4bgfx11UniformType4EnumE" title="bgfx::UniformType::Enum">Enum</a> <code class="descname">type</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformInfo4typeE" title="Permalink to this definition"></a></dt>
<dd><p>Uniform type. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx11UniformInfo3numE">
<span id="bgfx::UniformInfo::num__uint16_t"></span><span class="target" id="bgfxstructbgfx_1_1_uniform_info_1acab624b397b0c788e6bd011f92823e88"></span>uint16_t <code class="descname">num</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformInfo3numE" title="Permalink to this definition"></a></dt>
<dd><p>Number of elements in array. </p>
</dd></dl>
</div>
</dd></dl>
</div>
<div class="section" id="vertex-buffers">
<h3>Vertex Buffers<a class="headerlink" href="#vertex-buffers" title="Permalink to this headline"></a></h3>

24
genindex.html
View File

@ -600,6 +600,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx14getUniformInfoE13UniformHandleR11UniformInfo">bgfx::getUniformInfo (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx3HMDE">bgfx::HMD (C++ class)</a>
</dt>
@ -903,8 +907,6 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats10cpuTimeEndE">bgfx::Stats::cpuTimeEnd (C++ member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimerFreqE">bgfx::Stats::cpuTimerFreq (C++ member)</a>
</dt>
@ -913,6 +915,8 @@
<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>
@ -1350,6 +1354,22 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx11UniformInfoE">bgfx::UniformInfo (C++ class)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx11UniformInfo4nameE">bgfx::UniformInfo::name (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx11UniformInfo3numE">bgfx::UniformInfo::num (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx11UniformInfo4typeE">bgfx::UniformInfo::type (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx11UniformTypeE">bgfx::UniformType (C++ class)</a>
</dt>

BIN
objects.inv
View File

Binary file not shown.

2
overview.html
View File

@ -209,7 +209,7 @@ licensed under permissive BSD-2 clause open source license.</p>
<ul class="simple">
<li>Clang 3.3 and above</li>
<li>GCC 4.6 and above</li>
<li>vs2008 and above</li>
<li>vs2012 and above</li>
</ul>
</div>
<div class="section" id="supported-languages">

2
searchindex.js
View File

File diff suppressed because one or more lines are too long