mirrors/bgfx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić 2016-09-24 17:11:57 -07:00
parent 9a83da3a75
commit ad483c4100
4 changed files with 62 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
bgfx.html
View File

@ -861,6 +861,12 @@
<dd><p>Vulkan. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx12RendererType3GNME">
<span id="bgfx::RendererType::GNM"></span><span class="target" id="bgfxstructbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32a7ead435c9463228e316227e7784c50cd"></span><code class="descname">GNM</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType3GNME" title="Permalink to this definition"></a></dt>
<dd><p>GNM. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx12RendererType5CountE">
<span id="bgfx::RendererType::Count"></span><span class="target" id="bgfxstructbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32aab03bfb685626b6697f1456fcc1ad3f5"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType5CountE" title="Permalink to this definition"></a></dt>
@ -917,36 +923,6 @@
</p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps12maxDrawCallsE">
<span id="bgfx::Caps::maxDrawCalls__uint32_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1ad1a16dbb664ceb94b6edc6ca028b7818"></span>uint32_t <code class="descname">maxDrawCalls</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps12maxDrawCallsE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum draw calls. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps14maxTextureSizeE">
<span id="bgfx::Caps::maxTextureSize__uint16_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1a7e1866dc19eab68f57bac12525abca00"></span>uint16_t <code class="descname">maxTextureSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps14maxTextureSizeE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum texture size. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps8maxViewsE">
<span id="bgfx::Caps::maxViews__uint16_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1a8b071c5f3e4f398910b664ba7e9fbb27"></span>uint16_t <code class="descname">maxViews</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps8maxViewsE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum views. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps16maxFBAttachmentsE">
<span id="bgfx::Caps::maxFBAttachments__uint8_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1a5ab92b6fa6f5929d73de24a8291dd33f"></span>uint8_t <code class="descname">maxFBAttachments</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps16maxFBAttachmentsE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum frame buffer attachments. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps7numGPUsE">
<span id="bgfx::Caps::numGPUs__uint8_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1a4b1b11f121ff1ce7df944f4a5538406f"></span>uint8_t <code class="descname">numGPUs</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps7numGPUsE" title="Permalink to this definition"></a></dt>
<dd><p>Number of enumerated GPUs. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps8vendorIdE">
<span id="bgfx::Caps::vendorId__uint16_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1ac51fdd2bed74e1e71480409bd40bc4bc"></span>uint16_t <code class="descname">vendorId</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps8vendorIdE" title="Permalink to this definition"></a></dt>
@ -971,6 +947,12 @@
<dd><p>True when NDC origin is at bottom left. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps7numGPUsE">
<span id="bgfx::Caps::numGPUs__uint8_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1a4b1b11f121ff1ce7df944f4a5538406f"></span>uint8_t <code class="descname">numGPUs</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps7numGPUsE" title="Permalink to this definition"></a></dt>
<dd><p>Number of enumerated GPUs. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps3gpuE">
<span id="bgfx::Caps::gpu__GPUA"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1ac57ba69338666cbb6b26b50df04d045a"></span><a class="reference internal" href="#_CPPv2N4bgfx4Caps3GPUE" title="bgfx::Caps::GPU">GPU</a> <code class="descname">gpu</code>[4]<a class="headerlink" href="#_CPPv2N4bgfx4Caps3gpuE" title="Permalink to this definition"></a></dt>
@ -1013,6 +995,38 @@
</p>
</dd></dl>
<dl class="class">
<dt id="_CPPv2N4bgfx4Caps6LimitsE">
<span id="bgfx::Caps::Limits"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1_1_limits"></span><em class="property">struct </em><code class="descname">Limits</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6LimitsE" title="Permalink to this definition"></a></dt>
<dd><div class="breathe-sectiondef container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits12maxDrawCallsE">
<span id="bgfx::Caps::Limits::maxDrawCalls__uint32_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1_1_limits_1ac324029c23579396238cca5af3027a64"></span>uint32_t <code class="descname">maxDrawCalls</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits12maxDrawCallsE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum draw calls. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits14maxTextureSizeE">
<span id="bgfx::Caps::Limits::maxTextureSize__uint32_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1_1_limits_1a0e2f1e34625efb46c2b27f080879885e"></span>uint32_t <code class="descname">maxTextureSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits14maxTextureSizeE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum texture size. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits8maxViewsE">
<span id="bgfx::Caps::Limits::maxViews__uint32_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1_1_limits_1ab498589784aa6b1cf5b746994634171d"></span>uint32_t <code class="descname">maxViews</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits8maxViewsE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum views. </p>
</dd></dl>
<dl class="member">
<dt id="_CPPv2N4bgfx4Caps6Limits16maxFBAttachmentsE">
<span id="bgfx::Caps::Limits::maxFBAttachments__uint32_t"></span><span class="target" id="bgfxstructbgfx_1_1_caps_1_1_limits_1af7cd37b90264f803a0cd32feb38eef15"></span>uint32_t <code class="descname">maxFBAttachments</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits16maxFBAttachmentsE" title="Permalink to this definition"></a></dt>
<dd><p>Maximum frame buffer attachments. </p>
</dd></dl>
</div>
</dd></dl>
</dd></dl>
<div class="section" id="available-caps">
@ -2721,6 +2735,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</div>
<div class="section" id="submit">
<h3>Submit<a class="headerlink" href="#submit" title="Permalink to this headline"></a></h3>
<p>Within view all draw commands are executed after blit and compute commands.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle7int32_tb">
<span id="bgfx::submit__uint8_t.ProgramHandle.int32_t.b"></span><span class="target" id="bgfxnamespacebgfx_1aa4b058cface13ced7c67a1dbede8339f"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">submit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_program</em>, int32_t <em>_depth</em> = 0, bool <em>_preserveState</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle7int32_tb" title="Permalink to this definition"></a></dt>
@ -2977,6 +2992,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</div>
<div class="section" id="dispatch">
<h3>Dispatch<a class="headerlink" href="#dispatch" title="Permalink to this headline"></a></h3>
<p>Within view all compute commands are dispatched after blit commands, and before draw commands.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx8dispatchE7uint8_t13ProgramHandle8uint16_t8uint16_t8uint16_t7uint8_t">
<span id="bgfx::dispatch__uint8_t.ProgramHandle.uint16_t.uint16_t.uint16_t.uint8_t"></span><span class="target" id="bgfxnamespacebgfx_1af287a9fbfdee622ed186b020cfc8b269"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">dispatch</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_handle</em>, uint16_t <em>_numX</em> = 1, uint16_t <em>_numY</em> = 1, uint16_t <em>_numZ</em> = 1, uint8_t <em>_flags</em> = BGFX_SUBMIT_EYE_FIRST<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8dispatchE7uint8_t13ProgramHandle8uint16_t8uint16_t8uint16_t7uint8_t" title="Permalink to this definition"></a></dt>
@ -3043,6 +3059,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</div>
<div class="section" id="blit">
<h2>Blit<a class="headerlink" href="#blit" title="Permalink to this headline"></a></h2>
<p>Within view all blit commands are executed before compute, and draw commands.</p>
<dl class="function">
<dt id="_CPPv2N4bgfx4blitE7uint8_t13TextureHandle8uint16_t8uint16_t13TextureHandle8uint16_t8uint16_t8uint16_t8uint16_t">
<span id="bgfx::blit__uint8_t.TextureHandle.uint16_t.uint16_t.TextureHandle.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="bgfxnamespacebgfx_1a0ced752657573f20fd4fb3006b6287c8"></span>void <code class="descclassname">bgfx::</code><code class="descname">blit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, TextureHandle <em>_dst</em>, uint16_t <em>_dstX</em>, uint16_t <em>_dstY</em>, TextureHandle <em>_src</em>, uint16_t <em>_srcX</em> = 0, uint16_t <em>_srcY</em> = 0, uint16_t <em>_width</em> = UINT16_MAX, uint16_t <em>_height</em> = UINT16_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4blitE7uint8_t13TextureHandle8uint16_t8uint16_t13TextureHandle8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition"></a></dt>

