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

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić
2018-08-24 19:56:30 -07:00
parent 5630bb6be1
commit 2c8a8afb21
4 changed files with 83 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

213
bgfx.html
View File

@@ -3049,8 +3049,8 @@ In graphics debugger view name will appear as: <div class="highlight-python"><di
<li><code class="docutils literal"><span class="pre">_sampler</span></code>: Program sampler. </li>
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Texture handle. </li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Texture sampling mode. Default value UINT32_MAX uses texture sampling settings from the texture.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
</ul>
@@ -3949,8 +3949,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<li><code class="docutils literal"><span class="pre">_sampler</span></code>: Program sampler. </li>
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Texture handle. </li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Texture sampling mode. Default value UINT32_MAX uses texture sampling settings from the texture.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
</ul>
@@ -5784,8 +5784,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx14isTextureValidE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_t">
<span id="bgfx::isTextureValid__uint16_t.b.uint16_t.TextureFormat::Enum.uint32_t"></span><span class="target" id="namespacebgfx_1aa3df5384ecdb3bfc43d9cc969b28c160"></span>bool <code class="descclassname">bgfx::</code><code class="descname">isTextureValid</code><span class="sig-paren">(</span>uint16_t <em>_depth</em>, bool <em>_cubeMap</em>, uint16_t <em>_numLayers</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14isTextureValidE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx14isTextureValidE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_t">
<span id="bgfx::isTextureValid__uint16_t.b.uint16_t.TextureFormat::Enum.uint64_t"></span><span class="target" id="namespacebgfx_1a3c7386558ec793583dd0ce0db77b8c17"></span>bool <code class="descclassname">bgfx::</code><code class="descname">isTextureValid</code><span class="sig-paren">(</span>uint16_t <em>_depth</em>, bool <em>_cubeMap</em>, uint16_t <em>_numLayers</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint64_t <em>_flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14isTextureValidE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_t" title="Permalink to this definition"></a></dt>
<dd><p>Validate texture parameters. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -5829,8 +5829,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx13createTextureEPK6Memory8uint32_t7uint8_tP11TextureInfo">
<span id="bgfx::createTexture__MemoryCP.uint32_t.uint8_t.TextureInfoP"></span><span class="target" id="namespacebgfx_1aca798f1779754c7c22631a4cb3a0b5a4"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em>, uint32_t <em>_flags</em> = BGFX_SAMPLER_NONE, uint8_t <em>_skip</em> = 0, TextureInfo *<em>_info</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13createTextureEPK6Memory8uint32_t7uint8_tP11TextureInfo" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx13createTextureEPK6Memory8uint64_t7uint8_tP11TextureInfo">
<span id="bgfx::createTexture__MemoryCP.uint64_t.uint8_t.TextureInfoP"></span><span class="target" id="namespacebgfx_1a0d47613a70e82fb734b058f6a707cef5"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em>, uint64_t <em>_flags</em> = BGFX_TEXTURE_NONE|BGFX_SAMPLER_NONE, uint8_t <em>_skip</em> = 0, TextureInfo *<em>_info</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13createTextureEPK6Memory8uint64_t7uint8_tP11TextureInfo" title="Permalink to this definition"></a></dt>
<dd><p>Create texture from memory buffer. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
@@ -5840,9 +5840,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">_mem</span></code>: DDS, KTX or PVR texture data. </li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Texture creation (see <code class="docutils literal"><span class="pre">BGFX_TEXTURE_*</span></code>.), and sampler (see <code class="docutils literal"><span class="pre">BGFX_SAMPLER_*</span></code>) flags. Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">_skip</span></code>: Skip top level mips when parsing texture. </li>
@@ -5853,56 +5853,26 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx15createTexture2DE8uint16_t8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_tPK6Memory">
<span id="bgfx::createTexture2D__uint16_t.uint16_t.b.uint16_t.TextureFormat::Enum.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1a060d1c036178f7a2614e5d520978ffb0"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture2D</code><span class="sig-paren">(</span>uint16_t <em>_width</em>, uint16_t <em>_height</em>, bool <em>_hasMips</em>, uint16_t <em>_numLayers</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_flags</em> = BGFX_SAMPLER_NONE, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15createTexture2DE8uint16_t8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_tPK6Memory" title="Permalink to this definition"></a></dt>
<dd><p>Create 2D texture. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_texture_2d</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width. </li>
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height. </li>
<li><code class="docutils literal"><span class="pre">_hasMips</span></code>: Indicates that texture contains full mip-map chain. </li>
<li><code class="docutils literal"><span class="pre">_numLayers</span></code>: Number of layers in texture array. Must be 1 if caps <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_2D_ARRAY</span></code> flag is not set. </li>
<li><code class="docutils literal"><span class="pre">_format</span></code>: Texture format. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Texture data. If <code class="docutils literal"><span class="pre">_mem</span></code> is non-NULL, created texture will be immutable. If <code class="docutils literal"><span class="pre">_mem</span></code> is NULL content of the texture is uninitialized. When <code class="docutils literal"><span class="pre">_numLayers</span></code> is more than 1, expected memory layout is texture and all mips together for each array element.</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::createTexture2D&#8221; with arguments (uint16_t, uint16_t, bool, uint16_t, TextureFormat::Enum, uint32_t, const Memory *) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
Potential matches:
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx15createTexture2DEN15BackbufferRatio4EnumEb8uint16_tN13TextureFormat4EnumE8uint32_t">
<span id="bgfx::createTexture2D__BackbufferRatio::Enum.b.uint16_t.TextureFormat::Enum.uint32_t"></span><span class="target" id="namespacebgfx_1a3c40d5147d900dd51e96957925554aa4"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture2D</code><span class="sig-paren">(</span>BackbufferRatio::Enum <em>_ratio</em>, bool <em>_hasMips</em>, uint16_t <em>_numLayers</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_flags</em> = BGFX_SAMPLER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15createTexture2DEN15BackbufferRatio4EnumEb8uint16_tN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Create frame buffer with size based on backbuffer ratio. Frame buffer will maintain ratio if back buffer resolution changes. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_texture_2d_scaled</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_ratio</span></code>: Frame buffer size in respect to back-buffer size. See: <code class="docutils literal"><span class="pre">BackbufferRatio::Enum</span></code>. </li>
<li><code class="docutils literal"><span class="pre">_hasMips</span></code>: Indicates that texture contains full mip-map chain. </li>
<li><code class="docutils literal"><span class="pre">_numLayers</span></code>: Number of layers in texture array. Must be 1 if caps <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_2D_ARRAY</span></code> flag is not set. </li>
<li><code class="docutils literal"><span class="pre">_format</span></code>: Texture format. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
</ul>
</dd>
</dl>
<div class="last highlight-python"><div class="highlight"><pre>- TextureHandle bgfx::createTexture2D(BackbufferRatio::Enum, bool, uint16_t, TextureFormat::Enum, uint64_t)
- TextureHandle bgfx::createTexture2D(uint16_t, uint16_t, bool, uint16_t, TextureFormat::Enum, uint64_t, const Memory *)
</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::createTexture2D&#8221; with arguments (BackbufferRatio::Enum, bool, uint16_t, TextureFormat::Enum, uint32_t) 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>- TextureHandle bgfx::createTexture2D(BackbufferRatio::Enum, bool, uint16_t, TextureFormat::Enum, uint64_t)
- TextureHandle bgfx::createTexture2D(uint16_t, uint16_t, bool, uint16_t, TextureFormat::Enum, uint64_t, const Memory *)
</pre></div>
</div>
</div>
<dl class="function">
<dt id="_CPPv2N4bgfx15updateTexture2DE13TextureHandle8uint16_t7uint8_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory8uint16_t">
<span id="bgfx::updateTexture2D__TextureHandle.uint16_t.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.MemoryCP.uint16_t"></span><span class="target" id="namespacebgfx_1af47f352c1dcfd2c67dab1a58bb448541"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateTexture2D</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, uint16_t <em>_layer</em>, uint8_t <em>_mip</em>, uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em>, uint16_t <em>_pitch</em> = UINT16_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15updateTexture2DE13TextureHandle8uint16_t7uint8_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory8uint16_t" title="Permalink to this definition"></a></dt>
@@ -5928,8 +5898,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_tbN13TextureFormat4EnumE8uint32_tPK6Memory">
<span id="bgfx::createTexture3D__uint16_t.uint16_t.uint16_t.b.TextureFormat::Enum.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1a42d9571cb097da330d7bfe8949eb9a91"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture3D</code><span class="sig-paren">(</span>uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint16_t <em>_depth</em>, bool <em>_hasMips</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_flags</em> = BGFX_SAMPLER_NONE, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_tbN13TextureFormat4EnumE8uint32_tPK6Memory" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_tbN13TextureFormat4EnumE8uint64_tPK6Memory">
<span id="bgfx::createTexture3D__uint16_t.uint16_t.uint16_t.b.TextureFormat::Enum.uint64_t.MemoryCP"></span><span class="target" id="namespacebgfx_1a5b3e757ceb8eaa783856c39e3e18e985"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture3D</code><span class="sig-paren">(</span>uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint16_t <em>_depth</em>, bool <em>_hasMips</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint64_t <em>_flags</em> = BGFX_TEXTURE_NONE|BGFX_SAMPLER_NONE, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_tbN13TextureFormat4EnumE8uint64_tPK6Memory" title="Permalink to this definition"></a></dt>
<dd><p>Create 3D texture. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
@@ -5941,9 +5911,9 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth. </li>
<li><code class="docutils literal"><span class="pre">_hasMips</span></code>: Indicates that texture contains full mip-map chain. </li>
<li><code class="docutils literal"><span class="pre">_format</span></code>: Texture format. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Texture creation (see <code class="docutils literal"><span class="pre">BGFX_TEXTURE_*</span></code>.), and sampler (see <code class="docutils literal"><span class="pre">BGFX_SAMPLER_*</span></code>) flags. Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Texture data. If <code class="docutils literal"><span class="pre">_mem</span></code> is non-NULL, created texture will be immutable. If <code class="docutils literal"><span class="pre">_mem</span></code> is NULL content of the texture is uninitialized.</li>
@@ -5978,8 +5948,8 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx17createTextureCubeE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_tPK6Memory">
<span id="bgfx::createTextureCube__uint16_t.b.uint16_t.TextureFormat::Enum.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1ae5dbb340b51acfe280aa459765617722"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTextureCube</code><span class="sig-paren">(</span>uint16_t <em>_size</em>, bool <em>_hasMips</em>, uint16_t <em>_numLayers</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_flags</em> = BGFX_SAMPLER_NONE, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createTextureCubeE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_tPK6Memory" title="Permalink to this definition"></a></dt>
<dt id="_CPPv2N4bgfx17createTextureCubeE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_tPK6Memory">
<span id="bgfx::createTextureCube__uint16_t.b.uint16_t.TextureFormat::Enum.uint64_t.MemoryCP"></span><span class="target" id="namespacebgfx_1aa78aaf8f1d6f52a956330e7336d403f8"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTextureCube</code><span class="sig-paren">(</span>uint16_t <em>_size</em>, bool <em>_hasMips</em>, uint16_t <em>_numLayers</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint64_t <em>_flags</em> = BGFX_TEXTURE_NONE|BGFX_SAMPLER_NONE, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createTextureCubeE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_tPK6Memory" title="Permalink to this definition"></a></dt>
<dd><p>Create Cube texture. </p>
<p><dl class="docutils">
<dt><strong>Attention</strong></dt>
@@ -5990,9 +5960,9 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<li><code class="docutils literal"><span class="pre">_hasMips</span></code>: Indicates that texture contains full mip-map chain. </li>
<li><code class="docutils literal"><span class="pre">_numLayers</span></code>: Number of layers in texture array. Must be 1 if caps <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_CUBE_ARRAY</span></code> flag is not set. </li>
<li><code class="docutils literal"><span class="pre">_format</span></code>: Texture format. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Texture creation (see <code class="docutils literal"><span class="pre">BGFX_TEXTURE_*</span></code>.), and sampler (see <code class="docutils literal"><span class="pre">BGFX_SAMPLER_*</span></code>) flags. Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Texture data. If <code class="docutils literal"><span class="pre">_mem</span></code> is non-NULL, created texture will be immutable. If <code class="docutils literal"><span class="pre">_mem</span></code> is NULL content of the texture is uninitialized. When <code class="docutils literal"><span class="pre">_numLayers</span></code> is more than 1, expected memory layout is texture and all mips together for each array element.</li>
@@ -6108,55 +6078,32 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</div>
<div class="section" id="frame-buffers">
<h3>Frame Buffers<a class="headerlink" href="#frame-buffers" title="Permalink to this headline"></a></h3>
<dl class="function">
<dt id="_CPPv2N4bgfx17createFrameBufferE8uint16_t8uint16_tN13TextureFormat4EnumE8uint32_t">
<span id="bgfx::createFrameBuffer__uint16_t.uint16_t.TextureFormat::Enum.uint32_t"></span><span class="target" id="namespacebgfx_1ad1848fd5810ab72328173895135fb60e"></span>FrameBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createFrameBuffer</code><span class="sig-paren">(</span>uint16_t <em>_width</em>, uint16_t <em>_height</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_textureFlags</em> = BGFX_SAMPLER_U_CLAMP|BGFX_SAMPLER_V_CLAMP<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferE8uint16_t8uint16_tN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Create frame buffer (simple). </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Handle to frame buffer object.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_frame_buffer</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_width</span></code>: Texture width. </li>
<li><code class="docutils literal"><span class="pre">_height</span></code>: Texture height. </li>
<li><code class="docutils literal"><span class="pre">_format</span></code>: Texture format. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </li>
<li><code class="docutils literal"><span class="pre">_textureFlags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</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::createFrameBuffer&#8221; with arguments (uint16_t, uint16_t, TextureFormat::Enum, uint32_t) in doxygen xml output for project &#8220;bgfx&#8221; from directory: ../../.build/docs/xml.
Potential matches:
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx17createFrameBufferEN15BackbufferRatio4EnumEN13TextureFormat4EnumE8uint32_t">
<span id="bgfx::createFrameBuffer__BackbufferRatio::Enum.TextureFormat::Enum.uint32_t"></span><span class="target" id="namespacebgfx_1a0d213a6cc9b46d10afb20f5287bca95b"></span>FrameBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createFrameBuffer</code><span class="sig-paren">(</span>BackbufferRatio::Enum <em>_ratio</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_textureFlags</em> = BGFX_SAMPLER_U_CLAMP|BGFX_SAMPLER_V_CLAMP<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferEN15BackbufferRatio4EnumEN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition"></a></dt>
<dd><p>Create frame buffer with size based on backbuffer ratio. Frame buffer will maintain ratio if back buffer resolution changes. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Handle to frame buffer object.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_frame_buffer_scaled</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_ratio</span></code>: Frame buffer size in respect to back-buffer size. See: <code class="docutils literal"><span class="pre">BackbufferRatio::Enum</span></code>. </li>
<li><code class="docutils literal"><span class="pre">_format</span></code>: Texture format. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </li>
<li><code class="docutils literal"><span class="pre">_textureFlags</span></code>: Default texture sampling mode is linear, and wrap mode is repeat.<ul>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[U/V/W]_[MIRROR/CLAMP]</span></code> - Mirror or clamp to edge wrap mode.</li>
<li><code class="docutils literal"><span class="pre">BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]</span></code> - Point or anisotropic sampling.</li>
</ul>
</li>
</ul>
</dd>
</dl>
<div class="last highlight-python"><div class="highlight"><pre>- FrameBufferHandle bgfx::createFrameBuffer(BackbufferRatio::Enum, TextureFormat::Enum, uint64_t)
- FrameBufferHandle bgfx::createFrameBuffer(uint16_t, uint16_t, TextureFormat::Enum, uint64_t)
- FrameBufferHandle bgfx::createFrameBuffer(uint8_t, const Attachment *, bool)
- FrameBufferHandle bgfx::createFrameBuffer(uint8_t, const TextureHandle *, bool)
- FrameBufferHandle bgfx::createFrameBuffer(void *, uint16_t, uint16_t, TextureFormat::Enum, TextureFormat::Enum)
</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::createFrameBuffer&#8221; with arguments (BackbufferRatio::Enum, TextureFormat::Enum, uint32_t) 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>- FrameBufferHandle bgfx::createFrameBuffer(BackbufferRatio::Enum, TextureFormat::Enum, uint64_t)
- FrameBufferHandle bgfx::createFrameBuffer(uint16_t, uint16_t, TextureFormat::Enum, uint64_t)
- FrameBufferHandle bgfx::createFrameBuffer(uint8_t, const Attachment *, bool)
- FrameBufferHandle bgfx::createFrameBuffer(uint8_t, const TextureHandle *, bool)
- FrameBufferHandle bgfx::createFrameBuffer(void *, uint16_t, uint16_t, TextureFormat::Enum, TextureFormat::Enum)
</pre></div>
</div>
</div>
<dl class="function">
<dt id="_CPPv2N4bgfx17createFrameBufferE7uint8_tPK13TextureHandleb">
<span id="bgfx::createFrameBuffer__uint8_t.TextureHandleCP.b"></span><span class="target" id="namespacebgfx_1a24c15472da58c79e49b04cb8ed97a436"></span>FrameBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createFrameBuffer</code><span class="sig-paren">(</span>uint8_t <em>_num</em>, <em class="property">const</em> TextureHandle *<em>_handles</em>, bool <em>_destroyTextures</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferE7uint8_tPK13TextureHandleb" title="Permalink to this definition"></a></dt>
@@ -6177,29 +6124,19 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
</p>
</dd></dl>
<dl class="function">
<dt id="_CPPv2N4bgfx17createFrameBufferEPv8uint16_t8uint16_tN13TextureFormat4EnumE">
<span id="bgfx::createFrameBuffer__voidP.uint16_t.uint16_t.TextureFormat::Enum"></span><span class="target" id="namespacebgfx_1acb6883cf9094d49e7f1767f9e4b8a8b8"></span>FrameBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createFrameBuffer</code><span class="sig-paren">(</span>void *<em>_nwh</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_depthFormat</em> = TextureFormat::UnknownDepth<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferEPv8uint16_t8uint16_tN13TextureFormat4EnumE" title="Permalink to this definition"></a></dt>
<dd><p>Create frame buffer for multiple window rendering. </p>
<p><dl class="docutils">
<dt><strong>Return</strong></dt>
<dd>Handle to frame buffer object.</dd>
<dt><strong>Remark</strong></dt>
<dd>Frame buffer cannot be used for sampling.</dd>
<dt><strong>Attention</strong></dt>
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_frame_buffer_from_nwh</span></code>. </dd>
<dt><strong>Parameters</strong></dt>
<dd><ul class="breatheparameterlist first last simple">
<li><code class="docutils literal"><span class="pre">_nwh</span></code>: OS&#8217; target native window handle. </li>
<li><code class="docutils literal"><span class="pre">_width</span></code>: Window back buffer width. </li>
<li><code class="docutils literal"><span class="pre">_height</span></code>: Window back buffer height. </li>
<li><code class="docutils literal"><span class="pre">_depthFormat</span></code>: Window back buffer depth format.</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::createFrameBuffer&#8221; with arguments (void *, uint16_t, uint16_t, TextureFormat::Enum) 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>- FrameBufferHandle bgfx::createFrameBuffer(BackbufferRatio::Enum, TextureFormat::Enum, uint64_t)
- FrameBufferHandle bgfx::createFrameBuffer(uint16_t, uint16_t, TextureFormat::Enum, uint64_t)
- FrameBufferHandle bgfx::createFrameBuffer(uint8_t, const Attachment *, bool)
- FrameBufferHandle bgfx::createFrameBuffer(uint8_t, const TextureHandle *, bool)
- FrameBufferHandle bgfx::createFrameBuffer(void *, uint16_t, uint16_t, TextureFormat::Enum, TextureFormat::Enum)
</pre></div>
</div>
</div>
<dl class="class">
<dt id="_CPPv2N4bgfx10AttachmentE">
<span id="bgfx::Attachment"></span><span class="target" id="structbgfx_1_1_attachment"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Attachment</code><a class="headerlink" href="#_CPPv2N4bgfx10AttachmentE" title="Permalink to this definition"></a></dt>

18
genindex.html
View File

@@ -537,7 +537,7 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx17createFrameBufferE7uint8_tPK10Attachmentb">bgfx::createFrameBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx17createFrameBufferE7uint8_tPK13TextureHandleb">[1]</a>, <a href="bgfx.html#_CPPv2N4bgfx17createFrameBufferE8uint16_t8uint16_tN13TextureFormat4EnumE8uint32_t">[2]</a>, <a href="bgfx.html#_CPPv2N4bgfx17createFrameBufferEN15BackbufferRatio4EnumEN13TextureFormat4EnumE8uint32_t">[3]</a>, <a href="bgfx.html#_CPPv2N4bgfx17createFrameBufferEPv8uint16_t8uint16_tN13TextureFormat4EnumE">[4]</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx17createFrameBufferE7uint8_tPK10Attachmentb">bgfx::createFrameBuffer (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx17createFrameBufferE7uint8_tPK13TextureHandleb">[1]</a>
</dt>
@@ -561,19 +561,15 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx13createTextureEPK6Memory8uint32_t7uint8_tP11TextureInfo">bgfx::createTexture (C++ function)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx13createTextureEPK6Memory8uint64_t7uint8_tP11TextureInfo">bgfx::createTexture (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx15createTexture2DE8uint16_t8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_tPK6Memory">bgfx::createTexture2D (C++ function)</a>, <a href="bgfx.html#_CPPv2N4bgfx15createTexture2DEN15BackbufferRatio4EnumEb8uint16_tN13TextureFormat4EnumE8uint32_t">[1]</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_tbN13TextureFormat4EnumE8uint64_tPK6Memory">bgfx::createTexture3D (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_tbN13TextureFormat4EnumE8uint32_tPK6Memory">bgfx::createTexture3D (C++ function)</a>
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx17createTextureCubeE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_tPK6Memory">bgfx::createTextureCube (C++ function)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx17createTextureCubeE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_tPK6Memory">bgfx::createTextureCube (C++ function)</a>
</dt>
@@ -821,7 +817,7 @@
</dt>
<dt><a href="bgfx.html#_CPPv2N4bgfx14isTextureValidE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint32_t">bgfx::isTextureValid (C++ function)</a>
<dt><a href="bgfx.html#_CPPv2N4bgfx14isTextureValidE8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_t">bgfx::isTextureValid (C++ function)</a>
</dt>
@@ -1104,12 +1100,12 @@
<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>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx5Stats6heightE">bgfx::Stats::height (C++ member)</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