mirrors
/
bgfx
mirror of https://github.com/bkaradzic/bgfx
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

This commit is contained in:
Branimir Karadžić 2018-07-07 15:53:05 -07:00
parent 78c0ec2a66
commit 2c533a093f
6 changed files with 54 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
bgfx.html
View File

@ -816,6 +816,12 @@
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_dbg_text_clear</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_attr</span></code>: Background color. </li>
<li><code class="docutils literal"><span class="pre">_small</span></code>: Default or 8x8 font.</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
@ -1234,6 +1240,18 @@
<dd><p>Maximum number of encoder threads. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits15transientVbSizeE">
<span id="bgfx::Caps::Limits::transientVbSize__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a7612ba54b79f902dcfb278bab1027cdc"></span>uint32_t <code class="descname">transientVbSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits15transientVbSizeE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum transient vertex buffer size. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits15transientIbSizeE">
<span id="bgfx::Caps::Limits::transientIbSize__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a4e604a96366723416a4b19dc4b2d93e9"></span>uint32_t <code class="descname">transientIbSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits15transientIbSizeE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum transient index buffer size. </p>
</dd></dl>
</div>
</dd></dl>
@ -3456,7 +3474,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>doxygenfunction: Unable to resolve multiple matches for function &#8220;bgfx::setName&#8221; with arguments (ShaderHandle, const char *) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
<p>doxygenfunction: Unable to resolve multiple matches for function &#8220;bgfx::setName&#8221; with arguments (ShaderHandle, const char *, int32_t _len) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
Potential matches:
</p>
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::setName(ShaderHandle, const char *, int32_t)
@ -3466,7 +3484,7 @@ Potential matches:
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>doxygenfunction: Unable to resolve multiple matches for function &#8220;bgfx::setName&#8221; with arguments (TextureHandle, const char *) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
<p>doxygenfunction: Unable to resolve multiple matches for function &#8220;bgfx::setName&#8221; with arguments (TextureHandle, const char *, int32_t _len) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
Potential matches:
</p>
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::setName(ShaderHandle, const char *, int32_t)
@ -4384,6 +4402,11 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_size</span></code>: Size to allocate.</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
@ -4414,6 +4437,12 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd>Data passed must be available for at least 2 <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><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>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_data</span></code>: Pointer to data. </li>
<li><code class="docutils literal"><span class="pre">_size</span></code>: Size of data.</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>

22
build.html
View File

@ -98,7 +98,7 @@
<li class="toctree-l3"><a class="reference internal" href="#id1">Windows</a></li>
<li class="toctree-l3"><a class="reference internal" href="#xcode">Xcode</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">Linux</a></li>
<li class="toctree-l3"><a class="reference internal" href="#winrt-windows-phone-8-1">WinRT / Windows Phone 8.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#winrt-uwp">WinRT / UWP</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#amalgamated-build">Amalgamated Build</a></li>
@ -176,12 +176,12 @@ git clone git://github.com/bkaradzic/bgfx.git
<div class="highlight-python"><div class="highlight"><pre>cd bgfx
</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
<p>Generate Visual Studio 2017 project files:</p>
<div class="highlight-python"><div class="highlight"><pre>..\bx\tools\bin\windows\genie --with-examples vs2017
</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
<p>Open bgfx solution in Visual Studio 2017:</p>
<div class="highlight-python"><div class="highlight"><pre>start .build\projects\vs2017\bgfx.sln
</pre></div>
</div>
<div class="admonition note">
@ -279,7 +279,7 @@ cd examples/runtime
</pre></div>
</div>
<p>Xcode IDE:</p>
<div class="highlight-python"><div class="highlight"><pre>genie --with-combined-examples --xcode=osx xcode9
<div class="highlight-python"><div class="highlight"><pre>../bx/tools/bin/darwin/genie --with-combined-examples --xcode=osx xcode9
open .build/projects/xcode9-osx/bgfx.xcworkspace
</pre></div>
</div>
@ -299,9 +299,9 @@ configuration file, it has to be set manually for each example project:</p>
</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="section" id="winrt-uwp">
<h3>WinRT / UWP<a class="headerlink" href="#winrt-uwp" title="Permalink to this headline"></a></h3>
<div class="highlight-python"><div class="highlight"><pre>..\bx\tools\bin\windows\genie --vs=winstore100 vs2017
</pre></div>
</div>
<p>Build the resulting solution and deploy to device.</p>
@ -327,14 +327,14 @@ instead) inside different build system.</p>
</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-python"><div class="highlight"><pre>..\bx\tools\bin\windows\genie --with-ovr vs2017
</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-python"><div class="highlight"><pre>..\bx\tools\bin\windows\genie --with-tools vs2017
</pre></div>
</div>
</div>

12
genindex.html
View File

@ -497,6 +497,14 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits15transientIbSizeE">bgfx::Caps::Limits::transientIbSize (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits15transientVbSizeE">bgfx::Caps::Limits::transientVbSize (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps7numGPUsE">bgfx::Caps::numGPUs (C++ member)</a>
</dt>
@ -1116,12 +1124,12 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimeBeginE">bgfx::Stats::cpuTimeBegin (C++ member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<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#_CPPv2N4bgfx5Stats12cpuTimeFrameE">bgfx::Stats::cpuTimeFrame (C++ member)</a>
</dt>

2
index.html
View File

@ -185,7 +185,7 @@ licensed under permissive BSD-2 clause open source license.</p>
<li class="toctree-l3"><a class="reference internal" href="build.html#id1">Windows</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html#xcode">Xcode</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html#id2">Linux</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html#winrt-windows-phone-8-1">WinRT / Windows Phone 8.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html#winrt-uwp">WinRT / UWP</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="build.html#amalgamated-build">Amalgamated Build</a></li>

BIN
objects.inv
View File

Binary file not shown.

2
searchindex.js
View File

File diff suppressed because one or more lines are too long