Updated docs.

This commit is contained in:
Branimir Karadžić
2018-06-27 18:42:18 -07:00
parent 07f8f72739
commit 78c0ec2a66
5 changed files with 61 additions and 41 deletions

View File

@@ -230,6 +230,18 @@
<dd><p>Device id. If set to 0 it will select first device, or device with matching id. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Init5debugE">
<span id="bgfx::Init::debug__b"></span><span class="target" id="structbgfx_1_1_init_1a3fc874cff90fe5c279356e92a306f022"></span>bool <code class="descname">debug</code><a class="headerlink" href="#_CPPv2N4bgfx4Init5debugE" title="Permalink to this definition"></a></dt>
<dd><p>Enable device for debuging. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Init7profileE">
<span id="bgfx::Init::profile__b"></span><span class="target" id="structbgfx_1_1_init_1a5cf66d060d59a5e1e55147e3d75d32fe"></span>bool <code class="descname">profile</code><a class="headerlink" href="#_CPPv2N4bgfx4Init7profileE" title="Permalink to this definition"></a></dt>
<dd><p>Enable device for profiling. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Init10resolutionE">
<span id="bgfx::Init::resolution__Resolution"></span><span class="target" id="structbgfx_1_1_init_1a12f9e2f7f7a8514e1bd58a8aee137b1a"></span>Resolution <code class="descname">resolution</code><a class="headerlink" href="#_CPPv2N4bgfx4Init10resolutionE" title="Permalink to this definition"></a></dt>
@@ -2595,7 +2607,7 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
<dl class="class">
<dt id="_CPPv2N4bgfx7EncoderE">
<span id="bgfx::Encoder"></span><span class="target" id="structbgfx_1_1_encoder"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Encoder</code><a class="headerlink" href="#_CPPv2N4bgfx7EncoderE" title="Permalink to this definition"></a></dt>
<dd><p>Encoders are used for submitting draw calls from multiple threads, so one encoder per thread. Use <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1ad9800f61a086fe35076e141c1198fc80"><span><span class="pre">bgfx::begin()</span></span></a></code> to obtain an encoder for a thread. </p>
<dd><p>Encoders are used for submitting draw calls from multiple threads. Only one encoder per thread should be used. Use <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1ad9800f61a086fe35076e141c1198fc80"><span><span class="pre">bgfx::begin()</span></span></a></code> to obtain an encoder for a thread. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder</span></code>. </dd>
@@ -3442,40 +3454,26 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7setNameE12ShaderHandlePKc">
<span id="bgfx::setName__ShaderHandle.cCP"></span><span class="target" id="namespacebgfx_1a5561bb80a08e1c799d60d5d666721cb5"></span>void <code class="descclassname">bgfx::</code><code class="descname">setName</code><span class="sig-paren">(</span>ShaderHandle <em>_handle</em>, <em class="property">const</em> char *<em>_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7setNameE12ShaderHandlePKc" title="Permalink to this definition"></a></dt>
<dd><p>Set shader debug name. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_shader_name</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Shader handle. </li>
<li><code class="docutils literal"><span class="pre">_name</span></code>: Shader name.</li>
</ul>
</dd>
</dl>
<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.
Potential matches:
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7setNameE13TextureHandlePKc">
<span id="bgfx::setName__TextureHandle.cCP"></span><span class="target" id="namespacebgfx_1a98de5e46897fe151b92c659b3dced951"></span>void <code class="descclassname">bgfx::</code><code class="descname">setName</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, <em class="property">const</em> char *<em>_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7setNameE13TextureHandlePKc" title="Permalink to this definition"></a></dt>
<dd><p>Set texture debug name. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_texture_name</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Texture handle. </li>
<li><code class="docutils literal"><span class="pre">_name</span></code>: Texture name.</li>
</ul>
</dd>
</dl>
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::setName(ShaderHandle, const char *, int32_t)
- void bgfx::setName(TextureHandle, const char *, int32_t)
</pre></div>
</div>
</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.
Potential matches:
</p>
</dd></dl>
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::setName(ShaderHandle, const char *, int32_t)
- void bgfx::setName(TextureHandle, const char *, int32_t)
</pre></div>
</div>
</div>
</div>
<div class="section" id="state">
<h4>State<a class="headerlink" href="#state" title="Permalink to this headline"></a></h4>
@@ -4807,12 +4805,22 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dt id="_CPPv2NK4bgfx10VertexDecl6decodeEN6Attrib4EnumER7uint8_tRN10AttribType4EnumERbRb">
<span id="bgfx::VertexDecl::decode__Attrib::Enum.uint8_tR.AttribType::EnumR.bR.bRC"></span><span class="target" id="structbgfx_1_1_vertex_decl_1a915f65137652582b4e6be86b28dc1e25"></span>void <code class="descname">decode</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 &amp;<em>_num</em>, <a class="reference internal" href="#_CPPv2N4bgfx10AttribTypeE" title="bgfx::AttribType">AttribType</a>::<a class="reference internal" href="#_CPPv2N4bgfx10AttribType4EnumE" title="bgfx::AttribType::Enum">Enum</a> &amp;<em>_type</em>, bool &amp;<em>_normalized</em>, bool &amp;<em>_asInt</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK4bgfx10VertexDecl6decodeEN6Attrib4EnumER7uint8_tRN10AttribType4EnumERbRb" title="Permalink to this definition"></a></dt>
<dd><p>Decode attribute. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_decode</span></code>. </dd>
</dl>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2NK4bgfx10VertexDecl3hasEN6Attrib4EnumE">
<span id="bgfx::VertexDecl::has__Attrib::EnumC"></span><span class="target" id="structbgfx_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> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK4bgfx10VertexDecl3hasEN6Attrib4EnumE" title="Permalink to this definition"></a></dt>
<dd><p>Returns true if <a class="reference internal" href="#structbgfx_1_1_vertex_decl"><span>VertexDecl</span></a> contains attribute. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_has</span></code>. </dd>
</dl>
</p>
</dd></dl>
<dl class="function">

View File

@@ -272,7 +272,15 @@ android-release, etc.
</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>
<p>Xcode command line:</p>
<div class="highlight-python"><div class="highlight"><pre>make osx-release64
cd examples/runtime
../../.build/osx64_clang/bin/examples.app/Contents/MacOS/examplesRelease
</pre></div>
</div>
<p>Xcode IDE:</p>
<div class="highlight-python"><div class="highlight"><pre>genie --with-combined-examples --xcode=osx xcode9
open .build/projects/xcode9-osx/bgfx.xcworkspace
</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>

View File

@@ -817,6 +817,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Init5debugE">bgfx::Init::debug (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Init8deviceIdE">bgfx::Init::deviceId (C++ member)</a>
</dt>
@@ -837,6 +841,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Init7profileE">bgfx::Init::profile (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Init10resolutionE">bgfx::Init::resolution (C++ member)</a>
</dt>
@@ -1033,10 +1041,6 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx7setNameE12ShaderHandlePKc">bgfx::setName (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx7setNameE13TextureHandlePKc">[1]</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx15setPaletteColorE7uint8_t8uint32_t">bgfx::setPaletteColor (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx15setPaletteColorE7uint8_tA4_Kf">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx15setPaletteColorE7uint8_tffff">[2]</a>
</dt>
@@ -1116,12 +1120,12 @@
<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>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimerFreqE">bgfx::Stats::cpuTimerFreq (C++ member)</a>
</dt>

Binary file not shown.

File diff suppressed because one or more lines are too long