Updated docs.

This commit is contained in:
Branimir Karadžić
2018-07-07 15:59:17 -07:00
parent 2c533a093f
commit cd01bfdb17
5 changed files with 46 additions and 28 deletions

View File

@@ -3472,26 +3472,42 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
</p>
</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 *, int32_t _len) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
Potential matches:
<dl class="function">
<dt id="_CPPv2N4bgfx7setNameE12ShaderHandlePKc7int32_t">
<span id="bgfx::setName__ShaderHandle.cCP.int32_t"></span><span class="target" id="namespacebgfx_1a7d44c7ebbc42932b4f22ea9d8aa9047a"></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>, int32_t <em>_len</em> = INT32_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7setNameE12ShaderHandlePKc7int32_t" 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>
<li><code class="docutils literal"><span class="pre">_len</span></code>: Shader name length (if length is INT32_MAX, it&#8217;s expected that _name is zero terminated string.</li>
</ul>
</dd>
</dl>
</p>
<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 *, int32_t _len) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
Potential matches:
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx7setNameE13TextureHandlePKc7int32_t">
<span id="bgfx::setName__TextureHandle.cCP.int32_t"></span><span class="target" id="namespacebgfx_1a852d5743e0942806741f3d1790bab783"></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>, int32_t <em>_len</em> = INT32_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7setNameE13TextureHandlePKc7int32_t" 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>
<li><code class="docutils literal"><span class="pre">_len</span></code>: Texture name length (if length is INT32_MAX, it&#8217;s expected that _name is zero terminated string.</li>
</ul>
</dd>
</dl>
</p>
<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>
</dd></dl>
</div>
<div class="section" id="state">
<h4>State<a class="headerlink" href="#state" title="Permalink to this headline"></a></h4>
@@ -4440,7 +4456,9 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<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>
<li><code class="docutils literal"><span class="pre">_size</span></code>: Size of data. </li>
<li><code class="docutils literal"><span class="pre">_releaseFn</span></code>: Callback function to release memory after use. </li>
<li><code class="docutils literal"><span class="pre">_userData</span></code>: User data to be passed to callback function.</li>
</ul>
</dd>
</dl>

View File

@@ -230,10 +230,6 @@ setx ANDROID_NDK_X86 &lt;path to AndroidNDK directory&gt;\toolchains\x86-4.7\pre
<li><a class="reference external" href="http://gnuwin32.sourceforge.net/packages/libintl.htm">http://gnuwin32.sourceforge.net/packages/libintl.htm</a></li>
</ul>
</div></blockquote>
<p>If you&#8217;re building with Visual Studio 2008, you&#8217;ll need TR1 support
from:
<a class="reference external" href="https://www.microsoft.com/en-us/download/details.aspx?id=6922">Visual C++ 2008 Feature Pack
Release</a></p>
</div>
</div>
<div class="section" id="build">
@@ -261,12 +257,12 @@ android-release, etc.
</div>
<div class="section" id="id1">
<h3>Windows<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<p>Visual Studio 2008 command line:</p>
<div class="highlight-python"><div class="highlight"><pre>make vs2008-release64
<p>Visual Studio 2017 command line:</p>
<div class="highlight-python"><div class="highlight"><pre>make vs2017-release64
</pre></div>
</div>
<p>Visual Studio 2008 IDE:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">start</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">vs2008</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">sln</span>
<p>Visual Studio 2017 IDE:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">start</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">vs2017</span><span class="o">/</span><span class="n">bgfx</span><span class="o">.</span><span class="n">sln</span>
</pre></div>
</div>
</div>

View File

@@ -1049,6 +1049,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx7setNameE12ShaderHandlePKc7int32_t">bgfx::setName (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx7setNameE13TextureHandlePKc7int32_t">[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>

Binary file not shown.

File diff suppressed because one or more lines are too long