Updated docs.

This commit is contained in:
Branimir Karadžić
2017-06-12 22:58:17 -07:00
parent 60c7a8bff6
commit 10e59138b5
7 changed files with 56 additions and 25 deletions

View File

@@ -1689,10 +1689,26 @@ creating windows.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx10vertexPackEA4_KfbN6Attrib4EnumERK10VertexDeclPv8uint32_t">
<span id="bgfx::vertexPack__floatCA.b.Attrib::Enum.VertexDeclCR.voidP.uint32_t"></span><span class="target" id="bgfxnamespacebgfx_1af00c88a0daf27e1ddc43470a3e0f73ad"></span>void <code class="descclassname">bgfx::</code><code class="descname">vertexPack</code><span class="sig-paren">(</span><em class="property">const</em> float <em>_input</em>[4], bool <em>_inputNormalized</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attr</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<em>_decl</em>, void *<em>_data</em>, uint32_t <em>_index</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10vertexPackEA4_KfbN6Attrib4EnumERK10VertexDeclPv8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Pack vec4 into vertex stream format. </p>
<dd><p>Pack vertex attribute into vertex stream format. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_pack</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_input</span></code> - <p>Value to be packed into vertex stream. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_inputNormalized</span></code> - <p>True if input value is already normalized. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_attr</span></code> - <p>Attribute to pack. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex stream declaration. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Destination vertex stream where data will be packed. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_index</span></code> - <p>Vertex index that will be modified.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
@@ -1700,10 +1716,24 @@ creating windows.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx12vertexUnpackEA4_fN6Attrib4EnumERK10VertexDeclPKv8uint32_t">
<span id="bgfx::vertexUnpack__floatA.Attrib::Enum.VertexDeclCR.voidCP.uint32_t"></span><span class="target" id="bgfxnamespacebgfx_1a2407f7864d3303f18177f4b6ec1fbd08"></span>void <code class="descclassname">bgfx::</code><code class="descname">vertexUnpack</code><span class="sig-paren">(</span>float <em>_output</em>[4], <a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attr</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &amp;<em>_decl</em>, <em class="property">const</em> void *<em>_data</em>, uint32_t <em>_index</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12vertexUnpackEA4_fN6Attrib4EnumERK10VertexDeclPKv8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Unpack vec4 from vertex stream format. </p>
<dd><p>Unpack vertex attribute from vertex stream format. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_unpack</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_output</span></code> - <p>Result of unpacking. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_attr</span></code> - <p>Attribute to unpack. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex stream declaration. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Source vertex stream from where data will be unpacked. </p>
</li>
<li><code class="first docutils literal"><span class="pre">_index</span></code> - <p>Vertex index that will be unpacked.</p>
</li>
</ul>
</dd>
</dl>
</p>
</dd></dl>
@@ -3792,6 +3822,18 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd><p>a_color1 </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx6Attrib6Color2E">
<span id="bgfx::Attrib::Color2"></span><span class="target" id="bgfxstructbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a5f72a5fba4d62dd373c8c8387d120270"></span><code class="descname">Color2</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib6Color2E" title="Permalink to this definition"></a></dt>
<dd><p>a_color2 </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx6Attrib6Color3E">
<span id="bgfx::Attrib::Color3"></span><span class="target" id="bgfxstructbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a345365a6d18a7fea2d4cbfc10cd8e699"></span><code class="descname">Color3</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib6Color3E" title="Permalink to this definition"></a></dt>
<dd><p>a_color3 </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx6Attrib7IndicesE">
<span id="bgfx::Attrib::Indices"></span><span class="target" id="bgfxstructbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804aec853fa913eaa3fe7000e8de29221251"></span><code class="descname">Indices</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib7IndicesE" title="Permalink to this definition"></a></dt>

View File

@@ -93,7 +93,6 @@
<li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#android">Android</a></li>
<li class="toctree-l3"><a class="reference internal" href="#linux">Linux</a></li>
<li class="toctree-l3"><a class="reference internal" href="#native-client">Native Client</a></li>
<li class="toctree-l3"><a class="reference internal" href="#windows">Windows</a></li>
</ul>
</li>
@@ -222,19 +221,6 @@
</pre></div>
</div>
</div>
<div class="section" id="native-client">
<h3>Native Client<a class="headerlink" href="#native-client" title="Permalink to this headline"></a></h3>
<p>Download Native Client SDK:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://developers.google.com/native-client/sdk/download">https://developers.google.com/native-client/sdk/download</a></li>
</ul>
</div></blockquote>
<p>Set following enironment variables:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">setx</span> <span class="n">NACL_SDK_ROOT</span> <span class="o">&lt;</span><span class="n">path</span> <span class="n">to</span> <span class="n">Native</span> <span class="n">Client</span> <span class="n">SDK</span> <span class="n">directory</span><span class="o">&gt;</span>
</pre></div>
</div>
</div>
<div class="section" id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline"></a></h3>
<p>Windows users download GnuWin32 utilities:</p>

View File

@@ -195,6 +195,14 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx6Attrib6Color2E">bgfx::Attrib::Color2 (C++ class)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx6Attrib6Color3E">bgfx::Attrib::Color3 (C++ class)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx6Attrib5CountE">bgfx::Attrib::Count (C++ class)</a>
</dt>
@@ -930,12 +938,12 @@
<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>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12gpuTimerFreqE">bgfx::Stats::gpuTimerFreq (C++ member)</a>
</dt>

View File

@@ -182,7 +182,6 @@ licensed under permissive BSD-2 clause open source license.</p>
<li class="toctree-l2"><a class="reference internal" href="build.html#prerequisites">Prerequisites</a><ul>
<li class="toctree-l3"><a class="reference internal" href="build.html#android">Android</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html#linux">Linux</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html#native-client">Native Client</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html#windows">Windows</a></li>
</ul>
</li>

Binary file not shown.

View File

@@ -199,7 +199,6 @@ licensed under permissive BSD-2 clause open source license.</p>
<li>iOS (iPhone, iPad, AppleTV)</li>
<li>Linux</li>
<li>MIPS Creator CI20</li>
<li>Native Client (PPAPI 37+, ARM, x86, x64, PNaCl)</li>
<li>OSX (10.9+)</li>
<li>RaspberryPi</li>
<li>SteamLink</li>
@@ -286,10 +285,7 @@ SDK</a>.</p>
compiler switches. For example setting preprocessor define
<code class="docutils literal"><span class="pre">BGFX_CONFIG_RENDERER_OPENGL=1</span></code> will change backend renderer to OpenGL
2.1. on Windows. Since rendering APIs are platform specific, this
obviously won&#8217;t work nor make sense in all cases. Certain platforms have
only single choice, for example the Native Client works only with OpenGL
ES 2.0 renderer, using anything other than that will result in build
errors.</p>
obviously won&#8217;t work nor make sense in all cases.</p>
</div>
<div class="section" id="debugging-and-profiling">
<h2>Debugging and Profiling<a class="headerlink" href="#debugging-and-profiling" title="Permalink to this headline"></a></h2>

File diff suppressed because one or more lines are too long