Mirrors/bgfx
1
0
Fork 0
mirror of https://github.com/bkaradzic/bgfx.git synced 2026-02-18 13:03:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić
2018-02-13 18:13:05 -08:00
parent b65af3bdce
commit ba747e7cf6
4 changed files with 17 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
bgfx.html
View File

@@ -2675,13 +2675,11 @@ In graphics debugger view name will appear as: <div class="highlight-default"><d
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_state</span></code> - <p>State flags. Default state for primitive type is triangles. See: <code class="docutils literal"><span class="pre">BGFX_STATE_DEFAULT</span></code>.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_STATE_ALPHA_WRITE</span></code> - Enable alpha write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_DEPTH_WRITE</span></code> - Enable depth write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_DEPTH_TEST_*</span></code> - Depth test function.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_*</span></code> - See remark 1 about BGFX_STATE_BLEND_FUNC.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION_*</span></code> - See remark 2.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_CULL_*</span></code> - Backface culling mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_RGB_WRITE</span></code> - Enable RGB write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_WRITE_*</span></code> - Enable R, G, B, A or Z write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_MSAA</span></code> - Enable hardware multisample antialiasing.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_PT_[TRISTRIP/LINES/POINTS]</span></code> - Primitive type.</li>
</ul>
@@ -3664,13 +3662,11 @@ In graphics debugger view name will appear as: <div class="highlight-default"><d
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last">
<li><code class="first docutils literal"><span class="pre">_state</span></code> - <p>State flags. Default state for primitive type is triangles. See: <code class="docutils literal"><span class="pre">BGFX_STATE_DEFAULT</span></code>.<ul class="simple">
<li><code class="docutils literal"><span class="pre">BGFX_STATE_ALPHA_WRITE</span></code> - Enable alpha write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_DEPTH_WRITE</span></code> - Enable depth write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_DEPTH_TEST_*</span></code> - Depth test function.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_*</span></code> - See remark 1 about BGFX_STATE_BLEND_FUNC.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION_*</span></code> - See remark 2.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_CULL_*</span></code> - Backface culling mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_RGB_WRITE</span></code> - Enable RGB write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_WRITE_*</span></code> - Enable R, G, B, A or Z write.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_MSAA</span></code> - Enable MSAA.</li>
<li><code class="docutils literal"><span class="pre">BGFX_STATE_PT_[TRISTRIP/LINES/POINTS]</span></code> - Primitive type.</li>
</ul>
@@ -3687,25 +3683,18 @@ In graphics debugger view name will appear as: <div class="highlight-default"><d
</div>
<div class="section" id="state-flags">
<h4>State Flags<a class="headerlink" href="#state-flags" title="Permalink to this headline"></a></h4>
<dl class="macro">
<dt id="c.BGFX_STATE_RGB_WRITE">
<span class="target" id="bgfxdefines_8h_1aff0cc52a35c2c01f874bb283a6103f03"></span><code class="descname">BGFX_STATE_RGB_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_RGB_WRITE" title="Permalink to this definition"></a></dt>
<dd><p>Color RGB/alpha/depth write. When it&#8217;s not specified write will be disabled. </p>
<p>Enable RGB write. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_STATE_ALPHA_WRITE">
<span class="target" id="bgfxdefines_8h_1aa6611f657f8f1b311dfc466b79c9290e"></span><code class="descname">BGFX_STATE_ALPHA_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_ALPHA_WRITE" title="Permalink to this definition"></a></dt>
<dd><p>Enable alpha write. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_STATE_DEPTH_WRITE">
<span class="target" id="bgfxdefines_8h_1acf5681b2e7477ac01186cc535ea59213"></span><code class="descname">BGFX_STATE_DEPTH_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_WRITE" title="Permalink to this definition"></a></dt>
<dd><p>Enable depth write. </p>
</dd></dl>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">doxygendefine: Cannot find define &#8220;BGFX_STATE_RGB_WRITE&#8221; in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml</p>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">doxygendefine: Cannot find define &#8220;BGFX_STATE_ALPHA_WRITE&#8221; in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml</p>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">doxygendefine: Cannot find define &#8220;BGFX_STATE_DEPTH_WRITE&#8221; in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml</p>
</div>
<dl class="macro">
<dt id="c.BGFX_STATE_DEFAULT">
<span class="target" id="bgfxdefines_8h_1a7f87ba52187999ca674a61ccc27170db"></span><code class="descname">BGFX_STATE_DEFAULT</code><a class="headerlink" href="#c.BGFX_STATE_DEFAULT" title="Permalink to this definition"></a></dt>

16
genindex.html
View File

@@ -1055,6 +1055,8 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx16setViewTransformE6ViewIdPKvPKv7uint8_tPKv">bgfx::setViewTransform (C++ function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx8shutdownEv">bgfx::shutdown (C++ function)</a>
</dt>
@@ -1063,8 +1065,6 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx5StatsE">bgfx::Stats (C++ class)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats12cpuTimeBeginE">bgfx::Stats::cpuTimeBegin (C++ member)</a>
</dt>
@@ -1966,22 +1966,10 @@
</dt>
<dt><a href="bgfx.html#c.BGFX_STATE_ALPHA_WRITE">BGFX_STATE_ALPHA_WRITE (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_STATE_DEFAULT">BGFX_STATE_DEFAULT (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_STATE_DEPTH_WRITE">BGFX_STATE_DEPTH_WRITE (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_STATE_RGB_WRITE">BGFX_STATE_RGB_WRITE (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_STENCIL_TEST_LESS">BGFX_STENCIL_TEST_LESS (C macro)</a>
</dt>

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