20
genindex.html
View File

@ -308,19 +308,23 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps12maxDrawCallsE">bgfx::Caps::maxDrawCalls (C++ member)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6LimitsE">bgfx::Caps::Limits (C++ class)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps16maxFBAttachmentsE">bgfx::Caps::maxFBAttachments (C++ member)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits12maxDrawCallsE">bgfx::Caps::Limits::maxDrawCalls (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps14maxTextureSizeE">bgfx::Caps::maxTextureSize (C++ member)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits16maxFBAttachmentsE">bgfx::Caps::Limits::maxFBAttachments (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps8maxViewsE">bgfx::Caps::maxViews (C++ member)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits14maxTextureSizeE">bgfx::Caps::Limits::maxTextureSize (C++ member)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx4Caps6Limits8maxViewsE">bgfx::Caps::Limits::maxViews (C++ member)</a>
</dt>
@ -668,6 +672,10 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx12RendererType3GNME">bgfx::RendererType::GNM (C++ class)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx12RendererType5MetalE">bgfx::RendererType::Metal (C++ class)</a>
</dt>
@ -855,12 +863,12 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx13TextureFormat3BC2E">bgfx::TextureFormat::BC2 (C++ class)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx13TextureFormat3BC3E">bgfx::TextureFormat::BC3 (C++ class)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx13TextureFormat3BC4E">bgfx::TextureFormat::BC4 (C++ class)</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