6976 lines
510 KiB
HTML
6976 lines
510 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>API Reference — bgfx 1.0 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="top" title="bgfx 1.0 documentation" href="index.html"/>
|
||
<link rel="next" title="Tools" href="tools.html"/>
|
||
<link rel="prev" title="Examples" href="examples.html"/>
|
||
|
||
|
||
<script src="_static/js/modernizr.min.js"></script>
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav" role="document">
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search">
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> bgfx
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
1.0
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="">API Reference</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#general">General</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#initialization-and-shutdown">Initialization and Shutdown</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#updating">Updating</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#reset">Reset</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#frame">Frame</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#debug">Debug</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#debug-features">Debug Features</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#debug-flags">Debug Flags</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#debug-text-display">Debug Text Display</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#querying-information">Querying information</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#renderer">Renderer</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#capabilities">Capabilities</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#statistics">Statistics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#platform-specific">Platform specific</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#miscellaneous">Miscellaneous</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#views">Views</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#encoder">Encoder</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id1">Encoder</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#draw">Draw</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id2">Debug</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#state">State</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#state-flags">State Flags</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#stencil">Stencil</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#stencil-flags">Stencil Flags</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#scissor">Scissor</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#transform">Transform</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#conditional-rendering">Conditional Rendering</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#compute">Compute</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#blit">Blit</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#resources">Resources</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#shaders-and-programs">Shaders and Programs</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#uniforms">Uniforms</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#vertex-buffers">Vertex Buffers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#index-buffers">Index Buffers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#textures">Textures</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#frame-buffers">Frame Buffers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#instance-buffer">Instance Buffer</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#indirect-buffer">Indirect Buffer</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#occlusion-query">Occlusion Query</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tools.html">Tools</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">bgfx</a>
|
||
</nav>
|
||
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li>API Reference</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="api-reference">
|
||
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="general">
|
||
<h2>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h2>
|
||
<div class="section" id="initialization-and-shutdown">
|
||
<h3>Initialization and Shutdown<a class="headerlink" href="#initialization-and-shutdown" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx4InitE">
|
||
<span id="bgfx::Init"></span><span class="target" id="structbgfx_1_1_init"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Init</code><a class="headerlink" href="#_CPPv2N4bgfx4InitE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initialization parameters used by <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1adbfa8f1399b23ba0bedeaea92441642b"><span><span class="pre">bgfx::init</span></span></a></code>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_init_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init4typeE">
|
||
<span id="bgfx::Init::type__RendererType::Enum"></span><span class="target" id="structbgfx_1_1_init_1a7f399f062439826992e17e095837efa3"></span><a class="reference internal" href="#_CPPv2N4bgfx12RendererTypeE" title="bgfx::RendererType">RendererType</a>::<a class="reference internal" href="#_CPPv2N4bgfx12RendererType4EnumE" title="bgfx::RendererType::Enum">Enum</a> <code class="descname">type</code><a class="headerlink" href="#_CPPv2N4bgfx4Init4typeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Select rendering backend. When set to RendererType::Count a default rendering backend will be selected appropriate to the platform. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_renderer_type"><span><span class="pre">bgfx::RendererType</span></span></a></code> </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init8vendorIdE">
|
||
<span id="bgfx::Init::vendorId__uint16_t"></span><span class="target" id="structbgfx_1_1_init_1a95acf1a68426ecd7192d6cdf93e02e83"></span>uint16_t <code class="descname">vendorId</code><a class="headerlink" href="#_CPPv2N4bgfx4Init8vendorIdE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vendor PCI id. If set to <code class="docutils literal"><span class="pre">BGFX_PCI_ID_NONE</span></code> it will select the first device. </p>
|
||
<p><ul class="simple">
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_NONE</span></code> - Autoselect adapter.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_SOFTWARE_RASTERIZER</span></code> - Software rasterizer.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_AMD</span></code> - AMD adapter.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_INTEL</span></code> - Intel adapter.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_NVIDIA</span></code> - nVidia adapter. </li>
|
||
</ul>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init8deviceIdE">
|
||
<span id="bgfx::Init::deviceId__uint16_t"></span><span class="target" id="structbgfx_1_1_init_1a60ff2d3dd1ccdae79ef96a62eb1bf5e0"></span>uint16_t <code class="descname">deviceId</code><a class="headerlink" href="#_CPPv2N4bgfx4Init8deviceIdE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device id. If set to 0 it will select first device, or device with matching id. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init5debugE">
|
||
<span id="bgfx::Init::debug__b"></span><span class="target" id="structbgfx_1_1_init_1a3fc874cff90fe5c279356e92a306f022"></span>bool <code class="descname">debug</code><a class="headerlink" href="#_CPPv2N4bgfx4Init5debugE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable device for debuging. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init7profileE">
|
||
<span id="bgfx::Init::profile__b"></span><span class="target" id="structbgfx_1_1_init_1a5cf66d060d59a5e1e55147e3d75d32fe"></span>bool <code class="descname">profile</code><a class="headerlink" href="#_CPPv2N4bgfx4Init7profileE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable device for profiling. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init12platformDataE">
|
||
<span id="bgfx::Init::platformData__PlatformData"></span><span class="target" id="structbgfx_1_1_init_1a45c9bd57be8ff9a4ecd1fc180d8526c9"></span><a class="reference internal" href="#_CPPv2N4bgfx12PlatformDataE" title="bgfx::PlatformData">PlatformData</a> <code class="descname">platformData</code><a class="headerlink" href="#_CPPv2N4bgfx4Init12platformDataE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Platform data. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init10resolutionE">
|
||
<span id="bgfx::Init::resolution__Resolution"></span><span class="target" id="structbgfx_1_1_init_1a12f9e2f7f7a8514e1bd58a8aee137b1a"></span><a class="reference internal" href="#_CPPv2N4bgfx10ResolutionE" title="bgfx::Resolution">Resolution</a> <code class="descname">resolution</code><a class="headerlink" href="#_CPPv2N4bgfx4Init10resolutionE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer resolution and reset parameters. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_resolution"><span><span class="pre">bgfx::Resolution</span></span></a></code>. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init8callbackE">
|
||
<span id="bgfx::Init::callback__CallbackIP"></span><span class="target" id="structbgfx_1_1_init_1ae9d15764a47018bbe634615fff85ffd9"></span><a class="reference internal" href="#_CPPv2N4bgfx9CallbackIE" title="bgfx::CallbackI">CallbackI</a> *<code class="descname">callback</code><a class="headerlink" href="#_CPPv2N4bgfx4Init8callbackE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Provide application specific callback interface. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_callback_i"><span><span class="pre">bgfx::CallbackI</span></span></a></code> </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init9allocatorE">
|
||
<span id="bgfx::Init::allocator__bx::AllocatorIP"></span><span class="target" id="structbgfx_1_1_init_1a68cecb542d9c6d5bd6de99427e00bccd"></span>bx::AllocatorI *<code class="descname">allocator</code><a class="headerlink" href="#_CPPv2N4bgfx4Init9allocatorE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Custom allocator. When a custom allocator is not specified, bgfx uses the CRT allocator. Bgfx assumes custom allocator is thread safe. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx4Init6LimitsE">
|
||
<span id="bgfx::Init::Limits"></span><span class="target" id="structbgfx_1_1_init_1_1_limits"></span><em class="property">struct </em><code class="descname">Limits</code><a class="headerlink" href="#_CPPv2N4bgfx4Init6LimitsE" 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="_CPPv2N4bgfx4Init6Limits11maxEncodersE">
|
||
<span id="bgfx::Init::Limits::maxEncoders__uint16_t"></span><span class="target" id="structbgfx_1_1_init_1_1_limits_1ab5612e1f4040bfafdc409f09cc1b38d1"></span>uint16_t <code class="descname">maxEncoders</code><a class="headerlink" href="#_CPPv2N4bgfx4Init6Limits11maxEncodersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of encoder threads. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init6Limits15transientVbSizeE">
|
||
<span id="bgfx::Init::Limits::transientVbSize__uint32_t"></span><span class="target" id="structbgfx_1_1_init_1_1_limits_1a39d39b44ef980d707bc46f31f9f9eb45"></span>uint32_t <code class="descname">transientVbSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Init6Limits15transientVbSizeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum transient vertex buffer size. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Init6Limits15transientIbSizeE">
|
||
<span id="bgfx::Init::Limits::transientIbSize__uint32_t"></span><span class="target" id="structbgfx_1_1_init_1_1_limits_1a6665ec7e87e4078fec9937d83449d9c9"></span>uint32_t <code class="descname">transientIbSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Init6Limits15transientIbSizeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum transient index buffer size. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx10ResolutionE">
|
||
<span id="bgfx::Resolution"></span><span class="target" id="structbgfx_1_1_resolution"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Resolution</code><a class="headerlink" href="#_CPPv2N4bgfx10ResolutionE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer resolution and reset parameters. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_resolution_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Resolution6formatE">
|
||
<span id="bgfx::Resolution::format__TextureFormat::Enum"></span><span class="target" id="structbgfx_1_1_resolution_1a3781358001b210ea4ca4118d9a9df6ce"></span><a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <code class="descname">format</code><a class="headerlink" href="#_CPPv2N4bgfx10Resolution6formatE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer format. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Resolution5widthE">
|
||
<span id="bgfx::Resolution::width__uint32_t"></span><span class="target" id="structbgfx_1_1_resolution_1ad310354c75d3b7319ecfeb637b8755d6"></span>uint32_t <code class="descname">width</code><a class="headerlink" href="#_CPPv2N4bgfx10Resolution5widthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer width. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Resolution6heightE">
|
||
<span id="bgfx::Resolution::height__uint32_t"></span><span class="target" id="structbgfx_1_1_resolution_1a08cb2efb1e931b334bfbf376a8aa9198"></span>uint32_t <code class="descname">height</code><a class="headerlink" href="#_CPPv2N4bgfx10Resolution6heightE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer height. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Resolution5resetE">
|
||
<span id="bgfx::Resolution::reset__uint32_t"></span><span class="target" id="structbgfx_1_1_resolution_1a312be1875802ea5a0b09aafb1f99e1cd"></span>uint32_t <code class="descname">reset</code><a class="headerlink" href="#_CPPv2N4bgfx10Resolution5resetE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reset parameters. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Resolution14numBackBuffersE">
|
||
<span id="bgfx::Resolution::numBackBuffers__uint8_t"></span><span class="target" id="structbgfx_1_1_resolution_1a12a5dd8b75d88438a2d0b75ad90cef97"></span>uint8_t <code class="descname">numBackBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx10Resolution14numBackBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of back buffers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Resolution15maxFrameLatencyE">
|
||
<span id="bgfx::Resolution::maxFrameLatency__uint8_t"></span><span class="target" id="structbgfx_1_1_resolution_1a3e7f134dc8917547a41a83946311e4fe"></span>uint8_t <code class="descname">maxFrameLatency</code><a class="headerlink" href="#_CPPv2N4bgfx10Resolution15maxFrameLatencyE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum frame latency. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4initERK4Init">
|
||
<span id="bgfx::init__InitCR"></span><span class="target" id="namespacebgfx_1adbfa8f1399b23ba0bedeaea92441642b"></span>bool <code class="descclassname">bgfx::</code><code class="descname">init</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx4InitE" title="bgfx::Init">Init</a> &<em>_init</em> = {}<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4initERK4Init" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initialize bgfx library. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd><code class="docutils literal"><span class="pre">true</span></code> if initialization was successful.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_init</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_init</span></code>: Initialization parameters. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_init"><span><span class="pre">bgfx::Init</span></span></a></code> for more info.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_PCI_ID_NONE">
|
||
<span class="target" id="defines_8h_1a92e8db81cd0b751a6abecfd7c1977b61"></span><code class="descname">BGFX_PCI_ID_NONE</code><a class="headerlink" href="#c.BGFX_PCI_ID_NONE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Autoselect adapter. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_PCI_ID_SOFTWARE_RASTERIZER">
|
||
<span class="target" id="defines_8h_1af687d309fb08a21af41cb61dcc17663f"></span><code class="descname">BGFX_PCI_ID_SOFTWARE_RASTERIZER</code><a class="headerlink" href="#c.BGFX_PCI_ID_SOFTWARE_RASTERIZER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Software rasterizer. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_PCI_ID_AMD">
|
||
<span class="target" id="defines_8h_1a98a003376c4fac2e111a2778578660cb"></span><code class="descname">BGFX_PCI_ID_AMD</code><a class="headerlink" href="#c.BGFX_PCI_ID_AMD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>AMD adapter. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_PCI_ID_INTEL">
|
||
<span class="target" id="defines_8h_1a2f3ca85ec971d2a6e98f63b60de61755"></span><code class="descname">BGFX_PCI_ID_INTEL</code><a class="headerlink" href="#c.BGFX_PCI_ID_INTEL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Intel adapter. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_PCI_ID_NVIDIA">
|
||
<span class="target" id="defines_8h_1a19a4997d1bcf83055bfd3bf8274b593b"></span><code class="descname">BGFX_PCI_ID_NVIDIA</code><a class="headerlink" href="#c.BGFX_PCI_ID_NVIDIA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>nVidia adapter. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx9CallbackIE">
|
||
<span id="bgfx::CallbackI"></span><span class="target" id="structbgfx_1_1_callback_i"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">CallbackI</code><a class="headerlink" href="#_CPPv2N4bgfx9CallbackIE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Callback interface to implement application specific behavior. Cached items are currently used for OpenGL and Direct3D 12 binary shaders. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>‘fatal’ and ‘trace’ callbacks can be called from any thread. Other callbacks are called from the render thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_interface_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Functions</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI5fatalEPKc8uint16_tN5Fatal4EnumEPKc">
|
||
<span id="bgfx::CallbackI::fatal__cCP.uint16_t.Fatal::Enum.cCP"></span><span class="target" id="structbgfx_1_1_callback_i_1af6da8564f008e91fddf441175d18850b"></span><em class="property">virtual</em> void <code class="descname">fatal</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_filePath</em>, uint16_t <em>_line</em>, Fatal::Enum <em>_code</em>, <em class="property">const</em> char *<em>_str</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI5fatalEPKc8uint16_tN5Fatal4EnumEPKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This callback is called on unrecoverable errors. It’s not safe to continue (Exluding _code <code class="docutils literal"><span class="pre">Fatal::DebugCheck</span></code>), inform the user and terminate the application. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Not thread safe and it can be called from any thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.fatal</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_filePath</span></code>: File path where fatal message was generated. </li>
|
||
<li><code class="docutils literal"><span class="pre">_line</span></code>: Line where fatal message was generated. </li>
|
||
<li><code class="docutils literal"><span class="pre">_code</span></code>: Fatal error code. </li>
|
||
<li><code class="docutils literal"><span class="pre">_str</span></code>: More information about error.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI10traceVargsEPKc8uint16_tPKc7va_list">
|
||
<span id="bgfx::CallbackI::traceVargs__cCP.uint16_t.cCP.va_list"></span><span class="target" id="structbgfx_1_1_callback_i_1a55bde1947f1347a2c9360824d08314da"></span><em class="property">virtual</em> void <code class="descname">traceVargs</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_filePath</em>, uint16_t <em>_line</em>, <em class="property">const</em> char *<em>_format</em>, va_list <em>_argList</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI10traceVargsEPKc8uint16_tPKc7va_list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Print debug message. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Not thread safe and it can be called from any thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.trace_vargs</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_filePath</span></code>: File path where debug message was generated. </li>
|
||
<li><code class="docutils literal"><span class="pre">_line</span></code>: Line where debug message was generated. </li>
|
||
<li><code class="docutils literal"><span class="pre">_format</span></code>: <code class="docutils literal"><span class="pre">printf</span></code> style format. </li>
|
||
<li><code class="docutils literal"><span class="pre">_argList</span></code>: Variable arguments list initialized with <code class="docutils literal"><span class="pre">va_start</span></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI13profilerBeginEPKc8uint32_tPKc8uint16_t">
|
||
<span id="bgfx::CallbackI::profilerBegin__cCP.uint32_t.cCP.uint16_t"></span><span class="target" id="structbgfx_1_1_callback_i_1a3bd1177a4621524bd90da103ca3417de"></span><em class="property">virtual</em> void <code class="descname">profilerBegin</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_name</em>, uint32_t <em>_abgr</em>, <em class="property">const</em> char *<em>_filePath</em>, uint16_t <em>_line</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI13profilerBeginEPKc8uint32_tPKc8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Profiler region begin. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Not thread safe and it can be called from any thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.profiler_begin</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_name</span></code>: Region name, contains dynamic string. </li>
|
||
<li><code class="docutils literal"><span class="pre">_abgr</span></code>: Color of profiler region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_filePath</span></code>: File path where <code class="docutils literal"><span class="pre">profilerBegin</span></code> was called. </li>
|
||
<li><code class="docutils literal"><span class="pre">_line</span></code>: Line where <code class="docutils literal"><span class="pre">profilerBegin</span></code> was called.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI20profilerBeginLiteralEPKc8uint32_tPKc8uint16_t">
|
||
<span id="bgfx::CallbackI::profilerBeginLiteral__cCP.uint32_t.cCP.uint16_t"></span><span class="target" id="structbgfx_1_1_callback_i_1a4a2875d0cf4a47e4c22df25f0b4d041b"></span><em class="property">virtual</em> void <code class="descname">profilerBeginLiteral</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_name</em>, uint32_t <em>_abgr</em>, <em class="property">const</em> char *<em>_filePath</em>, uint16_t <em>_line</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI20profilerBeginLiteralEPKc8uint32_tPKc8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Profiler region begin with string literal name. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Not thread safe and it can be called from any thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.profiler_begin_literal</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_name</span></code>: Region name, contains string literal. </li>
|
||
<li><code class="docutils literal"><span class="pre">_abgr</span></code>: Color of profiler region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_filePath</span></code>: File path where <code class="docutils literal"><span class="pre">profilerBeginLiteral</span></code> was called. </li>
|
||
<li><code class="docutils literal"><span class="pre">_line</span></code>: Line where <code class="docutils literal"><span class="pre">profilerBeginLiteral</span></code> was called.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI11profilerEndEv">
|
||
<span id="bgfx::CallbackI::profilerEnd"></span><span class="target" id="structbgfx_1_1_callback_i_1ac0d86e638d8af10bd5792a3aac3b82b5"></span><em class="property">virtual</em> void <code class="descname">profilerEnd</code><span class="sig-paren">(</span><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI11profilerEndEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Profiler region end. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Not thread safe and it can be called from any thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.profiler_end</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI13cacheReadSizeE8uint64_t">
|
||
<span id="bgfx::CallbackI::cacheReadSize__uint64_t"></span><span class="target" id="structbgfx_1_1_callback_i_1a0e42c49e7a21b94a8866f4ad0e76a317"></span><em class="property">virtual</em> uint32_t <code class="descname">cacheReadSize</code><span class="sig-paren">(</span>uint64_t <em>_id</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI13cacheReadSizeE8uint64_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the size of a cached item. Returns 0 if no cached item was found. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Number of bytes to read.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.cache_read_size</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: Cache id. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI9cacheReadE8uint64_tPv8uint32_t">
|
||
<span id="bgfx::CallbackI::cacheRead__uint64_t.voidP.uint32_t"></span><span class="target" id="structbgfx_1_1_callback_i_1a37f081ba5631e93449e64886190d5c90"></span><em class="property">virtual</em> bool <code class="descname">cacheRead</code><span class="sig-paren">(</span>uint64_t <em>_id</em>, void *<em>_data</em>, uint32_t <em>_size</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI9cacheReadE8uint64_tPv8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read cached item. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>True if data is read.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.cache_read</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: Cache id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Buffer where to read data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_size</span></code>: Size of data to read.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI10cacheWriteE8uint64_tPKv8uint32_t">
|
||
<span id="bgfx::CallbackI::cacheWrite__uint64_t.voidCP.uint32_t"></span><span class="target" id="structbgfx_1_1_callback_i_1af4cf9d4f3ce9d5280a5f6cd0cd78600e"></span><em class="property">virtual</em> void <code class="descname">cacheWrite</code><span class="sig-paren">(</span>uint64_t <em>_id</em>, <em class="property">const</em> void *<em>_data</em>, uint32_t <em>_size</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI10cacheWriteE8uint64_tPKv8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Write cached item. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.cache_write</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: Cache id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Data to write. </li>
|
||
<li><code class="docutils literal"><span class="pre">_size</span></code>: Size of data to write.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI10screenShotEPKc8uint32_t8uint32_t8uint32_tPKv8uint32_tb">
|
||
<span id="bgfx::CallbackI::screenShot__cCP.uint32_t.uint32_t.uint32_t.voidCP.uint32_t.b"></span><span class="target" id="structbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"></span><em class="property">virtual</em> void <code class="descname">screenShot</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_filePath</em>, uint32_t <em>_width</em>, uint32_t <em>_height</em>, uint32_t <em>_pitch</em>, <em class="property">const</em> void *<em>_data</em>, uint32_t <em>_size</em>, bool <em>_yflip</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI10screenShotEPKc8uint32_t8uint32_t8uint32_tPKv8uint32_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Screenshot captured. Screenshot format is always 4-byte BGRA. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.screen_shot</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_filePath</span></code>: File path. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Image width. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Image height. </li>
|
||
<li><code class="docutils literal"><span class="pre">_pitch</span></code>: Number of bytes to skip between the start of each horizontal line of the image. </li>
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Image data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_size</span></code>: Image size. </li>
|
||
<li><code class="docutils literal"><span class="pre">_yflip</span></code>: If true, image origin is bottom left.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI12captureBeginE8uint32_t8uint32_t8uint32_tN13TextureFormat4EnumEb">
|
||
<span id="bgfx::CallbackI::captureBegin__uint32_t.uint32_t.uint32_t.TextureFormat::Enum.b"></span><span class="target" id="structbgfx_1_1_callback_i_1afbf52f537e1bf54a4c20f6efb2654231"></span><em class="property">virtual</em> void <code class="descname">captureBegin</code><span class="sig-paren">(</span>uint32_t <em>_width</em>, uint32_t <em>_height</em>, uint32_t <em>_pitch</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>, bool <em>_yflip</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI12captureBeginE8uint32_t8uint32_t8uint32_tN13TextureFormat4EnumEb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called when a video capture begins. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.capture_begin</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>: Image width. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Image height. </li>
|
||
<li><code class="docutils literal"><span class="pre">_pitch</span></code>: Number of bytes to skip between the start of each horizontal line of the image. </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">_yflip</span></code>: If true, image origin is bottom left.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI10captureEndEv">
|
||
<span id="bgfx::CallbackI::captureEnd"></span><span class="target" id="structbgfx_1_1_callback_i_1af4a233dccba408ad9c0c1fa3a8491c4b"></span><em class="property">virtual</em> void <code class="descname">captureEnd</code><span class="sig-paren">(</span><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI10captureEndEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called when a video capture ends. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.capture_end</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI12captureFrameEPKv8uint32_t">
|
||
<span id="bgfx::CallbackI::captureFrame__voidCP.uint32_t"></span><span class="target" id="structbgfx_1_1_callback_i_1a02b34e3ca8968184330c8247984c2365"></span><em class="property">virtual</em> void <code class="descname">captureFrame</code><span class="sig-paren">(</span><em class="property">const</em> void *<em>_data</em>, uint32_t <em>_size</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI12captureFrameEPKv8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Captured frame. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_callback_vtbl.capture_frame</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Image data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_size</span></code>: Image size.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8shutdownEv">
|
||
<span id="bgfx::shutdown"></span><span class="target" id="namespacebgfx_1a9611ce9146bff25f2846b7e85c83cc99"></span>void <code class="descclassname">bgfx::</code><code class="descname">shutdown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8shutdownEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Shutdown bgfx library. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_shutdown</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="updating">
|
||
<h3>Updating<a class="headerlink" href="#updating" title="Permalink to this headline">¶</a></h3>
|
||
<div class="section" id="reset">
|
||
<h4>Reset<a class="headerlink" href="#reset" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx5resetE8uint32_t8uint32_t8uint32_tN13TextureFormat4EnumE">
|
||
<span id="bgfx::reset__uint32_t.uint32_t.uint32_t.TextureFormat::Enum"></span><span class="target" id="namespacebgfx_1acbf49c89c8ed64ac2ce9fbb08a52f7ab"></span>void <code class="descclassname">bgfx::</code><code class="descname">reset</code><span class="sig-paren">(</span>uint32_t <em>_width</em>, uint32_t <em>_height</em>, uint32_t <em>_flags</em> = BGFX_RESET_NONE, <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> = TextureFormat::Count<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5resetE8uint32_t8uint32_t8uint32_tN13TextureFormat4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reset graphic settings and back-buffer size. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>This call doesn’t actually change window size, it just resizes back-buffer. Windowing code has to change window size.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_reset</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>: Back-buffer width. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Back-buffer height. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: See: <code class="docutils literal"><span class="pre">BGFX_RESET_*</span></code> for more info.<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_NONE</span></code> - No reset flags.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_FULLSCREEN</span></code> - Not supported yet.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_MSAA_X[2/4/8/16]</span></code> - Enable 2, 4, 8 or 16 x MSAA.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_VSYNC</span></code> - Enable V-Sync.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_MAXANISOTROPY</span></code> - Turn on/off max anisotropy.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_CAPTURE</span></code> - Begin screen capture.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_FLUSH_AFTER_RENDER</span></code> - Flush rendering after submitting to GPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_FLIP_AFTER_RENDER</span></code> - This flag specifies where flip occurs. Default behavior is that flip occurs before rendering new frame. This flag only has effect when <code class="docutils literal"><span class="pre">BGFX_CONFIG_MULTITHREADED=0</span></code>.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_SRGB_BACKBUFFER</span></code> - Enable sRGB backbuffer. </li>
|
||
</ul>
|
||
</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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_NONE">
|
||
<span class="target" id="defines_8h_1ab4f97fa0a40e27db79f7a778c3da268f"></span><code class="descname">BGFX_RESET_NONE</code><a class="headerlink" href="#c.BGFX_RESET_NONE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>No reset flags. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_FULLSCREEN">
|
||
<span class="target" id="defines_8h_1a7a573880db4afc7107e36ea61dc36586"></span><code class="descname">BGFX_RESET_FULLSCREEN</code><a class="headerlink" href="#c.BGFX_RESET_FULLSCREEN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Not supported yet. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_MSAA_X2">
|
||
<span class="target" id="defines_8h_1a11369bfec092c6aecb55c344696cffa8"></span><code class="descname">BGFX_RESET_MSAA_X2</code><a class="headerlink" href="#c.BGFX_RESET_MSAA_X2" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable 2x MSAA. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_MSAA_X4">
|
||
<span class="target" id="defines_8h_1a6288443c87929696f539c60245b59acb"></span><code class="descname">BGFX_RESET_MSAA_X4</code><a class="headerlink" href="#c.BGFX_RESET_MSAA_X4" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable 4x MSAA. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_MSAA_X8">
|
||
<span class="target" id="defines_8h_1a0d9452be0acc82cd9b0921b061abe007"></span><code class="descname">BGFX_RESET_MSAA_X8</code><a class="headerlink" href="#c.BGFX_RESET_MSAA_X8" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable 8x MSAA. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_MSAA_X16">
|
||
<span class="target" id="defines_8h_1a7fc0d9a43da20edb2670854c393127c7"></span><code class="descname">BGFX_RESET_MSAA_X16</code><a class="headerlink" href="#c.BGFX_RESET_MSAA_X16" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable 16x MSAA. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_VSYNC">
|
||
<span class="target" id="defines_8h_1abe5909f7f2d02137660385500409ffd5"></span><code class="descname">BGFX_RESET_VSYNC</code><a class="headerlink" href="#c.BGFX_RESET_VSYNC" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable V-Sync. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_MAXANISOTROPY">
|
||
<span class="target" id="defines_8h_1a94fe821218b7426466f11acf3925a629"></span><code class="descname">BGFX_RESET_MAXANISOTROPY</code><a class="headerlink" href="#c.BGFX_RESET_MAXANISOTROPY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Turn on/off max anisotropy. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_CAPTURE">
|
||
<span class="target" id="defines_8h_1a3342824f93a57411568f665744c1a515"></span><code class="descname">BGFX_RESET_CAPTURE</code><a class="headerlink" href="#c.BGFX_RESET_CAPTURE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Begin screen capture. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_FLUSH_AFTER_RENDER">
|
||
<span class="target" id="defines_8h_1ae01ca78b058a1f7bf2358d61f7b52b03"></span><code class="descname">BGFX_RESET_FLUSH_AFTER_RENDER</code><a class="headerlink" href="#c.BGFX_RESET_FLUSH_AFTER_RENDER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Flush rendering after submitting to GPU. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_FLIP_AFTER_RENDER">
|
||
<span class="target" id="defines_8h_1a1685b3f0489fc8465f3d3c5b70424e38"></span><code class="descname">BGFX_RESET_FLIP_AFTER_RENDER</code><a class="headerlink" href="#c.BGFX_RESET_FLIP_AFTER_RENDER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This flag specifies where flip occurs. Default behavior is that flip occurs before rendering new frame. This flag only has effect when <code class="docutils literal"><span class="pre">BGFX_CONFIG_MULTITHREADED=0</span></code>. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_SRGB_BACKBUFFER">
|
||
<span class="target" id="defines_8h_1a74813007bb4401a669842d101bc5da25"></span><code class="descname">BGFX_RESET_SRGB_BACKBUFFER</code><a class="headerlink" href="#c.BGFX_RESET_SRGB_BACKBUFFER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable sRGB backbuffer. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_HDR10">
|
||
<span class="target" id="defines_8h_1a970807be2daa1b810791647ed61371b2"></span><code class="descname">BGFX_RESET_HDR10</code><a class="headerlink" href="#c.BGFX_RESET_HDR10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable HDR10 rendering. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_HIDPI">
|
||
<span class="target" id="defines_8h_1a8d31334677672b6a92ea3a17110194fa"></span><code class="descname">BGFX_RESET_HIDPI</code><a class="headerlink" href="#c.BGFX_RESET_HIDPI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable HiDPI rendering. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_DEPTH_CLAMP">
|
||
<span class="target" id="defines_8h_1af06b6eb7e824929310fd5fb2b2a5e7c4"></span><code class="descname">BGFX_RESET_DEPTH_CLAMP</code><a class="headerlink" href="#c.BGFX_RESET_DEPTH_CLAMP" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth clamp. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="frame">
|
||
<h4>Frame<a class="headerlink" href="#frame" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx5frameEb">
|
||
<span id="bgfx::frame__b"></span><span class="target" id="namespacebgfx_1a7b228b3e83595148e428a248d73480e8"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">frame</code><span class="sig-paren">(</span>bool <em>_capture</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5frameEb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Advance to next frame. When using multithreaded renderer, this call just swaps internal buffers, kicks render thread, and returns. In singlethreaded renderer this call does frame rendering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Current frame number. This might be used in conjunction with double/multi buffering data outside the library and passing it to library via <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span><span class="pre">bgfx::makeRef</span></span></a></code> calls.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_frame</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_capture</span></code>: Capture frame with graphics debugger.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="debug">
|
||
<h3>Debug<a class="headerlink" href="#debug" title="Permalink to this headline">¶</a></h3>
|
||
<div class="section" id="debug-features">
|
||
<h4>Debug Features<a class="headerlink" href="#debug-features" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8setDebugE8uint32_t">
|
||
<span id="bgfx::setDebug__uint32_t"></span><span class="target" id="namespacebgfx_1ae785eb08ff2f48a96b84d2a37cb6f594"></span>void <code class="descclassname">bgfx::</code><code class="descname">setDebug</code><span class="sig-paren">(</span>uint32_t <em>_debug</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8setDebugE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set debug flags. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_debug</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_debug</span></code>: Available flags:<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_DEBUG_IFH</span></code> - Infinitely fast hardware. When this flag is set all rendering calls will be skipped. This is useful when profiling to quickly assess potential bottlenecks between CPU and GPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_DEBUG_PROFILER</span></code> - Enable profiler.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_DEBUG_STATS</span></code> - Display internal statistics.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_DEBUG_TEXT</span></code> - Display debug text.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_DEBUG_WIREFRAME</span></code> - Wireframe rendering. All rendering primitives will be rendered as lines.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="debug-flags">
|
||
<h4>Debug Flags<a class="headerlink" href="#debug-flags" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_DEBUG_NONE">
|
||
<span class="target" id="defines_8h_1abcdfdffe5c52e7ff366087466c515ea5"></span><code class="descname">BGFX_DEBUG_NONE</code><a class="headerlink" href="#c.BGFX_DEBUG_NONE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>No debug. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_DEBUG_WIREFRAME">
|
||
<span class="target" id="defines_8h_1ae489c12ff4b561a2f68ddb0bf727049c"></span><code class="descname">BGFX_DEBUG_WIREFRAME</code><a class="headerlink" href="#c.BGFX_DEBUG_WIREFRAME" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable wireframe for all primitives. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_DEBUG_IFH">
|
||
<span class="target" id="defines_8h_1a01a6722a2d1b1c1948b44191b2dddf48"></span><code class="descname">BGFX_DEBUG_IFH</code><a class="headerlink" href="#c.BGFX_DEBUG_IFH" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable infinitely fast hardware test. No draw calls will be submitted to driver. It’s useful when profiling to quickly assess bottleneck between CPU and GPU. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_DEBUG_STATS">
|
||
<span class="target" id="defines_8h_1a337fe1eece8a5d2c6c8e4067541d84b8"></span><code class="descname">BGFX_DEBUG_STATS</code><a class="headerlink" href="#c.BGFX_DEBUG_STATS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable statistics display. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_DEBUG_TEXT">
|
||
<span class="target" id="defines_8h_1a3a0974b7626334233233d24027b7fd8a"></span><code class="descname">BGFX_DEBUG_TEXT</code><a class="headerlink" href="#c.BGFX_DEBUG_TEXT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable debug text display. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_DEBUG_PROFILER">
|
||
<span class="target" id="defines_8h_1a35d04d76460ad35cf1c9b3926b4267bb"></span><code class="descname">BGFX_DEBUG_PROFILER</code><a class="headerlink" href="#c.BGFX_DEBUG_PROFILER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable profiler. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="debug-text-display">
|
||
<h4>Debug Text Display<a class="headerlink" href="#debug-text-display" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12dbgTextClearE7uint8_tb">
|
||
<span id="bgfx::dbgTextClear__uint8_t.b"></span><span class="target" id="namespacebgfx_1ac7c16eafe7657464ed6fef8eca0c4c2a"></span>void <code class="descclassname">bgfx::</code><code class="descname">dbgTextClear</code><span class="sig-paren">(</span>uint8_t <em>_attr</em> = 0, bool <em>_small</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12dbgTextClearE7uint8_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Clear internal debug text buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_dbg_text_clear</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_attr</span></code>: Background color. </li>
|
||
<li><code class="docutils literal"><span class="pre">_small</span></code>: Default or 8x8 font.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13dbgTextPrintfE8uint16_t8uint16_t7uint8_tPKcz">
|
||
<span id="bgfx::dbgTextPrintf__uint16_t.uint16_t.uint8_t.cCP.z"></span><span class="target" id="namespacebgfx_1a2d1c6e189bbfdc2b2458d152a2a08245"></span>void <code class="descclassname">bgfx::</code><code class="descname">dbgTextPrintf</code><span class="sig-paren">(</span>uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint8_t <em>_attr</em>, <em class="property">const</em> char *<em>_format</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13dbgTextPrintfE8uint16_t8uint16_t7uint8_tPKcz" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Print into internal debug text character-buffer (VGA-compatible text mode). </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_dbg_text_printf</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_x</span><span class="pre">_y</span></code>: 2D position from top-left. </li>
|
||
<li><code class="docutils literal"><span class="pre">_attr</span></code>: Color palette. Where top 4-bits represent index of background, and bottom 4-bits represent foreground color from standard VGA text palette (ANSI escape codes). </li>
|
||
<li><code class="docutils literal"><span class="pre">_format</span></code>: <code class="docutils literal"><span class="pre">printf</span></code> style format.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx18dbgTextPrintfVargsE8uint16_t8uint16_t7uint8_tPKc7va_list">
|
||
<span id="bgfx::dbgTextPrintfVargs__uint16_t.uint16_t.uint8_t.cCP.va_list"></span><span class="target" id="namespacebgfx_1ac84afd8d2ad87516bfb770dec920654e"></span>void <code class="descclassname">bgfx::</code><code class="descname">dbgTextPrintfVargs</code><span class="sig-paren">(</span>uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint8_t <em>_attr</em>, <em class="property">const</em> char *<em>_format</em>, va_list <em>_argList</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx18dbgTextPrintfVargsE8uint16_t8uint16_t7uint8_tPKc7va_list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Print into internal debug text character-buffer (VGA-compatible text mode). </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_dbg_text_vprintf</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_x</span><span class="pre">_y</span></code>: 2D position from top-left. </li>
|
||
<li><code class="docutils literal"><span class="pre">_attr</span></code>: Color palette. Where top 4-bits represent index of background, and bottom 4-bits represent foreground color from standard VGA text palette (ANSI escape codes). </li>
|
||
<li><code class="docutils literal"><span class="pre">_format</span></code>: <code class="docutils literal"><span class="pre">printf</span></code> style format. </li>
|
||
<li><code class="docutils literal"><span class="pre">_argList</span></code>: additional arguments for format string</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12dbgTextImageE8uint16_t8uint16_t8uint16_t8uint16_tPKv8uint16_t">
|
||
<span id="bgfx::dbgTextImage__uint16_t.uint16_t.uint16_t.uint16_t.voidCP.uint16_t"></span><span class="target" id="namespacebgfx_1ad8f6406578d8886613b4cc48e6c5737a"></span>void <code class="descclassname">bgfx::</code><code class="descname">dbgTextImage</code><span class="sig-paren">(</span>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> void *<em>_data</em>, uint16_t <em>_pitch</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12dbgTextImageE8uint16_t8uint16_t8uint16_t8uint16_tPKv8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Draw image into internal debug text buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_dbg_text_image</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_x</span><span class="pre">_y</span></code>: 2D position from top-left. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span><span class="pre">_height</span></code>: Image width and height. </li>
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Raw image data (character/attribute raw encoding). </li>
|
||
<li><code class="docutils literal"><span class="pre">_pitch</span></code>: Image pitch in bytes.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="querying-information">
|
||
<h3>Querying information<a class="headerlink" href="#querying-information" title="Permalink to this headline">¶</a></h3>
|
||
<div class="section" id="renderer">
|
||
<h4>Renderer<a class="headerlink" href="#renderer" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15getRendererTypeEv">
|
||
<span id="bgfx::getRendererType"></span><span class="target" id="namespacebgfx_1ab0c1e47f7ebc790794c0161abaaebc8a"></span><a class="reference internal" href="#_CPPv2N4bgfx12RendererTypeE" title="bgfx::RendererType">RendererType</a>::<a class="reference internal" href="#_CPPv2N4bgfx12RendererType4EnumE" title="bgfx::RendererType::Enum">Enum</a> <code class="descclassname">bgfx::</code><code class="descname">getRendererType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15getRendererTypeEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns current renderer backend API type. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Library must be initialized.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_renderer_type</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx12RendererTypeE">
|
||
<span id="bgfx::RendererType"></span><span class="target" id="structbgfx_1_1_renderer_type"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">RendererType</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererTypeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renderer backend type enum. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_renderer_type_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx12RendererType4EnumE">
|
||
<span id="bgfx::RendererType::Enum"></span><span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renderer types: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType4NoopE">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32ae119c2ac9204cc917b956053d53110e6"></span><code class="descname">Noop</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType4NoopE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>No rendering. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType9Direct3D9E">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32a10c968bd17c9feceefb823dd2ada0e1e"></span><code class="descname">Direct3D9</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType9Direct3D9E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Direct3D 9.0. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType10Direct3D11E">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32a779984af2d8f167e3d81197fe2339342"></span><code class="descname">Direct3D11</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType10Direct3D11E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Direct3D 11.0. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType10Direct3D12E">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32a97ff664bd1c66a64c4bfcf2b1397a62c"></span><code class="descname">Direct3D12</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType10Direct3D12E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Direct3D 12.0. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType3GnmE">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32a960f8f39bfa96702800236af4add67b5"></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="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType5MetalE">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32aa079092a089171e407f97a7d07d63fa7"></span><code class="descname">Metal</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType5MetalE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Metal. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType8OpenGLESE">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32ab88722df715c016f46d3ee90d7a87be5"></span><code class="descname">OpenGLES</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType8OpenGLESE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>OpenGL ES 2.0+. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType6OpenGLE">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32a484f42aff573002614c5a4ea7cf1a859"></span><code class="descname">OpenGL</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType6OpenGLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>OpenGL 2.1+. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType6VulkanE">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32a427ffdf300bed8d7951452ffb21a7638"></span><code class="descname">Vulkan</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType6VulkanE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vulkan. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12RendererType5CountE">
|
||
<span class="target" id="structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32aab03bfb685626b6697f1456fcc1ad3f5"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="capabilities">
|
||
<h4>Capabilities<a class="headerlink" href="#capabilities" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7getCapsEv">
|
||
<span id="bgfx::getCaps"></span><span class="target" id="namespacebgfx_1a6ff11d29a4f9646ee6e8ec07454fb2ea"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx4CapsE" title="bgfx::Caps">Caps</a> *<code class="descclassname">bgfx::</code><code class="descname">getCaps</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7getCapsEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns renderer capabilities. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Pointer to static <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_caps"><span><span class="pre">bgfx::Caps</span></span></a></code> structure.</dd>
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Library must be initialized.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_caps</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx4CapsE">
|
||
<span id="bgfx::Caps"></span><span class="target" id="structbgfx_1_1_caps"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Caps</code><a class="headerlink" href="#_CPPv2N4bgfx4CapsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renderer capabilities. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_caps_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps12rendererTypeE">
|
||
<span id="bgfx::Caps::rendererType__RendererType::Enum"></span><span class="target" id="structbgfx_1_1_caps_1a68960bb9621a6e4b0cad7e0f326ab3fd"></span><a class="reference internal" href="#_CPPv2N4bgfx12RendererTypeE" title="bgfx::RendererType">RendererType</a>::<a class="reference internal" href="#_CPPv2N4bgfx12RendererType4EnumE" title="bgfx::RendererType::Enum">Enum</a> <code class="descname">rendererType</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps12rendererTypeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renderer backend type. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_renderer_type"><span><span class="pre">bgfx::RendererType</span></span></a></code> </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps9supportedE">
|
||
<span id="bgfx::Caps::supported__uint64_t"></span><span class="target" id="structbgfx_1_1_caps_1a39b666b5fe440ad5e92748bb1fce60cf"></span>uint64_t <code class="descname">supported</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps9supportedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Supported functionality. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>See BGFX_CAPS_* flags at <a class="reference external" href="https://bkaradzic.github.io/bgfx/bgfx.html#available-caps">https://bkaradzic.github.io/bgfx/bgfx.html#available-caps</a> </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps8vendorIdE">
|
||
<span id="bgfx::Caps::vendorId__uint16_t"></span><span class="target" id="structbgfx_1_1_caps_1ac51fdd2bed74e1e71480409bd40bc4bc"></span>uint16_t <code class="descname">vendorId</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps8vendorIdE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Selected <a class="reference internal" href="#structbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> vendor PCI id. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps8deviceIdE">
|
||
<span id="bgfx::Caps::deviceId__uint16_t"></span><span class="target" id="structbgfx_1_1_caps_1a7c63448a97f4d09b275c353cdb295a8b"></span>uint16_t <code class="descname">deviceId</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps8deviceIdE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Selected <a class="reference internal" href="#structbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> device id. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps16homogeneousDepthE">
|
||
<span id="bgfx::Caps::homogeneousDepth__b"></span><span class="target" id="structbgfx_1_1_caps_1af44dfe9ca7538e9e8cf6feecc37656f0"></span>bool <code class="descname">homogeneousDepth</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps16homogeneousDepthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>True when NDC depth is in [-1, 1] range, otherwise its [0, 1]. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps16originBottomLeftE">
|
||
<span id="bgfx::Caps::originBottomLeft__b"></span><span class="target" id="structbgfx_1_1_caps_1a1f64f782bd68dfc615a2571ca6e1cf72"></span>bool <code class="descname">originBottomLeft</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps16originBottomLeftE" title="Permalink to this definition">¶</a></dt>
|
||
<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="structbgfx_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="structbgfx_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>
|
||
<dd><p>Enumerated GPUs. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps7formatsE">
|
||
<span id="bgfx::Caps::formats__uint16_tA"></span><span class="target" id="structbgfx_1_1_caps_1a9d3d8445e5c828669c924e6fa38e9389"></span>uint16_t <code class="descname">formats</code>[TextureFormat::Count]<a class="headerlink" href="#_CPPv2N4bgfx4Caps7formatsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Supported texture format capabilities flags: </p>
|
||
<p><ul class="simple">
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_NONE</span></code> - Texture format is not supported.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_2D</span></code> - Texture format is supported.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_2D_SRGB</span></code> - Texture as sRGB format is supported.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_2D_EMULATED</span></code> - Texture format is emulated.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_3D</span></code> - Texture format is supported.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_3D_SRGB</span></code> - Texture as sRGB format is supported.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_3D_EMULATED</span></code> - Texture format is emulated.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_CUBE</span></code> - Texture format is supported.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_CUBE_SRGB</span></code> - Texture as sRGB format is supported.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_CUBE_EMULATED</span></code> - Texture format is emulated.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_VERTEX</span></code> - Texture format can be used from vertex shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_IMAGE</span></code> - Texture format can be used as image from compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER</span></code> - Texture format can be used as frame buffer.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER_MSAA</span></code> - Texture format can be used as MSAA frame buffer.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_MSAA</span></code> - Texture can be sampled as MSAA.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_MIP_AUTOGEN</span></code> - Texture format supports auto-generated mips. </li>
|
||
</ul>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx4Caps3GPUE">
|
||
<span id="bgfx::Caps::GPU"></span><span class="target" id="structbgfx_1_1_caps_1_1_g_p_u"></span><em class="property">struct </em><code class="descname">GPU</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps3GPUE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#structbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> info. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_caps_gpu_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps3GPU8vendorIdE">
|
||
<span id="bgfx::Caps::GPU::vendorId__uint16_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_g_p_u_1a77f4cadafbf81c74f4fb7111a2977f3b"></span>uint16_t <code class="descname">vendorId</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps3GPU8vendorIdE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vendor PCI id. See <code class="docutils literal"><span class="pre">BGFX_PCI_ID_*</span></code>. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps3GPU8deviceIdE">
|
||
<span id="bgfx::Caps::GPU::deviceId__uint16_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_g_p_u_1ade4c6123ad7964f039b5c5df9de7e6a8"></span>uint16_t <code class="descname">deviceId</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps3GPU8deviceIdE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device id. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx4Caps6LimitsE">
|
||
<span id="bgfx::Caps::Limits"></span><span class="target" id="structbgfx_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="structbgfx_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 number of draw calls. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits8maxBlitsE">
|
||
<span id="bgfx::Caps::Limits::maxBlits__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a98c1429581326942d9d795b732f8d65b"></span>uint32_t <code class="descname">maxBlits</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits8maxBlitsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of blit calls. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits14maxTextureSizeE">
|
||
<span id="bgfx::Caps::Limits::maxTextureSize__uint32_t"></span><span class="target" id="structbgfx_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="_CPPv2N4bgfx4Caps6Limits16maxTextureLayersE">
|
||
<span id="bgfx::Caps::Limits::maxTextureLayers__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a47505cd12a2fb1172768b4dfdda3b98c"></span>uint32_t <code class="descname">maxTextureLayers</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits16maxTextureLayersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum texture layers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits8maxViewsE">
|
||
<span id="bgfx::Caps::Limits::maxViews__uint32_t"></span><span class="target" id="structbgfx_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 number of views. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits15maxFrameBuffersE">
|
||
<span id="bgfx::Caps::Limits::maxFrameBuffers__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a1af60c77dfe82892b03082c623069128"></span>uint32_t <code class="descname">maxFrameBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits15maxFrameBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of frame buffer handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits16maxFBAttachmentsE">
|
||
<span id="bgfx::Caps::Limits::maxFBAttachments__uint32_t"></span><span class="target" id="structbgfx_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 number of frame buffer attachments. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits11maxProgramsE">
|
||
<span id="bgfx::Caps::Limits::maxPrograms__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1af127d6a3eab65655bf39570ff4b11734"></span>uint32_t <code class="descname">maxPrograms</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits11maxProgramsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of program handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits10maxShadersE">
|
||
<span id="bgfx::Caps::Limits::maxShaders__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a53e281859a518d7791a8b1246209e1e9"></span>uint32_t <code class="descname">maxShaders</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits10maxShadersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of shader handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits11maxTexturesE">
|
||
<span id="bgfx::Caps::Limits::maxTextures__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a2bcb4e498ce04ceae93ef8a8b54f65f7"></span>uint32_t <code class="descname">maxTextures</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits11maxTexturesE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of texture handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits18maxTextureSamplersE">
|
||
<span id="bgfx::Caps::Limits::maxTextureSamplers__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a7fcc0f7cfdb9557ae37e5bde1d1a2a1f"></span>uint32_t <code class="descname">maxTextureSamplers</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits18maxTextureSamplersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of texture samplers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits18maxComputeBindingsE">
|
||
<span id="bgfx::Caps::Limits::maxComputeBindings__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a2cf3ef61b8359023fd73ba6cd9f47a64"></span>uint32_t <code class="descname">maxComputeBindings</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits18maxComputeBindingsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of compute bindings. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits14maxVertexDeclsE">
|
||
<span id="bgfx::Caps::Limits::maxVertexDecls__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a94bbdf9e33aa717cc93d3984952ac8a9"></span>uint32_t <code class="descname">maxVertexDecls</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits14maxVertexDeclsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of vertex format declarations. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits16maxVertexStreamsE">
|
||
<span id="bgfx::Caps::Limits::maxVertexStreams__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1ae3b60d96f126e89d57a177872f489527"></span>uint32_t <code class="descname">maxVertexStreams</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits16maxVertexStreamsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of vertex streams. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits15maxIndexBuffersE">
|
||
<span id="bgfx::Caps::Limits::maxIndexBuffers__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a91d6bc8e86abd9eca8cc0fe303d3cf6c"></span>uint32_t <code class="descname">maxIndexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits15maxIndexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of index buffer handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits16maxVertexBuffersE">
|
||
<span id="bgfx::Caps::Limits::maxVertexBuffers__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1af9f48ed16a60e74e3815daf6df3ed25f"></span>uint32_t <code class="descname">maxVertexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits16maxVertexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of vertex buffer handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits22maxDynamicIndexBuffersE">
|
||
<span id="bgfx::Caps::Limits::maxDynamicIndexBuffers__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1ad64d97f5d9cb0fa5994148656eb2cbaa"></span>uint32_t <code class="descname">maxDynamicIndexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits22maxDynamicIndexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of dynamic index buffer handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits23maxDynamicVertexBuffersE">
|
||
<span id="bgfx::Caps::Limits::maxDynamicVertexBuffers__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a1e5f37cc9f8e05729852ee2ae363d3c2"></span>uint32_t <code class="descname">maxDynamicVertexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits23maxDynamicVertexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of dynamic vertex buffer handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits11maxUniformsE">
|
||
<span id="bgfx::Caps::Limits::maxUniforms__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1af9f56afc24d7287d577c948f8e848f06"></span>uint32_t <code class="descname">maxUniforms</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits11maxUniformsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of uniform handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits19maxOcclusionQueriesE">
|
||
<span id="bgfx::Caps::Limits::maxOcclusionQueries__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a64c6f40f46021e9d5fbec9c27d3fbece"></span>uint32_t <code class="descname">maxOcclusionQueries</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits19maxOcclusionQueriesE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of occlusion query handles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits11maxEncodersE">
|
||
<span id="bgfx::Caps::Limits::maxEncoders__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1ad8bf1308949450d13fc231179c0d8a2c"></span>uint32_t <code class="descname">maxEncoders</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits11maxEncodersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum number of encoder threads. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits15transientVbSizeE">
|
||
<span id="bgfx::Caps::Limits::transientVbSize__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a7612ba54b79f902dcfb278bab1027cdc"></span>uint32_t <code class="descname">transientVbSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits15transientVbSizeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum transient vertex buffer size. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps6Limits15transientIbSizeE">
|
||
<span id="bgfx::Caps::Limits::transientIbSize__uint32_t"></span><span class="target" id="structbgfx_1_1_caps_1_1_limits_1a4e604a96366723416a4b19dc4b2d93e9"></span>uint32_t <code class="descname">transientIbSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps6Limits15transientIbSizeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum transient index buffer size. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<div class="section" id="available-caps">
|
||
<h5>Available Caps<a class="headerlink" href="#available-caps" title="Permalink to this headline">¶</a></h5>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_ALPHA_TO_COVERAGE">
|
||
<span class="target" id="defines_8h_1abd908a660ce2ecb66ac53f2fede98451"></span><code class="descname">BGFX_CAPS_ALPHA_TO_COVERAGE</code><a class="headerlink" href="#c.BGFX_CAPS_ALPHA_TO_COVERAGE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alpha to coverage is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_BLEND_INDEPENDENT">
|
||
<span class="target" id="defines_8h_1ac50a011626842799ca8e2041a4760e9f"></span><code class="descname">BGFX_CAPS_BLEND_INDEPENDENT</code><a class="headerlink" href="#c.BGFX_CAPS_BLEND_INDEPENDENT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blend independent is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_COMPUTE">
|
||
<span class="target" id="defines_8h_1ae843b1802f7876c50ffbd3c5def8a1b4"></span><code class="descname">BGFX_CAPS_COMPUTE</code><a class="headerlink" href="#c.BGFX_CAPS_COMPUTE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Compute shaders are supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_CONSERVATIVE_RASTER">
|
||
<span class="target" id="defines_8h_1a01ba705fe5d7a67c47d2a6bd8ace6869"></span><code class="descname">BGFX_CAPS_CONSERVATIVE_RASTER</code><a class="headerlink" href="#c.BGFX_CAPS_CONSERVATIVE_RASTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Conservative rasterization is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_DRAW_INDIRECT">
|
||
<span class="target" id="defines_8h_1aa82d6cbe876706321923461ff8973679"></span><code class="descname">BGFX_CAPS_DRAW_INDIRECT</code><a class="headerlink" href="#c.BGFX_CAPS_DRAW_INDIRECT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Draw indirect is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_FRAGMENT_DEPTH">
|
||
<span class="target" id="defines_8h_1ad6427441adff7f8672d4f90eaa40698d"></span><code class="descname">BGFX_CAPS_FRAGMENT_DEPTH</code><a class="headerlink" href="#c.BGFX_CAPS_FRAGMENT_DEPTH" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fragment depth is accessible in fragment shader. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_FRAGMENT_ORDERING">
|
||
<span class="target" id="defines_8h_1ae63f3a67435d3ab926ef8d7fd19ffe07"></span><code class="descname">BGFX_CAPS_FRAGMENT_ORDERING</code><a class="headerlink" href="#c.BGFX_CAPS_FRAGMENT_ORDERING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fragment ordering is available in fragment shader. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_GRAPHICS_DEBUGGER">
|
||
<span class="target" id="defines_8h_1a09ab03b89a07295a645d15cc4ac1580d"></span><code class="descname">BGFX_CAPS_GRAPHICS_DEBUGGER</code><a class="headerlink" href="#c.BGFX_CAPS_GRAPHICS_DEBUGGER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Graphics debugger is present. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_HDR10">
|
||
<span class="target" id="defines_8h_1af5cd44ec5f5eec4e8479d54bb9a9497e"></span><code class="descname">BGFX_CAPS_HDR10</code><a class="headerlink" href="#c.BGFX_CAPS_HDR10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HDR10 rendering is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_HIDPI">
|
||
<span class="target" id="defines_8h_1a917840ff950077d8f5964028e5854b42"></span><code class="descname">BGFX_CAPS_HIDPI</code><a class="headerlink" href="#c.BGFX_CAPS_HIDPI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HiDPI rendering is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_INDEX32">
|
||
<span class="target" id="defines_8h_1ab334337b725ebcfa588afc00ab838e77"></span><code class="descname">BGFX_CAPS_INDEX32</code><a class="headerlink" href="#c.BGFX_CAPS_INDEX32" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>32-bit indices are supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_INSTANCING">
|
||
<span class="target" id="defines_8h_1a8fa31bcef4c9038b65a7e6e198792e04"></span><code class="descname">BGFX_CAPS_INSTANCING</code><a class="headerlink" href="#c.BGFX_CAPS_INSTANCING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Instancing is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_OCCLUSION_QUERY">
|
||
<span class="target" id="defines_8h_1a35626a97a17fc3e2f3b712a8221c38bf"></span><code class="descname">BGFX_CAPS_OCCLUSION_QUERY</code><a class="headerlink" href="#c.BGFX_CAPS_OCCLUSION_QUERY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Occlusion query is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_RENDERER_MULTITHREADED">
|
||
<span class="target" id="defines_8h_1a7a915158233262d1e3efe18a12b4c3a6"></span><code class="descname">BGFX_CAPS_RENDERER_MULTITHREADED</code><a class="headerlink" href="#c.BGFX_CAPS_RENDERER_MULTITHREADED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renderer is on separate thread. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_SWAP_CHAIN">
|
||
<span class="target" id="defines_8h_1afda15c358cd389b8ba58a31bf4406c75"></span><code class="descname">BGFX_CAPS_SWAP_CHAIN</code><a class="headerlink" href="#c.BGFX_CAPS_SWAP_CHAIN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Multiple windows are supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_2D_ARRAY">
|
||
<span class="target" id="defines_8h_1a5722ea49376c1f384e7d542d94454c8e"></span><code class="descname">BGFX_CAPS_TEXTURE_2D_ARRAY</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_2D_ARRAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>2D texture array is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_3D">
|
||
<span class="target" id="defines_8h_1ad5f6d21a544dec64de111514b463566b"></span><code class="descname">BGFX_CAPS_TEXTURE_3D</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_3D" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>3D textures are supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_BLIT">
|
||
<span class="target" id="defines_8h_1a7ddb9c7ef30ca6c8b68b686b5122123f"></span><code class="descname">BGFX_CAPS_TEXTURE_BLIT</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_BLIT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture blit is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_COMPARE_ALL">
|
||
<span class="target" id="defines_8h_1a9ebaab5c7f3b4b3289bb6b6b7bae9511"></span><code class="descname">BGFX_CAPS_TEXTURE_COMPARE_ALL</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_COMPARE_ALL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>All texture compare modes are supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_COMPARE_LEQUAL">
|
||
<span class="target" id="defines_8h_1a1316712571960b2e3c9daf12723041d7"></span><code class="descname">BGFX_CAPS_TEXTURE_COMPARE_LEQUAL</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_COMPARE_LEQUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture compare less equal mode is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_CUBE_ARRAY">
|
||
<span class="target" id="defines_8h_1acf8f4db9728d92d43e352ae6abb4eb33"></span><code class="descname">BGFX_CAPS_TEXTURE_CUBE_ARRAY</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_CUBE_ARRAY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Cubemap texture array is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_DIRECT_ACCESS">
|
||
<span class="target" id="defines_8h_1a45a99a879cc6d2da668682b435523a52"></span><code class="descname">BGFX_CAPS_TEXTURE_DIRECT_ACCESS</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_DIRECT_ACCESS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CPU direct access to GPU texture memory. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_READ_BACK">
|
||
<span class="target" id="defines_8h_1ac2cd9bdd84fdce3e55b3054413094f0d"></span><code class="descname">BGFX_CAPS_TEXTURE_READ_BACK</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_READ_BACK" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read-back texture is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_VERTEX_ATTRIB_HALF">
|
||
<span class="target" id="defines_8h_1ac7de569a09f05f83052c6b77c99db7fc"></span><code class="descname">BGFX_CAPS_VERTEX_ATTRIB_HALF</code><a class="headerlink" href="#c.BGFX_CAPS_VERTEX_ATTRIB_HALF" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vertex attribute half-float is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_VERTEX_ATTRIB_UINT10">
|
||
<span class="target" id="defines_8h_1a3f092ea38f4d3c1d46eda38393c88be6"></span><code class="descname">BGFX_CAPS_VERTEX_ATTRIB_UINT10</code><a class="headerlink" href="#c.BGFX_CAPS_VERTEX_ATTRIB_UINT10" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vertex attribute 10_10_10_2 is supported. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_VERTEX_ID">
|
||
<span class="target" id="defines_8h_1a63af3c34318335de4b4fa64af87dcc5c"></span><code class="descname">BGFX_CAPS_VERTEX_ID</code><a class="headerlink" href="#c.BGFX_CAPS_VERTEX_ID" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Rendering with VertexID only is supported. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="statistics">
|
||
<h4>Statistics<a class="headerlink" href="#statistics" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8getStatsEv">
|
||
<span id="bgfx::getStats"></span><span class="target" id="namespacebgfx_1a404b74593c7c8fd8e591703ec7e8bd4e"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx5StatsE" title="bgfx::Stats">Stats</a> *<code class="descclassname">bgfx::</code><code class="descname">getStats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8getStatsEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns performance counters. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Pointer returned is valid until <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> is called. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_stats</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx5StatsE">
|
||
<span id="bgfx::Stats"></span><span class="target" id="structbgfx_1_1_stats"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Stats</code><a class="headerlink" href="#_CPPv2N4bgfx5StatsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renderer statistics data. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_stats_t</span></code>.</dd>
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>All time values are high-resolution timestamps, while time frequencies define timestamps-per-second for that hardware. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12cpuTimeFrameE">
|
||
<span id="bgfx::Stats::cpuTimeFrame__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1a8d65ca9e1dcc56a9d2ac505abfa678f9"></span>int64_t <code class="descname">cpuTimeFrame</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimeFrameE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CPU time between two <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> calls. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12cpuTimeBeginE">
|
||
<span id="bgfx::Stats::cpuTimeBegin__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1acefc6f6fb9aca5e607a46119162d8a81"></span>int64_t <code class="descname">cpuTimeBegin</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimeBeginE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Render thread CPU submit begin time. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats10cpuTimeEndE">
|
||
<span id="bgfx::Stats::cpuTimeEnd__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1ab5275e59d5ebe68200fd3b63ed59cbd2"></span>int64_t <code class="descname">cpuTimeEnd</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10cpuTimeEndE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Render thread CPU submit end time. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12cpuTimerFreqE">
|
||
<span id="bgfx::Stats::cpuTimerFreq__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1a0ca3b1b43511aa10c9f2ff0f30680ef0"></span>int64_t <code class="descname">cpuTimerFreq</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimerFreqE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CPU timer frequency. Timestamps-per-second. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12gpuTimeBeginE">
|
||
<span id="bgfx::Stats::gpuTimeBegin__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1a8748ff45b30e72fc6103ceb80b5642b0"></span>int64_t <code class="descname">gpuTimeBegin</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuTimeBeginE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GPU frame begin time. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats10gpuTimeEndE">
|
||
<span id="bgfx::Stats::gpuTimeEnd__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1a0588c269d4eefdef1dbe31d3be4c211b"></span>int64_t <code class="descname">gpuTimeEnd</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10gpuTimeEndE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GPU frame end time. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12gpuTimerFreqE">
|
||
<span id="bgfx::Stats::gpuTimerFreq__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1a98cdb3d5fd558bb7482e01b28ae5751c"></span>int64_t <code class="descname">gpuTimerFreq</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuTimerFreqE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GPU timer frequency. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats10waitRenderE">
|
||
<span id="bgfx::Stats::waitRender__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1abaa38e7ef0d66619d8e5ffe451ed82e2"></span>int64_t <code class="descname">waitRender</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10waitRenderE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Time spent waiting for render backend thread to finish issuing draw commands to underlying graphics API. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats10waitSubmitE">
|
||
<span id="bgfx::Stats::waitSubmit__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1a189339cefe5bbaecc1e894584ab6a7d2"></span>int64_t <code class="descname">waitSubmit</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10waitSubmitE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Time spent waiting for submit thread to advance to next frame. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats7numDrawE">
|
||
<span id="bgfx::Stats::numDraw__uint32_t"></span><span class="target" id="structbgfx_1_1_stats_1aa46abb090da88e02c64abb90c3679d73"></span>uint32_t <code class="descname">numDraw</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats7numDrawE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of draw calls submitted. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats10numComputeE">
|
||
<span id="bgfx::Stats::numCompute__uint32_t"></span><span class="target" id="structbgfx_1_1_stats_1ae9366cfaad6f24d4ab620b3570282c12"></span>uint32_t <code class="descname">numCompute</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10numComputeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of compute calls submitted. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats7numBlitE">
|
||
<span id="bgfx::Stats::numBlit__uint32_t"></span><span class="target" id="structbgfx_1_1_stats_1a1bc357a640fe58924ad4df927642a451"></span>uint32_t <code class="descname">numBlit</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats7numBlitE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of blit calls submitted. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats13maxGpuLatencyE">
|
||
<span id="bgfx::Stats::maxGpuLatency__uint32_t"></span><span class="target" id="structbgfx_1_1_stats_1a009e15fb4e8339ed5259d6451d180de5"></span>uint32_t <code class="descname">maxGpuLatency</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats13maxGpuLatencyE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GPU driver latency. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats22numDynamicIndexBuffersE">
|
||
<span id="bgfx::Stats::numDynamicIndexBuffers__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a51aa716928eefd8e704174a738bc2bb6"></span>uint16_t <code class="descname">numDynamicIndexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats22numDynamicIndexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used dynamic index buffers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats23numDynamicVertexBuffersE">
|
||
<span id="bgfx::Stats::numDynamicVertexBuffers__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1ac5d3971e81b0bb79363057e7843d5d00"></span>uint16_t <code class="descname">numDynamicVertexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats23numDynamicVertexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used dynamic vertex buffers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats15numFrameBuffersE">
|
||
<span id="bgfx::Stats::numFrameBuffers__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a0aa0e072934671693e948c314f10dab8"></span>uint16_t <code class="descname">numFrameBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats15numFrameBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used frame buffers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats15numIndexBuffersE">
|
||
<span id="bgfx::Stats::numIndexBuffers__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1ab907700c895ce393d92b823bbcfb127b"></span>uint16_t <code class="descname">numIndexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats15numIndexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used index buffers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats19numOcclusionQueriesE">
|
||
<span id="bgfx::Stats::numOcclusionQueries__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1aadda2cb25489ee00cf3b4c9446d96a4f"></span>uint16_t <code class="descname">numOcclusionQueries</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats19numOcclusionQueriesE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used occlusion queries. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats11numProgramsE">
|
||
<span id="bgfx::Stats::numPrograms__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1af72f976cf678edcebb5fa02f1b880ad7"></span>uint16_t <code class="descname">numPrograms</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats11numProgramsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used programs. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats10numShadersE">
|
||
<span id="bgfx::Stats::numShaders__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a3a9ca7307a29b18d10bb772b3c8d93e8"></span>uint16_t <code class="descname">numShaders</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10numShadersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used shaders. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats11numTexturesE">
|
||
<span id="bgfx::Stats::numTextures__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a3806f1bcd00b04c4aa662ae8d3c2fcd0"></span>uint16_t <code class="descname">numTextures</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats11numTexturesE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used textures. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats11numUniformsE">
|
||
<span id="bgfx::Stats::numUniforms__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a5d2f024b98e4a839f156b18ea21309c7"></span>uint16_t <code class="descname">numUniforms</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats11numUniformsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used uniforms. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats16numVertexBuffersE">
|
||
<span id="bgfx::Stats::numVertexBuffers__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a262791d85d8b8f67cb395d5e472849ed"></span>uint16_t <code class="descname">numVertexBuffers</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats16numVertexBuffersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used vertex buffers. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats14numVertexDeclsE">
|
||
<span id="bgfx::Stats::numVertexDecls__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a3e24c61fbeb79a1d283ef6e8a4d68b11"></span>uint16_t <code class="descname">numVertexDecls</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats14numVertexDeclsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of used vertex declarations. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats17textureMemoryUsedE">
|
||
<span id="bgfx::Stats::textureMemoryUsed__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1ad209161ed6b9f04105ab55c535e4f4ee"></span>int64_t <code class="descname">textureMemoryUsed</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats17textureMemoryUsedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Estimate of texture memory used. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12rtMemoryUsedE">
|
||
<span id="bgfx::Stats::rtMemoryUsed__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1a532fd0f54fd15377cf24309a2ebbd95b"></span>int64_t <code class="descname">rtMemoryUsed</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12rtMemoryUsedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Estimate of render target memory used. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats15transientVbUsedE">
|
||
<span id="bgfx::Stats::transientVbUsed__int32_t"></span><span class="target" id="structbgfx_1_1_stats_1af15ba5ebef38a16382762ed84748bc34"></span>int32_t <code class="descname">transientVbUsed</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats15transientVbUsedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Amount of transient vertex buffer used. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats15transientIbUsedE">
|
||
<span id="bgfx::Stats::transientIbUsed__int32_t"></span><span class="target" id="structbgfx_1_1_stats_1a57989ed31ef534e59a884c2f39cfdb3f"></span>int32_t <code class="descname">transientIbUsed</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats15transientIbUsedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Amount of transient index buffer used. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats8numPrimsE">
|
||
<span id="bgfx::Stats::numPrims__uint32_tA"></span><span class="target" id="structbgfx_1_1_stats_1a35ef32f727dd0e81350209549d51cb9d"></span>uint32_t <code class="descname">numPrims</code>[Topology::Count]<a class="headerlink" href="#_CPPv2N4bgfx5Stats8numPrimsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of primitives rendered. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12gpuMemoryMaxE">
|
||
<span id="bgfx::Stats::gpuMemoryMax__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1afe5fd057109b00d5a4f760a034c59c8b"></span>int64_t <code class="descname">gpuMemoryMax</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12gpuMemoryMaxE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum available GPU memory for application. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats13gpuMemoryUsedE">
|
||
<span id="bgfx::Stats::gpuMemoryUsed__int64_t"></span><span class="target" id="structbgfx_1_1_stats_1aa936cf20a5da4419936958f67a594bc1"></span>int64_t <code class="descname">gpuMemoryUsed</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats13gpuMemoryUsedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Amount of GPU memory used by the application. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats5widthE">
|
||
<span id="bgfx::Stats::width__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a8a225ad7ff3fad833cd7fb783550d4f3"></span>uint16_t <code class="descname">width</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats5widthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer width in pixels. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats6heightE">
|
||
<span id="bgfx::Stats::height__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a1c9c3e5debe856f2e01ba3c723205af7"></span>uint16_t <code class="descname">height</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats6heightE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer height in pixels. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats9textWidthE">
|
||
<span id="bgfx::Stats::textWidth__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1a9a3861eb31ab778df13b8f164af35bac"></span>uint16_t <code class="descname">textWidth</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats9textWidthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debug text width in characters. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats10textHeightE">
|
||
<span id="bgfx::Stats::textHeight__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1abc8a033f303af8fbcfeb7d242dcc56ee"></span>uint16_t <code class="descname">textHeight</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats10textHeightE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Debug text height in characters. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats8numViewsE">
|
||
<span id="bgfx::Stats::numViews__uint16_t"></span><span class="target" id="structbgfx_1_1_stats_1ab9ecae87a64e8f540219bec6f2b17f08"></span>uint16_t <code class="descname">numViews</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats8numViewsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of view stats. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats9viewStatsE">
|
||
<span id="bgfx::Stats::viewStats__ViewStatsP"></span><span class="target" id="structbgfx_1_1_stats_1ae16496ef386b462267436e1bbd3d5f72"></span><a class="reference internal" href="#_CPPv2N4bgfx9ViewStatsE" title="bgfx::ViewStats">ViewStats</a> *<code class="descname">viewStats</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats9viewStatsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Array of View stats. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats11numEncodersE">
|
||
<span id="bgfx::Stats::numEncoders__uint8_t"></span><span class="target" id="structbgfx_1_1_stats_1a36cd71d8c46eeb0efd677e0783a5f126"></span>uint8_t <code class="descname">numEncoders</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats11numEncodersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of encoders used during frame. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12encoderStatsE">
|
||
<span id="bgfx::Stats::encoderStats__EncoderStatsP"></span><span class="target" id="structbgfx_1_1_stats_1abf32715c9e2f41f01545fa0f0f5dd821"></span><a class="reference internal" href="#_CPPv2N4bgfx12EncoderStatsE" title="bgfx::EncoderStats">EncoderStats</a> *<code class="descname">encoderStats</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12encoderStatsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Array of encoder stats. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx9ViewStatsE">
|
||
<span id="bgfx::ViewStats"></span><span class="target" id="structbgfx_1_1_view_stats"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">ViewStats</code><a class="headerlink" href="#_CPPv2N4bgfx9ViewStatsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>View stats. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_view_stats_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx9ViewStats4nameE">
|
||
<span id="bgfx::ViewStats::name__cA"></span><span class="target" id="structbgfx_1_1_view_stats_1a8c2383b3c9757cfc5fabf62e28ad5bea"></span>char <code class="descname">name</code>[256]<a class="headerlink" href="#_CPPv2N4bgfx9ViewStats4nameE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>View name. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx9ViewStats4viewE">
|
||
<span id="bgfx::ViewStats::view__ViewId"></span><span class="target" id="structbgfx_1_1_view_stats_1aa66982ced24c30af890b6ef7dcdb8b96"></span>ViewId <code class="descname">view</code><a class="headerlink" href="#_CPPv2N4bgfx9ViewStats4viewE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>View id. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx9ViewStats14cpuTimeElapsedE">
|
||
<span id="bgfx::ViewStats::cpuTimeElapsed__int64_t"></span><span class="target" id="structbgfx_1_1_view_stats_1ae352f1df82767ee0cd75ebd348ccc4dc"></span>int64_t <code class="descname">cpuTimeElapsed</code><a class="headerlink" href="#_CPPv2N4bgfx9ViewStats14cpuTimeElapsedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CPU (submit) time elapsed. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx9ViewStats14gpuTimeElapsedE">
|
||
<span id="bgfx::ViewStats::gpuTimeElapsed__int64_t"></span><span class="target" id="structbgfx_1_1_view_stats_1aab02959cb4de332d936dd72f697ef8a8"></span>int64_t <code class="descname">gpuTimeElapsed</code><a class="headerlink" href="#_CPPv2N4bgfx9ViewStats14gpuTimeElapsedE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GPU time elapsed. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx12EncoderStatsE">
|
||
<span id="bgfx::EncoderStats"></span><span class="target" id="structbgfx_1_1_encoder_stats"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">EncoderStats</code><a class="headerlink" href="#_CPPv2N4bgfx12EncoderStatsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#structbgfx_1_1_encoder"><span>Encoder</span></a> stats. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_stats_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12EncoderStats12cpuTimeBeginE">
|
||
<span id="bgfx::EncoderStats::cpuTimeBegin__int64_t"></span><span class="target" id="structbgfx_1_1_encoder_stats_1a2bd30a1424393fb1aa91ad0e9bc9d97b"></span>int64_t <code class="descname">cpuTimeBegin</code><a class="headerlink" href="#_CPPv2N4bgfx12EncoderStats12cpuTimeBeginE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#structbgfx_1_1_encoder"><span>Encoder</span></a> thread CPU submit begin time. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12EncoderStats10cpuTimeEndE">
|
||
<span id="bgfx::EncoderStats::cpuTimeEnd__int64_t"></span><span class="target" id="structbgfx_1_1_encoder_stats_1a543bd134253fe768a5165b361ab8cfa1"></span>int64_t <code class="descname">cpuTimeEnd</code><a class="headerlink" href="#_CPPv2N4bgfx12EncoderStats10cpuTimeEndE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#structbgfx_1_1_encoder"><span>Encoder</span></a> thread CPU submit end time. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="platform-specific">
|
||
<h3>Platform specific<a class="headerlink" href="#platform-specific" title="Permalink to this headline">¶</a></h3>
|
||
<p>These are platform specific APIs. It is only necessary to use these APIs in conjunction with
|
||
creating windows.</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11renderFrameE7int32_t">
|
||
<span id="bgfx::renderFrame__int32_t"></span><span class="target" id="namespacebgfx_1aa21b96113ad74bf31dd3d417ac5b3e52"></span><a class="reference internal" href="#_CPPv2N4bgfx11RenderFrameE" title="bgfx::RenderFrame">RenderFrame</a>::Enum <code class="descclassname">bgfx::</code><code class="descname">renderFrame</code><span class="sig-paren">(</span>int32_t <em>_msecs</em> = -1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11renderFrameE7int32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Render frame. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Current renderer state. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_render_frame"><span><span class="pre">bgfx::RenderFrame</span></span></a></code>.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd><code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1aa21b96113ad74bf31dd3d417ac5b3e52"><span><span class="pre">bgfx::renderFrame</span></span></a></code> is blocking call. It waits for <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> to be called from API thread to process frame. If timeout value is passed call will timeout and return even if <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> is not called.</dd>
|
||
<dt><strong>Warning</strong></dt>
|
||
<dd>This call should be only used on platforms that don’t allow creating separate rendering thread. If it is called before to <a class="reference internal" href="#namespacebgfx_1adbfa8f1399b23ba0bedeaea92441642b"><span>bgfx::init</span></a>, render thread won’t be created by <a class="reference internal" href="#namespacebgfx_1adbfa8f1399b23ba0bedeaea92441642b"><span>bgfx::init</span></a> call. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_msecs</span></code>: Timeout in milliseconds.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx11RenderFrameE">
|
||
<span id="bgfx::RenderFrame"></span><span class="target" id="structbgfx_1_1_render_frame"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">RenderFrame</code><a class="headerlink" href="#_CPPv2N4bgfx11RenderFrameE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Render frame enum. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_render_frame_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setPlatformDataERK12PlatformData">
|
||
<span id="bgfx::setPlatformData__PlatformDataCR"></span><span class="target" id="namespacebgfx_1a9f0a19eba5fb95835c7f53d5f2b129b3"></span>void <code class="descclassname">bgfx::</code><code class="descname">setPlatformData</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx12PlatformDataE" title="bgfx::PlatformData">PlatformData</a> &<em>_data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setPlatformDataERK12PlatformData" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set platform data. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Warning</strong></dt>
|
||
<dd>Must be called before <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1adbfa8f1399b23ba0bedeaea92441642b"><span><span class="pre">bgfx::init</span></span></a></code>.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_platform_data</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx12PlatformDataE">
|
||
<span id="bgfx::PlatformData"></span><span class="target" id="structbgfx_1_1_platform_data"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">PlatformData</code><a class="headerlink" href="#_CPPv2N4bgfx12PlatformDataE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Platform data. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_platform_data_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12PlatformData3ndtE">
|
||
<span id="bgfx::PlatformData::ndt__voidP"></span><span class="target" id="structbgfx_1_1_platform_data_1a4d7268028c9e8626ac3627f36e6331af"></span>void *<code class="descname">ndt</code><a class="headerlink" href="#_CPPv2N4bgfx12PlatformData3ndtE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Native display type. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12PlatformData3nwhE">
|
||
<span id="bgfx::PlatformData::nwh__voidP"></span><span class="target" id="structbgfx_1_1_platform_data_1a1469498f2e4159ab742666b46aaa38b7"></span>void *<code class="descname">nwh</code><a class="headerlink" href="#_CPPv2N4bgfx12PlatformData3nwhE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Native window handle. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12PlatformData7contextE">
|
||
<span id="bgfx::PlatformData::context__voidP"></span><span class="target" id="structbgfx_1_1_platform_data_1a8ebc31e06aae3ee5a7d18e3cac0adf9b"></span>void *<code class="descname">context</code><a class="headerlink" href="#_CPPv2N4bgfx12PlatformData7contextE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GL context, or D3D device. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12PlatformData10backBufferE">
|
||
<span id="bgfx::PlatformData::backBuffer__voidP"></span><span class="target" id="structbgfx_1_1_platform_data_1afe014138f2108ace1a4f72aaad1b0d4f"></span>void *<code class="descname">backBuffer</code><a class="headerlink" href="#_CPPv2N4bgfx12PlatformData10backBufferE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GL backbuffer, or D3D render target view. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12PlatformData12backBufferDSE">
|
||
<span id="bgfx::PlatformData::backBufferDS__voidP"></span><span class="target" id="structbgfx_1_1_platform_data_1ae1dce3718ab484415ac7b8377aec5dab"></span>void *<code class="descname">backBufferDS</code><a class="headerlink" href="#_CPPv2N4bgfx12PlatformData12backBufferDSE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Backbuffer depth/stencil. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15getInternalDataEv">
|
||
<span id="bgfx::getInternalData"></span><span class="target" id="namespacebgfx_1ab9a78921e4ee1ce8b06287cfc7062a7b"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx12InternalDataE" title="bgfx::InternalData">InternalData</a> *<code class="descclassname">bgfx::</code><code class="descname">getInternalData</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15getInternalDataEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get internal data for interop. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>It’s expected you understand some bgfx internals before you use this call.</dd>
|
||
<dt><strong>Warning</strong></dt>
|
||
<dd>Must be called only on render thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_internal_data</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx12InternalDataE">
|
||
<span id="bgfx::InternalData"></span><span class="target" id="structbgfx_1_1_internal_data"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">InternalData</code><a class="headerlink" href="#_CPPv2N4bgfx12InternalDataE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Internal data. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_internal_data_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12InternalData4capsE">
|
||
<span id="bgfx::InternalData::caps__CapsCP"></span><span class="target" id="structbgfx_1_1_internal_data_1ad0e12d34b057c2cf2b7d73ccb3d51a80"></span><em class="property">const</em> <em class="property">struct</em> <a class="reference internal" href="#_CPPv2N4bgfx4CapsE" title="bgfx::Caps">Caps</a> *<code class="descname">caps</code><a class="headerlink" href="#_CPPv2N4bgfx12InternalData4capsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renderer capabilities. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12InternalData7contextE">
|
||
<span id="bgfx::InternalData::context__voidP"></span><span class="target" id="structbgfx_1_1_internal_data_1a9d5f68c848da64f6aa35335bfb1ef762"></span>void *<code class="descname">context</code><a class="headerlink" href="#_CPPv2N4bgfx12InternalData7contextE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GL context, or D3D device. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx16overrideInternalE13TextureHandle9uintptr_t">
|
||
<span id="bgfx::overrideInternal__TextureHandle.uintptr_t"></span><span class="target" id="namespacebgfx_1a92db2a02970fc179f13be201098dd589"></span>uintptr_t <code class="descclassname">bgfx::</code><code class="descname">overrideInternal</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, uintptr_t <em>_ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx16overrideInternalE13TextureHandle9uintptr_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Override internal texture with externally created texture. Previously created internal texture will released. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>It’s expected you understand some bgfx internals before you use this call.</dd>
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Native API pointer to texture. If result is 0, texture is not created yet from the main thread.</dd>
|
||
<dt><strong>Warning</strong></dt>
|
||
<dd>Must be called only on render thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_override_internal_texture_ptr</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">_ptr</span></code>: Native API pointer to texture.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx16overrideInternalE13TextureHandle8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_t">
|
||
<span id="bgfx::overrideInternal__TextureHandle.uint16_t.uint16_t.uint8_t.TextureFormat::Enum.uint32_t"></span><span class="target" id="namespacebgfx_1a6b011373b9c788a9cef104999f640665"></span>uintptr_t <code class="descclassname">bgfx::</code><code class="descname">overrideInternal</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint8_t <em>_numMips</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="#_CPPv2N4bgfx16overrideInternalE13TextureHandle8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Override internal texture by creating new texture. Previously created internal texture will released. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>It’s expected you understand some bgfx internals before you use this call.</dd>
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Native API pointer to texture. If result is 0, texture is not created yet from the main thread.</dd>
|
||
<dt><strong>Warning</strong></dt>
|
||
<dd>Must be called only on render thread.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_override_internal_texture</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">_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">_numMips</span></code>: Number of mip-maps. </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>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="miscellaneous">
|
||
<h3>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permalink to this headline">¶</a></h3>
|
||
<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="namespacebgfx_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> &<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 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 simple">
|
||
<li><code class="docutils literal"><span class="pre">_input</span></code>: Value to be packed into vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_inputNormalized</span></code>: True if input value is already normalized. </li>
|
||
<li><code class="docutils literal"><span class="pre">_attr</span></code>: Attribute to pack. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex stream declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Destination vertex stream where data will be packed. </li>
|
||
<li><code class="docutils literal"><span class="pre">_index</span></code>: Vertex index that will be modified.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12vertexUnpackEA4_fN6Attrib4EnumERK10VertexDeclPKv8uint32_t">
|
||
<span id="bgfx::vertexUnpack__floatA.Attrib::Enum.VertexDeclCR.voidCP.uint32_t"></span><span class="target" id="namespacebgfx_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> &<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 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 simple">
|
||
<li><code class="docutils literal"><span class="pre">_output</span></code>: Result of unpacking. </li>
|
||
<li><code class="docutils literal"><span class="pre">_attr</span></code>: Attribute to unpack. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex stream declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Source vertex stream from where data will be unpacked. </li>
|
||
<li><code class="docutils literal"><span class="pre">_index</span></code>: Vertex index that will be unpacked.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13vertexConvertERK10VertexDeclPvRK10VertexDeclPKv8uint32_t">
|
||
<span id="bgfx::vertexConvert__VertexDeclCR.voidP.VertexDeclCR.voidCP.uint32_t"></span><span class="target" id="namespacebgfx_1af941804b071ee62fefc45e5d80787701"></span>void <code class="descclassname">bgfx::</code><code class="descname">vertexConvert</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_destDecl</em>, void *<em>_destData</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_srcDecl</em>, <em class="property">const</em> void *<em>_srcData</em>, uint32_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13vertexConvertERK10VertexDeclPvRK10VertexDeclPKv8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Converts vertex stream data from one vertex stream format to another. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_convert</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_destDecl</span></code>: Destination vertex stream declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_destData</span></code>: Destination vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcDecl</span></code>: Source vertex stream declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcData</span></code>: Source vertex stream data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of vertices to convert from source to destination.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12weldVerticesEP8uint16_tRK10VertexDeclPKv8uint16_tf">
|
||
<span id="bgfx::weldVertices__uint16_tP.VertexDeclCR.voidCP.uint16_t.float"></span><span class="target" id="namespacebgfx_1a487ee942fc5775ecd46a7cc48f9e3bb0"></span>uint16_t <code class="descclassname">bgfx::</code><code class="descname">weldVertices</code><span class="sig-paren">(</span>uint16_t *<em>_output</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em>, <em class="property">const</em> void *<em>_data</em>, uint16_t <em>_num</em>, float <em>_epsilon</em> = 0.001f<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12weldVerticesEP8uint16_tRK10VertexDeclPKv8uint16_tf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Weld vertices. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Number of unique vertices after vertex welding.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_weld_vertices</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_output</span></code>: Welded vertices remapping table. The size of buffer must be the same as number of vertices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex stream declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_data</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of vertices in vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_epsilon</span></code>: Error tolerance for vertex position comparison. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvertE">
|
||
<span id="bgfx::TopologyConvert"></span><span class="target" id="structbgfx_1_1_topology_convert"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">TopologyConvert</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvertE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Topology conversion function. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_topology_convert_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvert4EnumE">
|
||
<span id="bgfx::TopologyConvert::Enum"></span><span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Topology conversion functions: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvert18TriListFlipWindingE">
|
||
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153af2abfef860edaf36065da1623f581d8a"></span><code class="descname">TriListFlipWinding</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert18TriListFlipWindingE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Flip winding order of triangle list. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvert19TriStripFlipWindingE">
|
||
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153ab15cde16196aa72a0fe0bad4f389669d"></span><code class="descname">TriStripFlipWinding</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert19TriStripFlipWindingE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Flip winding order of trinagle strip. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvert17TriListToLineListE">
|
||
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153a0cf4dc87b95b89d5633e151a286aaeb1"></span><code class="descname">TriListToLineList</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert17TriListToLineListE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Convert triangle list to line list. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvert17TriStripToTriListE">
|
||
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153a85625c725665071c56f097237a5d3d24"></span><code class="descname">TriStripToTriList</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert17TriStripToTriListE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Convert triangle strip to triangle list. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvert19LineStripToLineListE">
|
||
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153a769b8c438cb40e80f4cafa654dc91c82"></span><code class="descname">LineStripToLineList</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert19LineStripToLineListE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Convert line strip to line list. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx15TopologyConvert5CountE">
|
||
<span class="target" id="structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153a6e2c38c108d7e6d9c8468bc33c13203d"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx15TopologyConvert5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15topologyConvertEN15TopologyConvert4EnumEPv8uint32_tPKv8uint32_tb">
|
||
<span id="bgfx::topologyConvert__TopologyConvert::Enum.voidP.uint32_t.voidCP.uint32_t.b"></span><span class="target" id="namespacebgfx_1a4faf0379f4f649826fa82616a84a4b13"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">topologyConvert</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx15TopologyConvertE" title="bgfx::TopologyConvert">TopologyConvert</a>::<a class="reference internal" href="#_CPPv2N4bgfx15TopologyConvert4EnumE" title="bgfx::TopologyConvert::Enum">Enum</a> <em>_conversion</em>, void *<em>_dst</em>, uint32_t <em>_dstSize</em>, <em class="property">const</em> void *<em>_indices</em>, uint32_t <em>_numIndices</em>, bool <em>_index32</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15topologyConvertEN15TopologyConvert4EnumEPv8uint32_tPKv8uint32_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Convert index buffer for use with different primitive topologies. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Number of output indices after conversion.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_topology_convert</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_conversion</span></code>: Conversion type, see <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_topology_convert_1acc544033627edfbc7c30a75a58ace153"><span><span class="pre">TopologyConvert::Enum</span></span></a></code>. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dst</span></code>: Destination index buffer. If this argument is NULL function will return number of indices after conversion. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstSize</span></code>: Destination index buffer in bytes. It must be large enough to contain output indices. If destination size is insufficient index buffer will be truncated. </li>
|
||
<li><code class="docutils literal"><span class="pre">_indices</span></code>: Source indices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of input indices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_index32</span></code>: Set to <code class="docutils literal"><span class="pre">true</span></code> if input indices are 32-bit.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx12TopologySortE">
|
||
<span id="bgfx::TopologySort"></span><span class="target" id="structbgfx_1_1_topology_sort"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">TopologySort</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySortE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Topology sort order. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_topology_sort_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx12TopologySort4EnumE">
|
||
<span id="bgfx::TopologySort::Enum"></span><span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Topology sort order: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort23DirectionFrontToBackMinE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1a9f867f8e9b573e9ed8beae01282ee39b"></span><code class="descname">DirectionFrontToBackMin</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort23DirectionFrontToBackMinE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort23DirectionFrontToBackAvgE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1ac03583c71a152650400eab4eca63df2c"></span><code class="descname">DirectionFrontToBackAvg</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort23DirectionFrontToBackAvgE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort23DirectionFrontToBackMaxE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1af5703228e2266d9a8d499bfe0aafecee"></span><code class="descname">DirectionFrontToBackMax</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort23DirectionFrontToBackMaxE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort23DirectionBackToFrontMinE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1a5f27bd27ae8dc25200e8f626c727e92d"></span><code class="descname">DirectionBackToFrontMin</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort23DirectionBackToFrontMinE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort23DirectionBackToFrontAvgE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1a9e62475043c1158962cec9aa56c31447"></span><code class="descname">DirectionBackToFrontAvg</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort23DirectionBackToFrontAvgE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort23DirectionBackToFrontMaxE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1acb9116e807b838f449db00449c4d1cbd"></span><code class="descname">DirectionBackToFrontMax</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort23DirectionBackToFrontMaxE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort22DistanceFrontToBackMinE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1a757e30b6ef8ace5e308a9b6b3368fc68"></span><code class="descname">DistanceFrontToBackMin</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort22DistanceFrontToBackMinE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort22DistanceFrontToBackAvgE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1aaab1225281f707f4036ba88fc0066a22"></span><code class="descname">DistanceFrontToBackAvg</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort22DistanceFrontToBackAvgE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort22DistanceFrontToBackMaxE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1a5c2f181aa35fd8ba9bdb0b0e637beaf1"></span><code class="descname">DistanceFrontToBackMax</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort22DistanceFrontToBackMaxE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort22DistanceBackToFrontMinE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1af56dda1e9beba76ddd5419e25b87a0f0"></span><code class="descname">DistanceBackToFrontMin</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort22DistanceBackToFrontMinE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort22DistanceBackToFrontAvgE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1af8535c276d3b2fb92f55c46625142fe8"></span><code class="descname">DistanceBackToFrontAvg</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort22DistanceBackToFrontAvgE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort22DistanceBackToFrontMaxE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1ae7af947893a64ae25f2c5308d768e84d"></span><code class="descname">DistanceBackToFrontMax</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort22DistanceBackToFrontMaxE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx12TopologySort5CountE">
|
||
<span class="target" id="structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1a112dbbc1ca07323eba9eb361cd1b603e"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx12TopologySort5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx19topologySortTriListEN12TopologySort4EnumEPv8uint32_tA3_KfA3_KfPKv8uint32_tPKv8uint32_tb">
|
||
<span id="bgfx::topologySortTriList__TopologySort::Enum.voidP.uint32_t.floatCA.floatCA.voidCP.uint32_t.voidCP.uint32_t.b"></span><span class="target" id="namespacebgfx_1af481c92a166263933b649eced719228d"></span>void <code class="descclassname">bgfx::</code><code class="descname">topologySortTriList</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx12TopologySortE" title="bgfx::TopologySort">TopologySort</a>::<a class="reference internal" href="#_CPPv2N4bgfx12TopologySort4EnumE" title="bgfx::TopologySort::Enum">Enum</a> <em>_sort</em>, void *<em>_dst</em>, uint32_t <em>_dstSize</em>, <em class="property">const</em> float <em>_dir</em>[3], <em class="property">const</em> float <em>_pos</em>[3], <em class="property">const</em> void *<em>_vertices</em>, uint32_t <em>_stride</em>, <em class="property">const</em> void *<em>_indices</em>, uint32_t <em>_numIndices</em>, bool <em>_index32</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx19topologySortTriListEN12TopologySort4EnumEPv8uint32_tA3_KfA3_KfPKv8uint32_tPKv8uint32_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sort indices. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_topology_sort_tri_list</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_sort</span></code>: Sort order, see <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_topology_sort_1a0c0c13fee2b99a20af8486ee9f734af1"><span><span class="pre">TopologySort::Enum</span></span></a></code>. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dst</span></code>: Destination index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstSize</span></code>: Destination index buffer in bytes. It must be large enough to contain output indices. If destination size is insufficient index buffer will be truncated. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dir</span></code>: Direction (vector must be normalized). </li>
|
||
<li><code class="docutils literal"><span class="pre">_pos</span></code>: Position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_vertices</span></code>: Pointer to first vertex represented as float x, y, z. Must contain at least number of vertices referencende by index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_stride</span></code>: Vertex stride. </li>
|
||
<li><code class="docutils literal"><span class="pre">_indices</span></code>: Source indices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of input indices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_index32</span></code>: Set to <code class="docutils literal"><span class="pre">true</span></code> if input indices are 32-bit.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7discardEv">
|
||
<span id="bgfx::discard"></span><span class="target" id="namespacebgfx_1a0c43481c7f94a51e14842b3971e21c54"></span>void <code class="descclassname">bgfx::</code><code class="descname">discard</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7discardEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Discard all previously set state for draw or compute call. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_discard</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx5touchE6ViewId">
|
||
<span id="bgfx::touch__ViewId"></span><span class="target" id="namespacebgfx_1aff2b109acf8d4f26daf0c494938837e3"></span>void <code class="descclassname">bgfx::</code><code class="descname">touch</code><span class="sig-paren">(</span>ViewId <em>_id</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5touchE6ViewId" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Submit an empty primitive for rendering. Uniforms and draw state will be applied but no geometry will be submitted. </p>
|
||
<p>These empty draw calls will sort before ordinary draw calls.</p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_touch</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setPaletteColorE7uint8_t8uint32_t">
|
||
<span id="bgfx::setPaletteColor__uint8_t.uint32_t"></span><span class="target" id="namespacebgfx_1ad4ec3f3f2af1b2d69ec0eeefe960c2f0"></span>void <code class="descclassname">bgfx::</code><code class="descname">setPaletteColor</code><span class="sig-paren">(</span>uint8_t <em>_index</em>, uint32_t <em>_rgba</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setPaletteColorE7uint8_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set palette color value. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_palette_color</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_index</span></code>: Index into palette. </li>
|
||
<li><code class="docutils literal"><span class="pre">_rgba</span></code>: Packed 32-bit RGBA value.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setPaletteColorE7uint8_tA4_Kf">
|
||
<span id="bgfx::setPaletteColor__uint8_t.floatCA"></span><span class="target" id="namespacebgfx_1acd59d0793b3776296a4867ab73338177"></span>void <code class="descclassname">bgfx::</code><code class="descname">setPaletteColor</code><span class="sig-paren">(</span>uint8_t <em>_index</em>, <em class="property">const</em> float <em>_rgba</em>[4]<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setPaletteColorE7uint8_tA4_Kf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set palette color value. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_palette_color</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_index</span></code>: Index into palette. </li>
|
||
<li><code class="docutils literal"><span class="pre">_rgba</span></code>: RGBA floating point value.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setPaletteColorE7uint8_tffff">
|
||
<span id="bgfx::setPaletteColor__uint8_t.float.float.float.float"></span><span class="target" id="namespacebgfx_1a5484a3d28fd5570f6c5920bc584f5fd6"></span>void <code class="descclassname">bgfx::</code><code class="descname">setPaletteColor</code><span class="sig-paren">(</span>uint8_t <em>_index</em>, float <em>_r</em>, float <em>_g</em>, float <em>_b</em>, float <em>_a</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setPaletteColorE7uint8_tffff" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set palette color value. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_palette_color</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_index</span></code>: Index into palette. </li>
|
||
<li><code class="docutils literal"><span class="pre">_r</span><span class="pre">_g</span><span class="pre">_b</span><span class="pre">_a</span></code>: RGBA floating point values.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17requestScreenShotE17FrameBufferHandlePKc">
|
||
<span id="bgfx::requestScreenShot__FrameBufferHandle.cCP"></span><span class="target" id="namespacebgfx_1acbe6cfb0c11285b9f4a4969d1e3a71d6"></span>void <code class="descclassname">bgfx::</code><code class="descname">requestScreenShot</code><span class="sig-paren">(</span>FrameBufferHandle <em>_handle</em>, <em class="property">const</em> char *<em>_filePath</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17requestScreenShotE17FrameBufferHandlePKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Request screen shot of window back buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd><code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"><span><span class="pre">bgfx::CallbackI::screenShot</span></span></a></code> must be implemented.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Frame buffer handle must be created with OS’ target native window handle. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_request_screen_shot</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>: Frame buffer handle. If handle is <code class="docutils literal"><span class="pre">BGFX_INVALID_HANDLE</span></code> request will be made for main window back buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_filePath</span></code>: Will be passed to <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"><span><span class="pre">bgfx::CallbackI::screenShot</span></span></a></code> callback.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="views">
|
||
<h2>Views<a class="headerlink" href="#views" title="Permalink to this headline">¶</a></h2>
|
||
<p>View is primary sorting mechanism in bgfx. View represent bucket of draw and compute calls. Compute
|
||
and draw calls inside bucket are sorted in the way that all compute calls are executed before draw
|
||
calls. Compute calls are always in order of submission, while draw calls are sorted by internal
|
||
state if view is not in sequential mode. In the most of cases when z-buffer is used this change in
|
||
order is not noticable to desired output. In cases where order has to be preserved (for example in
|
||
rendering GUIs), view can be set to be in sequential order. Sequential order is less efficient,
|
||
because it doesn’t allow state change optimization, and should be avoided when possible.</p>
|
||
<p>By default views ids are sorted in ascending order. For dynamic renderers where order might not be
|
||
known until the last moment, view ids can be remaped to arbitrary order by calling
|
||
<cite>bgfx::setViewOrder</cite>.</p>
|
||
<p>View state is preserved between multiple frames.</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11setViewNameE6ViewIdPKc">
|
||
<span id="bgfx::setViewName__ViewId.cCP"></span><span class="target" id="namespacebgfx_1af08d8fae9b2a2ceff9debcf25c0966fb"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewName</code><span class="sig-paren">(</span>ViewId <em>_id</em>, <em class="property">const</em> char *<em>_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11setViewNameE6ViewIdPKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view name. </p>
|
||
<p>
|
||
In graphics debugger view name will appear as: <div class="highlight-python"><div class="highlight"><pre>"nnnce <view name>"
|
||
^ ^^ ^
|
||
| |+-- eye (L/R)
|
||
| +--- compute (C)
|
||
+------ view id
|
||
</pre></div>
|
||
</div>
|
||
<dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>This is debug only feature.</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_name</span></code>: View name.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_name</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11setViewRectE6ViewId8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::setViewRect__ViewId.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="namespacebgfx_1a3359fac48262c25cc7bebed179c0e0b0"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewRect</code><span class="sig-paren">(</span>ViewId <em>_id</em>, uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11setViewRectE6ViewId8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view rectangle. Draw primitive outside view will be clipped. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_rect</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: Position x from the left corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Position y from the top corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of view port region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of view port region.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11setViewRectE6ViewId8uint16_t8uint16_tN15BackbufferRatio4EnumE">
|
||
<span id="bgfx::setViewRect__ViewId.uint16_t.uint16_t.BackbufferRatio::Enum"></span><span class="target" id="namespacebgfx_1a97266f78aaaea47de5245eae918e49f8"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewRect</code><span class="sig-paren">(</span>ViewId <em>_id</em>, uint16_t <em>_x</em>, uint16_t <em>_y</em>, BackbufferRatio::Enum <em>_ratio</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11setViewRectE6ViewId8uint16_t8uint16_tN15BackbufferRatio4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view rectangle. Draw primitive outside view will be clipped. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_rect_auto</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: Position x from the left corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Position y from the top corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_ratio</span></code>: Width and height will be set in respect to back-buffer size. See: <code class="docutils literal"><span class="pre">BackbufferRatio::Enum</span></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setViewScissorE6ViewId8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::setViewScissor__ViewId.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="namespacebgfx_1a4c5184c35ba92387e4609f4919a35e05"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewScissor</code><span class="sig-paren">(</span>ViewId <em>_id</em>, uint16_t <em>_x</em> = 0, uint16_t <em>_y</em> = 0, uint16_t <em>_width</em> = 0, uint16_t <em>_height</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setViewScissorE6ViewId8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view scissor. Draw primitive outside view will be clipped. When _x, _y, _width and _height are set to 0, scissor will be disabled. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_scissor</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: Position x from the left corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Position y from the top corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of scissor region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of scissor region.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setViewClearE6ViewId8uint16_t8uint32_tf7uint8_t">
|
||
<span id="bgfx::setViewClear__ViewId.uint16_t.uint32_t.float.uint8_t"></span><span class="target" id="namespacebgfx_1aadac86f70437f5cf694b68e223520316"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewClear</code><span class="sig-paren">(</span>ViewId <em>_id</em>, uint16_t <em>_flags</em>, uint32_t <em>_rgba</em> = 0x000000ff, float <em>_depth</em> = 1.0f, uint8_t <em>_stencil</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setViewClearE6ViewId8uint16_t8uint32_tf7uint8_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view clear flags. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_clear</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Clear flags. Use <code class="docutils literal"><span class="pre">BGFX_CLEAR_NONE</span></code> to remove any clear operation. See: <code class="docutils literal"><span class="pre">BGFX_CLEAR_*</span></code>. </li>
|
||
<li><code class="docutils literal"><span class="pre">_rgba</span></code>: Color clear value. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth clear value. </li>
|
||
<li><code class="docutils literal"><span class="pre">_stencil</span></code>: Stencil clear value.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setViewClearE6ViewId8uint16_tf7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t">
|
||
<span id="bgfx::setViewClear__ViewId.uint16_t.float.uint8_t.uint8_t.uint8_t.uint8_t.uint8_t.uint8_t.uint8_t.uint8_t.uint8_t"></span><span class="target" id="namespacebgfx_1abf98809ca6f644a2e2fe80013675b054"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewClear</code><span class="sig-paren">(</span>ViewId <em>_id</em>, uint16_t <em>_flags</em>, float <em>_depth</em>, uint8_t <em>_stencil</em>, uint8_t <em>_0</em> = UINT8_MAX, uint8_t <em>_1</em> = UINT8_MAX, uint8_t <em>_2</em> = UINT8_MAX, uint8_t <em>_3</em> = UINT8_MAX, uint8_t <em>_4</em> = UINT8_MAX, uint8_t <em>_5</em> = UINT8_MAX, uint8_t <em>_6</em> = UINT8_MAX, uint8_t <em>_7</em> = UINT8_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setViewClearE6ViewId8uint16_tf7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view clear flags with different clear color for each frame buffer texture. Must use setClearColor to setup clear color palette. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_clear_mrt</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Clear flags. Use <code class="docutils literal"><span class="pre">BGFX_CLEAR_NONE</span></code> to remove any clear operation. See: <code class="docutils literal"><span class="pre">BGFX_CLEAR_*</span></code>. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth clear value. </li>
|
||
<li><code class="docutils literal"><span class="pre">_stencil</span></code>: Stencil clear value. </li>
|
||
<li><code class="docutils literal"><span class="pre">_0</span></code>: Palette index for frame buffer attachment 0. </li>
|
||
<li><code class="docutils literal"><span class="pre">_1</span></code>: Palette index for frame buffer attachment 1. </li>
|
||
<li><code class="docutils literal"><span class="pre">_2</span></code>: Palette index for frame buffer attachment 2. </li>
|
||
<li><code class="docutils literal"><span class="pre">_3</span></code>: Palette index for frame buffer attachment 3. </li>
|
||
<li><code class="docutils literal"><span class="pre">_4</span></code>: Palette index for frame buffer attachment 4. </li>
|
||
<li><code class="docutils literal"><span class="pre">_5</span></code>: Palette index for frame buffer attachment 5. </li>
|
||
<li><code class="docutils literal"><span class="pre">_6</span></code>: Palette index for frame buffer attachment 6. </li>
|
||
<li><code class="docutils literal"><span class="pre">_7</span></code>: Palette index for frame buffer attachment 7.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx8ViewModeE">
|
||
<span id="bgfx::ViewMode"></span><span class="target" id="structbgfx_1_1_view_mode"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">ViewMode</code><a class="headerlink" href="#_CPPv2N4bgfx8ViewModeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>View mode sets draw call sort order. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_view_mode_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx8ViewMode4EnumE">
|
||
<span id="bgfx::ViewMode::Enum"></span><span class="target" id="structbgfx_1_1_view_mode_1a4b88760e456f6cf104c9e49d171c91aa"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx8ViewMode4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>View modes: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx8ViewMode7DefaultE">
|
||
<span class="target" id="structbgfx_1_1_view_mode_1a4b88760e456f6cf104c9e49d171c91aaacc189b62f09dcf003826e409009ec906"></span><code class="descname">Default</code><a class="headerlink" href="#_CPPv2N4bgfx8ViewMode7DefaultE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default sort order. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx8ViewMode10SequentialE">
|
||
<span class="target" id="structbgfx_1_1_view_mode_1a4b88760e456f6cf104c9e49d171c91aaa8f3111e262d32c305a93b447fd7326d3"></span><code class="descname">Sequential</code><a class="headerlink" href="#_CPPv2N4bgfx8ViewMode10SequentialE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sort in the same order in which submit calls were called. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx8ViewMode14DepthAscendingE">
|
||
<span class="target" id="structbgfx_1_1_view_mode_1a4b88760e456f6cf104c9e49d171c91aaa6700d02ac6b36c9e1874bfd4462780db"></span><code class="descname">DepthAscending</code><a class="headerlink" href="#_CPPv2N4bgfx8ViewMode14DepthAscendingE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sort draw call depth in ascending order. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx8ViewMode15DepthDescendingE">
|
||
<span class="target" id="structbgfx_1_1_view_mode_1a4b88760e456f6cf104c9e49d171c91aaae89536701b2d0a969706fac6c2017db1"></span><code class="descname">DepthDescending</code><a class="headerlink" href="#_CPPv2N4bgfx8ViewMode15DepthDescendingE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sort draw call depth in descending order. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx8ViewMode5CountE">
|
||
<span class="target" id="structbgfx_1_1_view_mode_1a4b88760e456f6cf104c9e49d171c91aaafbbc12d1b61d713f30a996bc296bda11"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx8ViewMode5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11setViewModeE6ViewIdN8ViewMode4EnumE">
|
||
<span id="bgfx::setViewMode__ViewId.ViewMode::Enum"></span><span class="target" id="namespacebgfx_1ac351af2c0188891568b9c5ec09122d9b"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewMode</code><span class="sig-paren">(</span>ViewId <em>_id</em>, <a class="reference internal" href="#_CPPv2N4bgfx8ViewModeE" title="bgfx::ViewMode">ViewMode</a>::<a class="reference internal" href="#_CPPv2N4bgfx8ViewMode4EnumE" title="bgfx::ViewMode::Enum">Enum</a> <em>_mode</em> = ViewMode::Default<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11setViewModeE6ViewIdN8ViewMode4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view sorting mode. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>View mode must be set prior calling <code class="docutils literal"><span class="pre">bgfx::submit</span></code> for the view.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_mode</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mode</span></code>: View sort mode. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_view_mode_1a4b88760e456f6cf104c9e49d171c91aa"><span><span class="pre">ViewMode::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx18setViewFrameBufferE6ViewId17FrameBufferHandle">
|
||
<span id="bgfx::setViewFrameBuffer__ViewId.FrameBufferHandle"></span><span class="target" id="namespacebgfx_1a25661fb8ab782ebc22ccfe10fe19e016"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewFrameBuffer</code><span class="sig-paren">(</span>ViewId <em>_id</em>, FrameBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx18setViewFrameBufferE6ViewId17FrameBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view frame buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Not persistent after <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1acbf49c89c8ed64ac2ce9fbb08a52f7ab"><span><span class="pre">bgfx::reset</span></span></a></code> call.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_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">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Frame buffer handle. Passing <code class="docutils literal"><span class="pre">BGFX_INVALID_HANDLE</span></code> as frame buffer handle will draw primitives from this view into default back buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx16setViewTransformE6ViewIdPKvPKv">
|
||
<span id="bgfx::setViewTransform__ViewId.voidCP.voidCP"></span><span class="target" id="namespacebgfx_1acf30c922e9a1abd12f3af7277a873b3f"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewTransform</code><span class="sig-paren">(</span>ViewId <em>_id</em>, <em class="property">const</em> void *<em>_view</em>, <em class="property">const</em> void *<em>_proj</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx16setViewTransformE6ViewIdPKvPKv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view view and projection matrices, all draw primitives in this view will use these matrices. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_transform</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_view</span></code>: View matrix. </li>
|
||
<li><code class="docutils literal"><span class="pre">_projProjection</span></code>: matrix.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setViewOrderE6ViewId8uint16_tPK6ViewId">
|
||
<span id="bgfx::setViewOrder__ViewId.uint16_t.ViewIdCP"></span><span class="target" id="namespacebgfx_1a03baba7d5b3b640b82904a7b4c57d6b4"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewOrder</code><span class="sig-paren">(</span>ViewId <em>_id</em> = 0, uint16_t <em>_num</em> = UINT16_MAX, <em class="property">const</em> ViewId *<em>_remap</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setViewOrderE6ViewId8uint16_tPK6ViewId" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Post submit view reordering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_order</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: First view id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of views to remap. </li>
|
||
<li><code class="docutils literal"><span class="pre">_remap</span></code>: View remap id table. Passing <code class="docutils literal"><span class="pre">NULL</span></code> will reset view ids to default state.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9resetViewE6ViewId">
|
||
<span id="bgfx::resetView__ViewId"></span><span class="target" id="namespacebgfx_1a9346ecd01e2f32d41a0824be501d818c"></span>void <code class="descclassname">bgfx::</code><code class="descname">resetView</code><span class="sig-paren">(</span>ViewId <em>_id</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9resetViewE6ViewId" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reset all view settings to default. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_reset_view</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="encoder">
|
||
<h2>Encoder<a class="headerlink" href="#encoder" title="Permalink to this headline">¶</a></h2>
|
||
<div class="section" id="id1">
|
||
<h3>Encoder<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
|
||
<p>API for multi-threaded submission.</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx5beginEb">
|
||
<span id="bgfx::begin__b"></span><span class="target" id="namespacebgfx_1ab17077b57dbb5f1aba9911aca555d100"></span><a class="reference internal" href="#_CPPv2N4bgfx7EncoderE" title="bgfx::Encoder">Encoder</a> *<code class="descclassname">bgfx::</code><code class="descname">begin</code><span class="sig-paren">(</span>bool <em>_forThread</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5beginEb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Begin submitting draw calls from thread. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_forThread</span></code>: Explicitly request an encoder for a worker thread. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx3endEP7Encoder">
|
||
<span id="bgfx::end__EncoderP"></span><span class="target" id="namespacebgfx_1aa107fa4aeb1da2eb1f8984fd6b4aa195"></span>void <code class="descclassname">bgfx::</code><code class="descname">end</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx7EncoderE" title="bgfx::Encoder">Encoder</a> *<em>_encoder</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx3endEP7Encoder" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>End submitting draw calls from thread. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx7EncoderE">
|
||
<span id="bgfx::Encoder"></span><span class="target" id="structbgfx_1_1_encoder"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Encoder</code><a class="headerlink" href="#_CPPv2N4bgfx7EncoderE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Encoders are used for submitting draw calls from multiple threads. Only one encoder per thread should be used. Use <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1ab17077b57dbb5f1aba9911aca555d100"><span><span class="pre">bgfx::begin()</span></span></a></code> to obtain an encoder for a thread. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Functions</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder9setMarkerEPKc">
|
||
<span id="bgfx::Encoder::setMarker__cCP"></span><span class="target" id="structbgfx_1_1_encoder_1a29db6cb6d4cabce115dae0f6c8b0be6d"></span>void <code class="descname">setMarker</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_marker</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder9setMarkerEPKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets a debug marker. This allows you to group graphics calls together for easy browsing in graphics debugging tools. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_marker</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder8setStateE8uint64_t8uint32_t">
|
||
<span id="bgfx::Encoder::setState__uint64_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1ae0325e59abbf8628f5e4be92cb886160"></span>void <code class="descname">setState</code><span class="sig-paren">(</span>uint64_t <em>_state</em>, uint32_t <em>_rgba</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder8setStateE8uint64_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set render states for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd><ol class="arabic simple">
|
||
<li>To setup more complex states use: <code class="docutils literal"><span class="pre">BGFX_STATE_ALPHA_REF(_ref)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_POINT_SIZE(_size)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_FUNC(_src,</span> <span class="pre">_dst)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_FUNC_SEPARATE(_srcRGB,</span> <span class="pre">_dstRGB,</span> <span class="pre">_srcA,</span> <span class="pre">_dstA)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION(_equation)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION_SEPARATE(_equationRGB,</span> <span class="pre">_equationA)</span></code></li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION_ADD</span></code> is set when no other blend equation is specified.</li>
|
||
</ol>
|
||
</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_state</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_state</span></code>: State flags. Default state for primitive type is triangles. See: <code class="docutils literal"><span class="pre">BGFX_STATE_DEFAULT</span></code>.<ul>
|
||
<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_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>
|
||
</li>
|
||
<li><code class="docutils literal"><span class="pre">_rgba</span></code>: Sets blend factor used by <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_FACTOR</span></code> and <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_INV_FACTOR</span></code> blend modes.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder12setConditionE20OcclusionQueryHandleb">
|
||
<span id="bgfx::Encoder::setCondition__OcclusionQueryHandle.b"></span><span class="target" id="structbgfx_1_1_encoder_1acc5a16a11bcfd00a38983bd8b807eb11"></span>void <code class="descname">setCondition</code><span class="sig-paren">(</span>OcclusionQueryHandle <em>_handle</em>, bool <em>_visible</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder12setConditionE20OcclusionQueryHandleb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set condition for rendering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_condition</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>: Occlusion query handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_visible</span></code>: Render if occlusion query is visible.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder10setStencilE8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setStencil__uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a5bf00e5be9ad6cb946cffd519c63b432"></span>void <code class="descname">setStencil</code><span class="sig-paren">(</span>uint32_t <em>_fstencil</em>, uint32_t <em>_bstencil</em> = BGFX_STENCIL_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder10setStencilE8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set stencil test state. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_stencil</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_fstencil</span></code>: Front stencil state. </li>
|
||
<li><code class="docutils literal"><span class="pre">_bstencil</span></code>: Back stencil state. If back is set to <code class="docutils literal"><span class="pre">BGFX_STENCIL_NONE</span></code> _fstencil is applied to both front and back facing primitives.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder10setScissorE8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::Encoder::setScissor__uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1a37472617364a0c6db4f2229bcfe8ea62"></span>uint16_t <code class="descname">setScissor</code><span class="sig-paren">(</span>uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder10setScissorE8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set scissor for draw primitive. To scissor for all primitives in view see <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a4c5184c35ba92387e4609f4919a35e05"><span><span class="pre">bgfx::setViewScissor</span></span></a></code>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Scissor cache index.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_scissor</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: Position x from the left side of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Position y from the top of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of scissor region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of scissor region. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder10setScissorE8uint16_t">
|
||
<span id="bgfx::Encoder::setScissor__uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1a0d4775b75c096869e87072949029f36c"></span>void <code class="descname">setScissor</code><span class="sig-paren">(</span>uint16_t <em>_cache</em> = UINT16_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder10setScissorE8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set scissor from cache for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_scissor_cached</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_cache</span></code>: Index in scissor cache. Pass UINT16_MAX to have primitive use view scissor instead.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder12setTransformEPKv8uint16_t">
|
||
<span id="bgfx::Encoder::setTransform__voidCP.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1a429104d3ae2e43ca7f9fecd947427c76"></span>uint32_t <code class="descname">setTransform</code><span class="sig-paren">(</span><em class="property">const</em> void *<em>_mtx</em>, uint16_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder12setTransformEPKv8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set model matrix for draw primitive. If it is not called, model will be rendered with identity model matrix. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Index into matrix cache in case the same model matrix has to be used for other draw primitive call.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_transform</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_mtx</span></code>: Pointer to first matrix in array. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of matrices in array. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14allocTransformEP9Transform8uint16_t">
|
||
<span id="bgfx::Encoder::allocTransform__TransformP.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1ab9e5be71b42efd0af21d1686eb1c350c"></span>uint32_t <code class="descname">allocTransform</code><span class="sig-paren">(</span>Transform *<em>_transform</em>, uint16_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14allocTransformEP9Transform8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reserve <code class="docutils literal"><span class="pre">_num</span></code> matrices in internal matrix cache. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Index into matrix cache.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Pointer returned can be modifed until <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> is called. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_alloc_transform</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_transform</span></code>: Pointer to <code class="docutils literal"><span class="pre">Transform</span></code> structure. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of matrices. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder12setTransformE8uint32_t8uint16_t">
|
||
<span id="bgfx::Encoder::setTransform__uint32_t.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1ac998aeaafffec67a147d158f68333f67"></span>void <code class="descname">setTransform</code><span class="sig-paren">(</span>uint32_t <em>_cache</em>, uint16_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder12setTransformE8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set model matrix from matrix cache for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_transform_cached</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_cache</span></code>: Index in matrix cache. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of matrices from cache.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder10setUniformE13UniformHandlePKv8uint16_t">
|
||
<span id="bgfx::Encoder::setUniform__UniformHandle.voidCP.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1a0cb3b27753bbbfd722344d47023de07e"></span>void <code class="descname">setUniform</code><span class="sig-paren">(</span>UniformHandle <em>_handle</em>, <em class="property">const</em> void *<em>_value</em>, uint16_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder10setUniformE13UniformHandlePKv8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set shader uniform parameter for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_uniform</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>: Uniform. </li>
|
||
<li><code class="docutils literal"><span class="pre">_value</span></code>: Pointer to uniform data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of elements. Passing <code class="docutils literal"><span class="pre">UINT16_MAX</span></code> will use the _num passed on uniform creation.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferE17IndexBufferHandle">
|
||
<span id="bgfx::Encoder::setIndexBuffer__IndexBufferHandle"></span><span class="target" id="structbgfx_1_1_encoder_1a29b6203c38cfe6faf584d5dc458a24dc"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferE17IndexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_index_buffer</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>: Index buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setIndexBuffer__IndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1ae89b8f384c1fa58345b8e0d6d4c6d5dd"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_index_buffer</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>: Index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_firstIndex</span></code>: First index to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of indices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferE24DynamicIndexBufferHandle">
|
||
<span id="bgfx::Encoder::setIndexBuffer__DynamicIndexBufferHandle"></span><span class="target" id="structbgfx_1_1_encoder_1aeb7869c500e780b84de6342bd2b70ae0"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferE24DynamicIndexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_dynamic_index_buffer</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>: Dynamic index buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setIndexBuffer__DynamicIndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1aff23b1df245c0bf5400bb5b9609a75a1"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_dynamic_index_buffer</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>: Dynamic index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_firstIndex</span></code>: First index to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of indices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer">
|
||
<span id="bgfx::Encoder::setIndexBuffer__TransientIndexBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1a111617d3f649d957be50b91079a9c052"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientIndexBuffer *<em>_tib</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_transient_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_tib</span></code>: Transient index buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a2a2273ecc04472bd1c6fe9c0c05e530f"></span>void <code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientIndexBuffer *<em>_tib</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_transient_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_tib</span></code>: Transient index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_firstIndex</span></code>: First index to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of indices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t18VertexBufferHandle">
|
||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.VertexBufferHandle"></span><span class="target" id="structbgfx_1_1_encoder_1a7187107e8a5f8daa48a97482582f66c1"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, VertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t18VertexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Vertex buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t18VertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.VertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1aa72e2d3343575591c2d4bfcf6e002a73"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, VertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t18VertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startVertex</span></code>: First vertex to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t25DynamicVertexBufferHandle">
|
||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.DynamicVertexBufferHandle"></span><span class="target" id="structbgfx_1_1_encoder_1a85c20c041e5dca255f058aa91e434bc9"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, DynamicVertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t25DynamicVertexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_dynamic_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic vertex buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t25DynamicVertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.DynamicVertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a3f2a49c7879a7b56e8606ca289c367e1"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_t25DynamicVertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_dynamic_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startVertex</span></code>: First vertex to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer">
|
||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.TransientVertexBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1a4d17b54519e2a8c8c2a806368df50080"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_transient_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_tvb</span></code>: Transient vertex buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setVertexBuffer__uint8_t.TransientVertexBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a6dd809b31661588edb32dcf0f5d3c61b"></span>void <code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_transient_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_tvb</span></code>: Transient vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startVertex</span></code>: First vertex to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder14setVertexCountE8uint32_t">
|
||
<span id="bgfx::Encoder::setVertexCount__uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a6bec8d7a72516210170abcd6b1fd98aa"></span>void <code class="descname">setVertexCount</code><span class="sig-paren">(</span>uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder14setVertexCountE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set number of vertices for auto generated vertices use in conjuction with gl_VertexID. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ID</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_vertex_count</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer">
|
||
<span id="bgfx::Encoder::setInstanceDataBuffer__InstanceDataBufferCP"></span><span class="target" id="structbgfx_1_1_encoder_1afadc5fbe3874159961d5552220328622"></span>void <code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> InstanceDataBuffer *<em>_idb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_instance_data_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_idb</span></code>: Transient instance data buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setInstanceDataBuffer__InstanceDataBufferCP.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1adf6c147ada3e5338eb517d0c33faf01d"></span>void <code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> InstanceDataBuffer *<em>_idb</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_instance_data_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_idb</span></code>: Transient instance data buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First instance data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of data instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder21setInstanceDataBufferE18VertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setInstanceDataBuffer__VertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1a67c4f46964ff32c170699939158434c5"></span>void <code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferE18VertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_instance_data_from_vertex_buffer</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>: Vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First instance data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of data instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder21setInstanceDataBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::setInstanceDataBuffer__DynamicVertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1af7464e8909bd5aa11811151c0650e56d"></span>void <code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder21setInstanceDataBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_instance_data_from_dynamic_vertex_buffer</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>: Vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First instance data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of data instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder16setInstanceCountE8uint32_t">
|
||
<span id="bgfx::Encoder::setInstanceCount__uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1ac8450ebbbf04678db6d2c59ea86178a8"></span>void <code class="descname">setInstanceCount</code><span class="sig-paren">(</span>uint32_t <em>_numInstances</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder16setInstanceCountE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set number of instances for auto generated instances use in conjuction with gl_InstanceID. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ID</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_instance_count</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_numInstances</span></code>: Number of instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t">
|
||
<span id="bgfx::Encoder::setTexture__uint8_t.UniformHandle.TextureHandle.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1ababcdc9b1bf89fe863573c5629c1ea31"></span>void <code class="descname">setTexture</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, UniformHandle <em>_sampler</em>, TextureHandle <em>_handle</em>, uint32_t <em>_flags</em> = UINT32_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set texture stage for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_texture</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Texture unit. </li>
|
||
<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_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>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder5touchE6ViewId">
|
||
<span id="bgfx::Encoder::touch__ViewId"></span><span class="target" id="structbgfx_1_1_encoder_1a57dd7836d684ce252f915fda652dd4d9"></span>void <code class="descname">touch</code><span class="sig-paren">(</span>ViewId <em>_id</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder5touchE6ViewId" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Submit an empty primitive for rendering. Uniforms and draw state will be applied but no geometry will be submitted. </p>
|
||
<p>These empty draw calls will sort before ordinary draw calls.</p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_touch</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle8uint32_tb">
|
||
<span id="bgfx::Encoder::submit__ViewId.ProgramHandle.uint32_t.b"></span><span class="target" id="structbgfx_1_1_encoder_1aebca0fd0e7043ee1448098c6ffb8c005"></span>void <code class="descname">submit</code><span class="sig-paren">(</span>ViewId <em>_id</em>, ProgramHandle <em>_program</em>, uint32_t <em>_depth</em> = 0, bool <em>_preserveState</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle8uint32_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Submit primitive for rendering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_submit</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_program</span></code>: Program. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth for sorting. </li>
|
||
<li><code class="docutils literal"><span class="pre">_preserveState</span></code>: Preserve internal draw state for next draw call submit.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle20OcclusionQueryHandle8uint32_tb">
|
||
<span id="bgfx::Encoder::submit__ViewId.ProgramHandle.OcclusionQueryHandle.uint32_t.b"></span><span class="target" id="structbgfx_1_1_encoder_1a3a34ee67df21dc3e319ee10d380cf658"></span>void <code class="descname">submit</code><span class="sig-paren">(</span>ViewId <em>_id</em>, ProgramHandle <em>_program</em>, OcclusionQueryHandle <em>_occlusionQuery</em>, uint32_t <em>_depth</em> = 0, bool <em>_preserveState</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle20OcclusionQueryHandle8uint32_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Submit primitive with occlusion query for rendering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_submit_occlusion_query</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_program</span></code>: Program. </li>
|
||
<li><code class="docutils literal"><span class="pre">_occlusionQuery</span></code>: Occlusion query. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth for sorting. </li>
|
||
<li><code class="docutils literal"><span class="pre">_preserveState</span></code>: Preserve internal draw state for next draw call submit.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t8uint32_tb">
|
||
<span id="bgfx::Encoder::submit__ViewId.ProgramHandle.IndirectBufferHandle.uint16_t.uint16_t.uint32_t.b"></span><span class="target" id="structbgfx_1_1_encoder_1a623269186c6f60577e7f5ea48040a9ef"></span>void <code class="descname">submit</code><span class="sig-paren">(</span>ViewId <em>_id</em>, ProgramHandle <em>_program</em>, IndirectBufferHandle <em>_indirectHandle</em>, uint16_t <em>_start</em> = 0, uint16_t <em>_num</em> = 1, uint32_t <em>_depth</em> = 0, bool <em>_preserveState</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder6submitE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t8uint32_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Submit primitive for rendering with index and instance data info from indirect buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_submit_indirect</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_program</span></code>: Program. </li>
|
||
<li><code class="docutils literal"><span class="pre">_indirectHandle</span></code>: Indirect buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First element in indirect buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of dispatches. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth for sorting. </li>
|
||
<li><code class="docutils literal"><span class="pre">_preserveState</span></code>: Preserve internal draw state for next draw call submit.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder9setBufferE7uint8_t17IndexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::Encoder::setBuffer__uint8_t.IndexBufferHandle.Access::Enum"></span><span class="target" id="structbgfx_1_1_encoder_1abbcd6de6e5e97a7fe957eda92ad0822f"></span>void <code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, IndexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder9setBufferE7uint8_t17IndexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_compute_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Index buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder9setBufferE7uint8_t18VertexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::Encoder::setBuffer__uint8_t.VertexBufferHandle.Access::Enum"></span><span class="target" id="structbgfx_1_1_encoder_1a5f7f342edc7994cd4d3bc490bc2fd871"></span>void <code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, VertexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder9setBufferE7uint8_t18VertexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_compute_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Vertex buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder9setBufferE7uint8_t24DynamicIndexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::Encoder::setBuffer__uint8_t.DynamicIndexBufferHandle.Access::Enum"></span><span class="target" id="structbgfx_1_1_encoder_1ac33eb79ca4276af07beeed8814d4cf8c"></span>void <code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, DynamicIndexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder9setBufferE7uint8_t24DynamicIndexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute dynamic index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_compute_dynamic_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic index buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder9setBufferE7uint8_t25DynamicVertexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::Encoder::setBuffer__uint8_t.DynamicVertexBufferHandle.Access::Enum"></span><span class="target" id="structbgfx_1_1_encoder_1a0a7b96ce730a411113f8701b2773df2c"></span>void <code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, DynamicVertexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder9setBufferE7uint8_t25DynamicVertexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute dynamic vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_compute_dynamic_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic vertex buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder9setBufferE7uint8_t20IndirectBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::Encoder::setBuffer__uint8_t.IndirectBufferHandle.Access::Enum"></span><span class="target" id="structbgfx_1_1_encoder_1a0b796ad4a8fdadaf1128f76d132f1d15"></span>void <code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, IndirectBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder9setBufferE7uint8_t20IndirectBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute indirect buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_compute_indirect_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Indirect buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder8setImageE7uint8_t13TextureHandle7uint8_tN6Access4EnumEN13TextureFormat4EnumE">
|
||
<span id="bgfx::Encoder::setImage__uint8_t.TextureHandle.uint8_t.Access::Enum.TextureFormat::Enum"></span><span class="target" id="structbgfx_1_1_encoder_1a93ccfe0d5e9ddf32373b1d5ecdd5b05e"></span>void <code class="descname">setImage</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, TextureHandle <em>_handle</em>, uint8_t <em>_mip</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</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> = TextureFormat::Count<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder8setImageE7uint8_t13TextureHandle7uint8_tN6Access4EnumEN13TextureFormat4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute image from texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_set_image</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Texture unit. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mip</span></code>: Mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Texture access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder8dispatchE6ViewId13ProgramHandle8uint32_t8uint32_t8uint32_t">
|
||
<span id="bgfx::Encoder::dispatch__ViewId.ProgramHandle.uint32_t.uint32_t.uint32_t"></span><span class="target" id="structbgfx_1_1_encoder_1ab1427bd12ce035ce0be59bde6a886bc7"></span>void <code class="descname">dispatch</code><span class="sig-paren">(</span>ViewId <em>_id</em>, ProgramHandle <em>_handle</em>, uint32_t <em>_numX</em> = 1, uint32_t <em>_numY</em> = 1, uint32_t <em>_numZ</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder8dispatchE6ViewId13ProgramHandle8uint32_t8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Dispatch compute. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_dispatch</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Compute program. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numX</span></code>: Number of groups X. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numY</span></code>: Number of groups Y. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numZ</span></code>: Number of groups Z. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: View flags. Use<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_VIEW_NONE</span></code> - View will be rendered only once if stereo mode is enabled.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_VIEW_STEREO</span></code> - View will be rendered for both eyes if stereo mode is enabled. When stereo mode is disabled this flag doesn’t have effect.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder8dispatchE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t">
|
||
<span id="bgfx::Encoder::dispatch__ViewId.ProgramHandle.IndirectBufferHandle.uint16_t.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1a26353fd863002e69370cec965543a07f"></span>void <code class="descname">dispatch</code><span class="sig-paren">(</span>ViewId <em>_id</em>, ProgramHandle <em>_handle</em>, IndirectBufferHandle <em>_indirectHandle</em>, uint16_t <em>_start</em> = 0, uint16_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder8dispatchE6ViewId13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Dispatch compute indirect. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_dispatch_indirect</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Compute program. </li>
|
||
<li><code class="docutils literal"><span class="pre">_indirectHandle</span></code>: Indirect buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First element in indirect buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of dispatches. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: View flags. Use<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_VIEW_NONE</span></code> - View will be rendered only once if stereo mode is enabled.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_VIEW_STEREO</span></code> - View will be rendered for both eyes if stereo mode is enabled. When stereo mode is disabled this flag doesn’t have effect.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder7discardEv">
|
||
<span id="bgfx::Encoder::discard"></span><span class="target" id="structbgfx_1_1_encoder_1adc633c7153e2da26c9449b2f37b3d60f"></span>void <code class="descname">discard</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder7discardEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Discard all previously set state for draw or compute call. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_discard</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder4blitE6ViewId13TextureHandle8uint16_t8uint16_t13TextureHandle8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::Encoder::blit__ViewId.TextureHandle.uint16_t.uint16_t.TextureHandle.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1a99af0d97b74d4ae3659088947e265761"></span>void <code class="descname">blit</code><span class="sig-paren">(</span>ViewId <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="#_CPPv2N4bgfx7Encoder4blitE6ViewId13TextureHandle8uint16_t8uint16_t13TextureHandle8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blit texture 2D region between two 2D textures. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Destination texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_blit</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dst</span></code>: Destination texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstX</span></code>: Destination texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstY</span></code>: Destination texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_src</span></code>: Source texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcX</span></code>: Source texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcY</span></code>: Source texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of region.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7Encoder4blitE6ViewId13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::Encoder::blit__ViewId.TextureHandle.uint8_t.uint16_t.uint16_t.uint16_t.TextureHandle.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="structbgfx_1_1_encoder_1a5bb0375324fcb6bb95d46a040f6caaf3"></span>void <code class="descname">blit</code><span class="sig-paren">(</span>ViewId <em>_id</em>, TextureHandle <em>_dst</em>, uint8_t <em>_dstMip</em>, uint16_t <em>_dstX</em>, uint16_t <em>_dstY</em>, uint16_t <em>_dstZ</em>, TextureHandle <em>_src</em>, uint8_t <em>_srcMip</em> = 0, uint16_t <em>_srcX</em> = 0, uint16_t <em>_srcY</em> = 0, uint16_t <em>_srcZ</em> = 0, uint16_t <em>_width</em> = UINT16_MAX, uint16_t <em>_height</em> = UINT16_MAX, uint16_t <em>_depth</em> = UINT16_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7Encoder4blitE6ViewId13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blit texture region between two textures. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Destination texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_encoder_blit</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dst</span></code>: Destination texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstMip</span></code>: Destination texture mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstX</span></code>: Destination texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstY</span></code>: Destination texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstZ</span></code>: If texture is 2D this argument should be 0. If destination texture is cube this argument represents destination texture cube face. For 3D texture this argument represents destination texture Z position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_src</span></code>: Source texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcMip</span></code>: Source texture mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcX</span></code>: Source texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcY</span></code>: Source texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcZ</span></code>: If texture is 2D this argument should be 0. If source texture is cube this argument represents source texture cube face. For 3D texture this argument represents source texture Z position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: If texture is 3D this argument represents depth of region, otherwise it’s unused.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="draw">
|
||
<h3>Draw<a class="headerlink" href="#draw" title="Permalink to this headline">¶</a></h3>
|
||
<p>Draw state is not preserved between two draw calls. All state is cleared after calling
|
||
<cite>bgfx::submit</cite>.</p>
|
||
<div class="section" id="id2">
|
||
<h4>Debug<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setMarkerEPKc">
|
||
<span id="bgfx::setMarker__cCP"></span><span class="target" id="namespacebgfx_1a826b5408b0fe0e104625e179e115576b"></span>void <code class="descclassname">bgfx::</code><code class="descname">setMarker</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_marker</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9setMarkerEPKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets debug marker. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_marker</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<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’s expected that _name is zero terminated string.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</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’s expected that _name is zero terminated string.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="state">
|
||
<h4>State<a class="headerlink" href="#state" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8setStateE8uint64_t8uint32_t">
|
||
<span id="bgfx::setState__uint64_t.uint32_t"></span><span class="target" id="namespacebgfx_1a3e5edf50886f88e8f022e18a3e53ba4d"></span>void <code class="descclassname">bgfx::</code><code class="descname">setState</code><span class="sig-paren">(</span>uint64_t <em>_state</em>, uint32_t <em>_rgba</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8setStateE8uint64_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set render states for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd><ol class="arabic simple">
|
||
<li>To setup more complex states use: <code class="docutils literal"><span class="pre">BGFX_STATE_ALPHA_REF(_ref)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_POINT_SIZE(_size)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_FUNC(_src,</span> <span class="pre">_dst)</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_FUNC_SEPARATE(_srcRGB,</span> <span class="pre">_dstRGB,</span> <span class="pre">_srcA,</span> <span class="pre">_dstA)</span></code> <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION(_equation)</span></code> <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION_SEPARATE(_equationRGB,</span> <span class="pre">_equationA)</span></code></li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION_ADD</span></code> is set when no other blend equation is specified.</li>
|
||
</ol>
|
||
</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_state</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_state</span></code>: State flags. Default state for primitive type is triangles. See: <code class="docutils literal"><span class="pre">BGFX_STATE_DEFAULT</span></code>.<ul>
|
||
<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_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>
|
||
</li>
|
||
<li><code class="docutils literal"><span class="pre">_rgba</span></code>: Sets blend factor used by <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_FACTOR</span></code> and <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_INV_FACTOR</span></code> blend modes.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="state-flags">
|
||
<h4>State Flags<a class="headerlink" href="#state-flags" title="Permalink to this headline">¶</a></h4>
|
||
<p><strong>Write</strong></p>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_WRITE_R">
|
||
<span class="target" id="defines_8h_1af089d9292e8742a9bbc8f31e9959ac8f"></span><code class="descname">BGFX_STATE_WRITE_R</code><a class="headerlink" href="#c.BGFX_STATE_WRITE_R" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Color RGB/alpha/depth write. When it’s not specified write will be disabled. </p>
|
||
<p>Enable R write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_WRITE_G">
|
||
<span class="target" id="defines_8h_1a67607d6d1f9a225c1b2ff4e9d12f815d"></span><code class="descname">BGFX_STATE_WRITE_G</code><a class="headerlink" href="#c.BGFX_STATE_WRITE_G" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable G write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_WRITE_B">
|
||
<span class="target" id="defines_8h_1acf95680646da08e7457c76f7f9eef258"></span><code class="descname">BGFX_STATE_WRITE_B</code><a class="headerlink" href="#c.BGFX_STATE_WRITE_B" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable B write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_WRITE_RGB">
|
||
<span class="target" id="defines_8h_1a62234af4b2f8561cc9f63625d2f87e13"></span><code class="descname">BGFX_STATE_WRITE_RGB</code><a class="headerlink" href="#c.BGFX_STATE_WRITE_RGB" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable RGB write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_WRITE_A">
|
||
<span class="target" id="defines_8h_1a83b7df77e4daba5f403757d272262f0e"></span><code class="descname">BGFX_STATE_WRITE_A</code><a class="headerlink" href="#c.BGFX_STATE_WRITE_A" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable alpha write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_WRITE_Z">
|
||
<span class="target" id="defines_8h_1a648e6de360193486206989233d94a7f7"></span><code class="descname">BGFX_STATE_WRITE_Z</code><a class="headerlink" href="#c.BGFX_STATE_WRITE_Z" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth write. </p>
|
||
</dd></dl>
|
||
|
||
<p><strong>Depth Test</strong></p>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_LESS">
|
||
<span class="target" id="defines_8h_1a82f539526fd6c6bcd358183eadff8aee"></span><code class="descname">BGFX_STATE_DEPTH_TEST_LESS</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_LESS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Depth test state. When <code class="docutils literal"><span class="pre">BGFX_STATE_DEPTH_</span></code> is not specified depth test will be disabled. </p>
|
||
<p>Enable depth test, less. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_LEQUAL">
|
||
<span class="target" id="defines_8h_1a338abca053787cd01d39109b8e8a9af5"></span><code class="descname">BGFX_STATE_DEPTH_TEST_LEQUAL</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_LEQUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth test, less or equal. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_EQUAL">
|
||
<span class="target" id="defines_8h_1ad208b703e5d4b4f59b7ffffecf9c9c83"></span><code class="descname">BGFX_STATE_DEPTH_TEST_EQUAL</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_EQUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth test, equal. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_GEQUAL">
|
||
<span class="target" id="defines_8h_1a2242d82ed1763b25c407663565f77c5b"></span><code class="descname">BGFX_STATE_DEPTH_TEST_GEQUAL</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_GEQUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth test, greater or equal. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_GREATER">
|
||
<span class="target" id="defines_8h_1a73192746d5c1af9691a62ff933b8dcc4"></span><code class="descname">BGFX_STATE_DEPTH_TEST_GREATER</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_GREATER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth test, greater. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_NOTEQUAL">
|
||
<span class="target" id="defines_8h_1a3fee8e3c5e964b83de7ccc48f2c622f9"></span><code class="descname">BGFX_STATE_DEPTH_TEST_NOTEQUAL</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_NOTEQUAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth test, not equal. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_NEVER">
|
||
<span class="target" id="defines_8h_1af07451bb52a9a7cdac6f7866eb8d3be8"></span><code class="descname">BGFX_STATE_DEPTH_TEST_NEVER</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_NEVER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth test, never. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_TEST_ALWAYS">
|
||
<span class="target" id="defines_8h_1a68a8a92967cc243e2709f9c847161944"></span><code class="descname">BGFX_STATE_DEPTH_TEST_ALWAYS</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_TEST_ALWAYS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth test, always. </p>
|
||
</dd></dl>
|
||
|
||
<p><strong>Blend Mode</strong></p>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_ZERO">
|
||
<span class="target" id="defines_8h_1a83c6a122447a96a550121522d24bffd0"></span><code class="descname">BGFX_STATE_BLEND_ZERO</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_ZERO" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use BGFX_STATE_BLEND_FUNC(_src, _dst) or BGFX_STATE_BLEND_FUNC_SEPARATE(_srcRGB, _dstRGB, _srcA, _dstA) helper macros. </p>
|
||
<p>0, 0, 0, 0 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_ONE">
|
||
<span class="target" id="defines_8h_1a4c95af5b187ce05923cace405c675ca7"></span><code class="descname">BGFX_STATE_BLEND_ONE</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_ONE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>1, 1, 1, 1 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_SRC_COLOR">
|
||
<span class="target" id="defines_8h_1aa47f521f6912a95bb27f9d88301a69f1"></span><code class="descname">BGFX_STATE_BLEND_SRC_COLOR</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_SRC_COLOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Rs, Gs, Bs, As. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_INV_SRC_COLOR">
|
||
<span class="target" id="defines_8h_1abde93bba126cc742dc4fdc7044b25578"></span><code class="descname">BGFX_STATE_BLEND_INV_SRC_COLOR</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_INV_SRC_COLOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>1-Rs, 1-Gs, 1-Bs, 1-As </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_SRC_ALPHA">
|
||
<span class="target" id="defines_8h_1a1b45f14c0d16f731be0c09aeb480ca48"></span><code class="descname">BGFX_STATE_BLEND_SRC_ALPHA</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_SRC_ALPHA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>As, As, As, As. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_INV_SRC_ALPHA">
|
||
<span class="target" id="defines_8h_1a5a97ef785bca9f4b8dbac77918487ced"></span><code class="descname">BGFX_STATE_BLEND_INV_SRC_ALPHA</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_INV_SRC_ALPHA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>1-As, 1-As, 1-As, 1-As </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_DST_ALPHA">
|
||
<span class="target" id="defines_8h_1a706fd845bc836aa9ffe4559765bb9610"></span><code class="descname">BGFX_STATE_BLEND_DST_ALPHA</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_DST_ALPHA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Ad, Ad, Ad, Ad. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_INV_DST_ALPHA">
|
||
<span class="target" id="defines_8h_1a58d78040bf888a9612a1c4e1cf9c21a6"></span><code class="descname">BGFX_STATE_BLEND_INV_DST_ALPHA</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_INV_DST_ALPHA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>1-Ad, 1-Ad, 1-Ad ,1-Ad </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_DST_COLOR">
|
||
<span class="target" id="defines_8h_1a7391b64b51d2b74c3c2ad517d2f6d4ff"></span><code class="descname">BGFX_STATE_BLEND_DST_COLOR</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_DST_COLOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Rd, Gd, Bd, Ad. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_INV_DST_COLOR">
|
||
<span class="target" id="defines_8h_1ac502ca5c583f0702a8c20405ca4f49cc"></span><code class="descname">BGFX_STATE_BLEND_INV_DST_COLOR</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_INV_DST_COLOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>1-Rd, 1-Gd, 1-Bd, 1-Ad </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_SRC_ALPHA_SAT">
|
||
<span class="target" id="defines_8h_1a6177100a26b919276943bf3a524820ca"></span><code class="descname">BGFX_STATE_BLEND_SRC_ALPHA_SAT</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_SRC_ALPHA_SAT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>f, f, f, 1; f = min(As, 1-Ad) </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_FACTOR">
|
||
<span class="target" id="defines_8h_1a9acab36d73abf4b321564049d85ce435"></span><code class="descname">BGFX_STATE_BLEND_FACTOR</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_FACTOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blend factor. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_INV_FACTOR">
|
||
<span class="target" id="defines_8h_1a14e3f8dcce6f420eeedb63f3978d9b36"></span><code class="descname">BGFX_STATE_BLEND_INV_FACTOR</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_INV_FACTOR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>1-Blend factor </p>
|
||
</dd></dl>
|
||
|
||
<p><strong>Blend Equaation</strong></p>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_EQUATION_ADD">
|
||
<span class="target" id="defines_8h_1a2ffd46032b927db10fcce998d1a3fddd"></span><code class="descname">BGFX_STATE_BLEND_EQUATION_ADD</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_EQUATION_ADD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Use BGFX_STATE_BLEND_EQUATION(_equation) or BGFX_STATE_BLEND_EQUATION_SEPARATE(_equationRGB, _equationA) helper macros. </p>
|
||
<p>Blend add: src + dst. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_EQUATION_SUB">
|
||
<span class="target" id="defines_8h_1a076e59b04d2620ad7177aa5fb1f88a72"></span><code class="descname">BGFX_STATE_BLEND_EQUATION_SUB</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_EQUATION_SUB" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blend subtract: src - dst. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_EQUATION_REVSUB">
|
||
<span class="target" id="defines_8h_1a1e33171674e13e6b2026eacaca5153ce"></span><code class="descname">BGFX_STATE_BLEND_EQUATION_REVSUB</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_EQUATION_REVSUB" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blend reverse subtract: dst - src. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_EQUATION_MIN">
|
||
<span class="target" id="defines_8h_1ada996865b2ed3b57838384365d0fd54f"></span><code class="descname">BGFX_STATE_BLEND_EQUATION_MIN</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_EQUATION_MIN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blend min: min(src, dst). </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_EQUATION_MAX">
|
||
<span class="target" id="defines_8h_1adc74502a8c753f009e2b4d64cb6ebeb6"></span><code class="descname">BGFX_STATE_BLEND_EQUATION_MAX</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_EQUATION_MAX" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blend max: max(src, dst). </p>
|
||
</dd></dl>
|
||
|
||
<p><strong>Primitive Culling</strong></p>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_CULL_CW">
|
||
<span class="target" id="defines_8h_1ab73af147b6161cea1a3d2e92940e0452"></span><code class="descname">BGFX_STATE_CULL_CW</code><a class="headerlink" href="#c.BGFX_STATE_CULL_CW" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Cull state. When <code class="docutils literal"><span class="pre">BGFX_STATE_CULL_*</span></code> is not specified culling will be disabled. </p>
|
||
<p>Cull clockwise triangles. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_CULL_CCW">
|
||
<span class="target" id="defines_8h_1adc22d33e1b38799d1c0da7d94123004d"></span><code class="descname">BGFX_STATE_CULL_CCW</code><a class="headerlink" href="#c.BGFX_STATE_CULL_CCW" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Cull counter-clockwise triangles. </p>
|
||
</dd></dl>
|
||
|
||
<p><strong>Primitive Type</strong></p>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_PT_TRISTRIP">
|
||
<span class="target" id="defines_8h_1a7b2bc219533a33b2010affe65087591f"></span><code class="descname">BGFX_STATE_PT_TRISTRIP</code><a class="headerlink" href="#c.BGFX_STATE_PT_TRISTRIP" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Tristrip. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_PT_LINES">
|
||
<span class="target" id="defines_8h_1adb0d8c8504ff0615c4fcfba6b55bfa57"></span><code class="descname">BGFX_STATE_PT_LINES</code><a class="headerlink" href="#c.BGFX_STATE_PT_LINES" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Lines. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_PT_LINESTRIP">
|
||
<span class="target" id="defines_8h_1a15538233471ae90244e5c52380f16270"></span><code class="descname">BGFX_STATE_PT_LINESTRIP</code><a class="headerlink" href="#c.BGFX_STATE_PT_LINESTRIP" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Line strip. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_PT_POINTS">
|
||
<span class="target" id="defines_8h_1ab4afe6a6879f20b9e5b7ce8e0d94bc1c"></span><code class="descname">BGFX_STATE_PT_POINTS</code><a class="headerlink" href="#c.BGFX_STATE_PT_POINTS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Points. </p>
|
||
</dd></dl>
|
||
|
||
<p><strong>Misc</strong></p>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_INDEPENDENT">
|
||
<span class="target" id="defines_8h_1a292f5264de6046161f4d20a008db6c23"></span><code class="descname">BGFX_STATE_BLEND_INDEPENDENT</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_INDEPENDENT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable blend independent. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_BLEND_ALPHA_TO_COVERAGE">
|
||
<span class="target" id="defines_8h_1aa2831e25d0b111f009b11ff82a2799a7"></span><code class="descname">BGFX_STATE_BLEND_ALPHA_TO_COVERAGE</code><a class="headerlink" href="#c.BGFX_STATE_BLEND_ALPHA_TO_COVERAGE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable alpha to coverage. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_MSAA">
|
||
<span class="target" id="defines_8h_1aed65ada612c8d17b6002a0f36c453e55"></span><code class="descname">BGFX_STATE_MSAA</code><a class="headerlink" href="#c.BGFX_STATE_MSAA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable MSAA write when writing into MSAA frame buffer. This flag is ignored when not writing into MSAA frame buffer. </p>
|
||
<p>Enable MSAA rasterization. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_LINEAA">
|
||
<span class="target" id="defines_8h_1a0668fde1f928de351846c15cc574aea7"></span><code class="descname">BGFX_STATE_LINEAA</code><a class="headerlink" href="#c.BGFX_STATE_LINEAA" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable line AA rasterization. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="stencil">
|
||
<h4>Stencil<a class="headerlink" href="#stencil" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10setStencilE8uint32_t8uint32_t">
|
||
<span id="bgfx::setStencil__uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1aec7be9fc28858c7cdcc78a8e9f504434"></span>void <code class="descclassname">bgfx::</code><code class="descname">setStencil</code><span class="sig-paren">(</span>uint32_t <em>_fstencil</em>, uint32_t <em>_bstencil</em> = BGFX_STENCIL_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setStencilE8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set stencil test state. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_stencil</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_fstencil</span></code>: Front stencil state. </li>
|
||
<li><code class="docutils literal"><span class="pre">_bstencil</span></code>: Back stencil state. If back is set to <code class="docutils literal"><span class="pre">BGFX_STENCIL_NONE</span></code> _fstencil is applied to both front and back facing primitives.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="stencil-flags">
|
||
<h4>Stencil Flags<a class="headerlink" href="#stencil-flags" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STENCIL_TEST_LESS">
|
||
<span class="target" id="defines_8h_1ad5a495c48408fb31c50a8fd8872c6efe"></span><code class="descname">BGFX_STENCIL_TEST_LESS</code><a class="headerlink" href="#c.BGFX_STENCIL_TEST_LESS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable stencil test, less. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="scissor">
|
||
<h4>Scissor<a class="headerlink" href="#scissor" title="Permalink to this headline">¶</a></h4>
|
||
<p>When scissor rectangle is changing per draw call inside the same view use <cite>bgfx::setScissor</cite>,
|
||
otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10setScissorE8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::setScissor__uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="namespacebgfx_1a044469089552c76b36ec5e5ac57cf695"></span>uint16_t <code class="descclassname">bgfx::</code><code class="descname">setScissor</code><span class="sig-paren">(</span>uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setScissorE8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set scissor for draw primitive. For scissor for all primitives in view see <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a4c5184c35ba92387e4609f4919a35e05"><span><span class="pre">bgfx::setViewScissor</span></span></a></code>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Scissor cache index.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_scissor</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: Position x from the left corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Position y from the top corner of the window. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of scissor region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of scissor region. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10setScissorE8uint16_t">
|
||
<span id="bgfx::setScissor__uint16_t"></span><span class="target" id="namespacebgfx_1a2cad724d5941acf0719c007792fcde3e"></span>void <code class="descclassname">bgfx::</code><code class="descname">setScissor</code><span class="sig-paren">(</span>uint16_t <em>_cache</em> = UINT16_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setScissorE8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set scissor from cache for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_scissor_cached</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_cache</span></code>: Index in scissor cache. Passing UINT16_MAX unset primitive scissor and primitive will use view scissor instead.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="transform">
|
||
<h4>Transform<a class="headerlink" href="#transform" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14allocTransformEP9Transform8uint16_t">
|
||
<span id="bgfx::allocTransform__TransformP.uint16_t"></span><span class="target" id="namespacebgfx_1a659b2048c1d0720027307fcdc5ce65e5"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">allocTransform</code><span class="sig-paren">(</span>Transform *<em>_transform</em>, uint16_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14allocTransformEP9Transform8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reserve <code class="docutils literal"><span class="pre">_num</span></code> matrices in internal matrix cache. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>index into matrix cache.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Pointer returned can be modifed until <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> is called. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_transform</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_transform</span></code>: Pointer to <code class="docutils literal"><span class="pre">Transform</span></code> structure. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of matrices. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setTransformEPKv8uint16_t">
|
||
<span id="bgfx::setTransform__voidCP.uint16_t"></span><span class="target" id="namespacebgfx_1a1a8cda55b0d751df8cdd5c1d6080f622"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">setTransform</code><span class="sig-paren">(</span><em class="property">const</em> void *<em>_mtx</em>, uint16_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setTransformEPKv8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set model matrix for draw primitive. If it is not called, the model will be rendered with an identity model matrix. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>index into matrix cache in case the same model matrix has to be used for other draw primitive call.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transform</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_mtx</span></code>: Pointer to first matrix in array. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of matrices in array. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setTransformE8uint32_t8uint16_t">
|
||
<span id="bgfx::setTransform__uint32_t.uint16_t"></span><span class="target" id="namespacebgfx_1a7ab5e0c5e43e4456d51a06a755a824ce"></span>void <code class="descclassname">bgfx::</code><code class="descname">setTransform</code><span class="sig-paren">(</span>uint32_t <em>_cache</em>, uint16_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setTransformE8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set model matrix from matrix cache for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transform_cached</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_cache</span></code>: Index in matrix cache. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of matrices from cache.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="conditional-rendering">
|
||
<h4>Conditional Rendering<a class="headerlink" href="#conditional-rendering" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setConditionE20OcclusionQueryHandleb">
|
||
<span id="bgfx::setCondition__OcclusionQueryHandle.b"></span><span class="target" id="namespacebgfx_1ab3d4234c579854aeafffbbc3a0b8a436"></span>void <code class="descclassname">bgfx::</code><code class="descname">setCondition</code><span class="sig-paren">(</span>OcclusionQueryHandle <em>_handle</em>, bool <em>_visible</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setConditionE20OcclusionQueryHandleb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set condition for rendering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_condition</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>: Occlusion query handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_visible</span></code>: Render if occlusion query is visible.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle">
|
||
<span id="bgfx::setIndexBuffer__IndexBufferHandle"></span><span class="target" id="namespacebgfx_1a788bf7feee1fd76127e628fcc0e879d4"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_index_buffer</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>: Index buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setIndexBuffer__IndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1a557d08e2d163054e7642206ac00b6724"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_index_buffer</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>: Index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_firstIndex</span></code>: First index to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of indices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle">
|
||
<span id="bgfx::setIndexBuffer__DynamicIndexBufferHandle"></span><span class="target" id="namespacebgfx_1abdf5b7249100abcb08ec8195e65bbb66"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_dynamic_index_buffer</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>: Dynamic index buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setIndexBuffer__DynamicIndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1a97f7ff081c65d9d14bab89286dacc8c2"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferE24DynamicIndexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_dynamic_index_buffer</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>: Dynamic index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_firstIndex</span></code>: First index to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of indices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer">
|
||
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP"></span><span class="target" id="namespacebgfx_1a31bede5af454ba8b2c802d15ee84abab"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientIndexBuffer *<em>_tib</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transient_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_tib</span></code>: Transient index buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t">
|
||
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1a1ff04459d5f92944634903ab4bdfe8bc"></span>void <code class="descclassname">bgfx::</code><code class="descname">setIndexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientIndexBuffer *<em>_tib</em>, uint32_t <em>_firstIndex</em>, uint32_t <em>_numIndices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set index buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transient_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_tib</span></code>: Transient index buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_firstIndex</span></code>: First index to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numIndices</span></code>: Number of indices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_t18VertexBufferHandle">
|
||
<span id="bgfx::setVertexBuffer__uint8_t.VertexBufferHandle"></span><span class="target" id="namespacebgfx_1a29c3a6c07434061bea917120bcc4175d"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, VertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_t18VertexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Vertex buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_t18VertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setVertexBuffer__uint8_t.VertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1a4dcd99aea03680359463065f7ebbfc50"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, VertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_t18VertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startVertex</span></code>: First vertex to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_t25DynamicVertexBufferHandle">
|
||
<span id="bgfx::setVertexBuffer__uint8_t.DynamicVertexBufferHandle"></span><span class="target" id="namespacebgfx_1ad6b0c076f266b1b7954ddc60c2e21571"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, DynamicVertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_t25DynamicVertexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_dynamic_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic vertex buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_t25DynamicVertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setVertexBuffer__uint8_t.DynamicVertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1a05fc6ec8f48cc5aef2cd1a8edfd145f2"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_t25DynamicVertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_dynamic_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startVertex</span></code>: First vertex to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer">
|
||
<span id="bgfx::setVertexBuffer__uint8_t.TransientVertexBufferCP"></span><span class="target" id="namespacebgfx_1adedeea9d83dc33076177b6c0657dbf6f"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transient_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_tvb</span></code>: Transient vertex buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t">
|
||
<span id="bgfx::setVertexBuffer__uint8_t.TransientVertexBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1aa9547529632951c0f1b64c327444c4f6"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stream</em>, <em class="property">const</em> TransientVertexBuffer *<em>_tvb</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE7uint8_tPK21TransientVertexBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set vertex buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_transient_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stream</span></code>: Vertex stream. </li>
|
||
<li><code class="docutils literal"><span class="pre">_tvb</span></code>: Transient vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startVertex</span></code>: First vertex to render. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices to render.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setVertexCountE8uint32_t">
|
||
<span id="bgfx::setVertexCount__uint32_t"></span><span class="target" id="namespacebgfx_1ad86de33993e8c57ee016d5af8a2c51bd"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexCount</code><span class="sig-paren">(</span>uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14setVertexCountE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set number of vertices for auto generated vertices use in conjuction with gl_VertexID. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ID</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_vertex_count</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_numVertices</span></code>: Number of vertices.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer">
|
||
<span id="bgfx::setInstanceDataBuffer__InstanceDataBufferCP"></span><span class="target" id="namespacebgfx_1aa99e46d4c06aacf639114d727eac87dd"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> InstanceDataBuffer *<em>_idb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_instance_data_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_idb</span></code>: Transient instance data buffer.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t">
|
||
<span id="bgfx::setInstanceDataBuffer__InstanceDataBufferCP.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1ad9b9b9217c22449bc4d18af7abe4651e"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span><em class="property">const</em> InstanceDataBuffer *<em>_idb</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_instance_data_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_idb</span></code>: Transient instance data buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First instance data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of data instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx21setInstanceDataBufferE18VertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setInstanceDataBuffer__VertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1a20b0e58f00d16430069e045755e72bb0"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferE18VertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_instance_data_from_vertex_buffer</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>: Vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First instance data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of data instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx21setInstanceDataBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setInstanceDataBuffer__DynamicVertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="namespacebgfx_1af5f5a928ce18fe1d2ea45e52e6d20238"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_start</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferE25DynamicVertexBufferHandle8uint32_t8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set instance data buffer for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_instance_data_from_dynamic_vertex_buffer</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>: Vertex buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_start</span></code>: First instance data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of data instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx16setInstanceCountE8uint32_t">
|
||
<span id="bgfx::setInstanceCount__uint32_t"></span><span class="target" id="namespacebgfx_1aa41e297fd85870c1773f498cb7e51b05"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceCount</code><span class="sig-paren">(</span>uint32_t <em>_numInstances</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx16setInstanceCountE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set number of instances for auto generated instances use in conjuction with gl_InstanceID. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ID</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_instance_count</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_numInstances</span></code>: Number of instances.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t">
|
||
<span id="bgfx::setTexture__uint8_t.UniformHandle.TextureHandle.uint32_t"></span><span class="target" id="namespacebgfx_1a62ed3fb0f144798a2a8ba2e19d0e2dc0"></span>void <code class="descclassname">bgfx::</code><code class="descname">setTexture</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, UniformHandle <em>_sampler</em>, TextureHandle <em>_handle</em>, uint32_t <em>_flags</em> = UINT32_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set texture stage for draw primitive. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_texture</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Texture unit. </li>
|
||
<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_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>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<p>Within view all draw commands are executed after blit and compute commands.</p>
|
||
<div class="admonition warning">
|
||
<p class="first admonition-title">Warning</p>
|
||
<p>doxygenfunction: Unable to resolve multiple matches for function “bgfx::submit” with arguments (ViewId, ProgramHandle, int32_t, bool) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
|
||
Potential matches:
|
||
</p>
|
||
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::submit(ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t, uint32_t, bool)
|
||
- void bgfx::submit(ViewId, ProgramHandle, OcclusionQueryHandle, uint32_t, bool)
|
||
- void bgfx::submit(ViewId, ProgramHandle, uint32_t, bool)
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="admonition warning">
|
||
<p class="first admonition-title">Warning</p>
|
||
<p>doxygenfunction: Unable to resolve multiple matches for function “bgfx::submit” with arguments (ViewId, ProgramHandle, OcclusionQueryHandle, int32_t, bool) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
|
||
Potential matches:
|
||
</p>
|
||
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::submit(ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t, uint32_t, bool)
|
||
- void bgfx::submit(ViewId, ProgramHandle, OcclusionQueryHandle, uint32_t, bool)
|
||
- void bgfx::submit(ViewId, ProgramHandle, uint32_t, bool)
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="admonition warning">
|
||
<p class="first admonition-title">Warning</p>
|
||
<p>doxygenfunction: Unable to resolve multiple matches for function “bgfx::submit” with arguments (ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t, int32_t, bool) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
|
||
Potential matches:
|
||
</p>
|
||
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::submit(ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t, uint32_t, bool)
|
||
- void bgfx::submit(ViewId, ProgramHandle, OcclusionQueryHandle, uint32_t, bool)
|
||
- void bgfx::submit(ViewId, ProgramHandle, uint32_t, bool)
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="compute">
|
||
<h3>Compute<a class="headerlink" href="#compute" title="Permalink to this headline">¶</a></h3>
|
||
<p>Compute state is not preserved between two compute dispatches. All state is cleared after calling
|
||
<cite>bgfx::dispatch</cite>.</p>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx6AccessE">
|
||
<span id="bgfx::Access"></span><span class="target" id="structbgfx_1_1_access"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Access</code><a class="headerlink" href="#_CPPv2N4bgfx6AccessE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#structbgfx_1_1_access"><span>Access</span></a> mode enum. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_access_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx6Access4EnumE">
|
||
<span id="bgfx::Access::Enum"></span><span class="target" id="structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#structbgfx_1_1_access"><span>Access</span></a>: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Access4ReadE">
|
||
<span class="target" id="structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180aa8c5d200b47f6eba1f1ad2dc4149bcd4"></span><code class="descname">Read</code><a class="headerlink" href="#_CPPv2N4bgfx6Access4ReadE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Access5WriteE">
|
||
<span class="target" id="structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180a10ed39a89f1207269328309b7238ad74"></span><code class="descname">Write</code><a class="headerlink" href="#_CPPv2N4bgfx6Access5WriteE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Access9ReadWriteE">
|
||
<span class="target" id="structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180a844968ef8ec9575127437553bd0b128b"></span><code class="descname">ReadWrite</code><a class="headerlink" href="#_CPPv2N4bgfx6Access9ReadWriteE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read and write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Access5CountE">
|
||
<span class="target" id="structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180af48902f20e66734d9cf257c4f1f31340"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx6Access5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setBufferE7uint8_t17IndexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::setBuffer__uint8_t.IndexBufferHandle.Access::Enum"></span><span class="target" id="namespacebgfx_1a94c3195ced868b94a232428561a21d56"></span>void <code class="descclassname">bgfx::</code><code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, IndexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9setBufferE7uint8_t17IndexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_compute_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Index buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setBufferE7uint8_t18VertexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::setBuffer__uint8_t.VertexBufferHandle.Access::Enum"></span><span class="target" id="namespacebgfx_1a85f8bcfd59b5d298e0e0cfd69cdcf4ce"></span>void <code class="descclassname">bgfx::</code><code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, VertexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9setBufferE7uint8_t18VertexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_compute_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Vertex buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setBufferE7uint8_t24DynamicIndexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::setBuffer__uint8_t.DynamicIndexBufferHandle.Access::Enum"></span><span class="target" id="namespacebgfx_1a353d269041bba99cc86345ad7ac6dd9f"></span>void <code class="descclassname">bgfx::</code><code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, DynamicIndexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9setBufferE7uint8_t24DynamicIndexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute dynamic index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_compute_dynamic_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic index buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setBufferE7uint8_t25DynamicVertexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::setBuffer__uint8_t.DynamicVertexBufferHandle.Access::Enum"></span><span class="target" id="namespacebgfx_1a02cd00cdf0cb59d423d03b7358331bff"></span>void <code class="descclassname">bgfx::</code><code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, DynamicVertexBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9setBufferE7uint8_t25DynamicVertexBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute dynamic vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_compute_dynamic_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Dynamic vertex buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setBufferE7uint8_t20IndirectBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::setBuffer__uint8_t.IndirectBufferHandle.Access::Enum"></span><span class="target" id="namespacebgfx_1a52b241b7370222eea882474910cd49b4"></span>void <code class="descclassname">bgfx::</code><code class="descname">setBuffer</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, IndirectBufferHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9setBufferE7uint8_t20IndirectBufferHandleN6Access4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute indirect buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_compute_indirect_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Compute stage. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Indirect buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Buffer access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></code>.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8setImageE7uint8_t13TextureHandle7uint8_tN6Access4EnumEN13TextureFormat4EnumE">
|
||
<span id="bgfx::setImage__uint8_t.TextureHandle.uint8_t.Access::Enum.TextureFormat::Enum"></span><span class="target" id="namespacebgfx_1aff6a7e1638d103b42340e553eed29796"></span>void <code class="descclassname">bgfx::</code><code class="descname">setImage</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, TextureHandle <em>_handle</em>, uint8_t <em>_mip</em>, <a class="reference internal" href="#_CPPv2N4bgfx6AccessE" title="bgfx::Access">Access</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Access4EnumE" title="bgfx::Access::Enum">Enum</a> <em>_access</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> = TextureFormat::Count<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8setImageE7uint8_t13TextureHandle7uint8_tN6Access4EnumEN13TextureFormat4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute image from texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_image</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_stage</span></code>: Texture unit. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handle</span></code>: Texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mip</span></code>: Mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_access</span></code>: Texture access. See <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_access_1a1deee3013ec4834c19370685b1719180"><span><span class="pre">Access::Enum</span></span></a></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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<p>Within view all compute commands are dispatched after blit commands, and before draw commands.</p>
|
||
<div class="admonition warning">
|
||
<p class="first admonition-title">Warning</p>
|
||
<p>doxygenfunction: Unable to resolve multiple matches for function “bgfx::dispatch” with arguments (ViewId, ProgramHandle, uint32_t, uint32_t, uint32_t, uint8_t) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
|
||
Potential matches:
|
||
</p>
|
||
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::dispatch(ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t)
|
||
- void bgfx::dispatch(ViewId, ProgramHandle, uint32_t, uint32_t, uint32_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 “bgfx::dispatch” with arguments (ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t, uint8_t) in doxygen xml output for project “bgfx” from directory: ../../.build/docs/xml.
|
||
Potential matches:
|
||
</p>
|
||
<div class="last highlight-python"><div class="highlight"><pre>- void bgfx::dispatch(ViewId, ProgramHandle, IndirectBufferHandle, uint16_t, uint16_t)
|
||
- void bgfx::dispatch(ViewId, ProgramHandle, uint32_t, uint32_t, uint32_t)
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="blit">
|
||
<h3>Blit<a class="headerlink" href="#blit" title="Permalink to this headline">¶</a></h3>
|
||
<p>Within view all blit commands are executed before compute, and draw commands.</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4blitE6ViewId13TextureHandle8uint16_t8uint16_t13TextureHandle8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::blit__ViewId.TextureHandle.uint16_t.uint16_t.TextureHandle.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="namespacebgfx_1aebd5560001cdeb76b4fa88ac04b660d6"></span>void <code class="descclassname">bgfx::</code><code class="descname">blit</code><span class="sig-paren">(</span>ViewId <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="#_CPPv2N4bgfx4blitE6ViewId13TextureHandle8uint16_t8uint16_t13TextureHandle8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blit 2D texture region between two 2D textures. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Destination texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_blit</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dst</span></code>: Destination texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstX</span></code>: Destination texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstY</span></code>: Destination texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_src</span></code>: Source texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcX</span></code>: Source texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcY</span></code>: Source texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of region.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4blitE6ViewId13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::blit__ViewId.TextureHandle.uint8_t.uint16_t.uint16_t.uint16_t.TextureHandle.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="namespacebgfx_1a3a1768b60ba0a0f162afa485bd013844"></span>void <code class="descclassname">bgfx::</code><code class="descname">blit</code><span class="sig-paren">(</span>ViewId <em>_id</em>, TextureHandle <em>_dst</em>, uint8_t <em>_dstMip</em>, uint16_t <em>_dstX</em>, uint16_t <em>_dstY</em>, uint16_t <em>_dstZ</em>, TextureHandle <em>_src</em>, uint8_t <em>_srcMip</em> = 0, uint16_t <em>_srcX</em> = 0, uint16_t <em>_srcY</em> = 0, uint16_t <em>_srcZ</em> = 0, uint16_t <em>_width</em> = UINT16_MAX, uint16_t <em>_height</em> = UINT16_MAX, uint16_t <em>_depth</em> = UINT16_MAX<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4blitE6ViewId13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blit texture region between two textures. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Destination texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_blit</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_id</span></code>: View id. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dst</span></code>: Destination texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstMip</span></code>: Destination texture mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstX</span></code>: Destination texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstY</span></code>: Destination texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_dstZ</span></code>: If texture is 2D this argument should be 0. If destination texture is cube this argument represents destination texture cube face. For 3D texture this argument represents destination texture Z position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_src</span></code>: Source texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcMip</span></code>: Source texture mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcX</span></code>: Source texture X position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcY</span></code>: Source texture Y position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_srcZ</span></code>: If texture is 2D this argument should be 0. If source texture is cube this argument represents source texture cube face. For 3D texture this argument represents source texture Z position. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of region. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: If texture is 3D this argument represents depth of region, otherwise it’s unused.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="resources">
|
||
<h2>Resources<a class="headerlink" href="#resources" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx6MemoryE">
|
||
<span id="bgfx::Memory"></span><span class="target" id="structbgfx_1_1_memory"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Memory</code><a class="headerlink" href="#_CPPv2N4bgfx6MemoryE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#structbgfx_1_1_memory"><span>Memory</span></a> must be obtained by calling <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code>, <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1abef77615b85f71391e7eda16f24dc5b7"><span><span class="pre">bgfx::copy</span></span></a></code>, or <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span><span class="pre">bgfx::makeRef</span></span></a></code>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>It is illegal to create this structure on stack and pass it to any bgfx API.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_memory_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx6Memory4dataE">
|
||
<span id="bgfx::Memory::data__uint8_tP"></span><span class="target" id="structbgfx_1_1_memory_1a074d49f89140737540e6fb377ee02859"></span>uint8_t *<code class="descname">data</code><a class="headerlink" href="#_CPPv2N4bgfx6Memory4dataE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Pointer to data. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx6Memory4sizeE">
|
||
<span id="bgfx::Memory::size__uint32_t"></span><span class="target" id="structbgfx_1_1_memory_1af2daa4c1c380a5055a5adb33d5cfaa0a"></span>uint32_t <code class="descname">size</code><a class="headerlink" href="#_CPPv2N4bgfx6Memory4sizeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Data size. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx5allocE8uint32_t">
|
||
<span id="bgfx::alloc__uint32_t"></span><span class="target" id="namespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<code class="descclassname">bgfx::</code><code class="descname">alloc</code><span class="sig-paren">(</span>uint32_t <em>_size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5allocE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Allocate buffer to pass to bgfx calls. Data will be freed inside bgfx. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_size</span></code>: Size to allocate.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4copyEPKv8uint32_t">
|
||
<span id="bgfx::copy__voidCP.uint32_t"></span><span class="target" id="namespacebgfx_1abef77615b85f71391e7eda16f24dc5b7"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<code class="descclassname">bgfx::</code><code class="descname">copy</code><span class="sig-paren">(</span><em class="property">const</em> void *<em>_data</em>, uint32_t <em>_size</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4copyEPKv8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Allocate buffer and copy data into it. Data will be freed inside bgfx. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_copy</span></code>. </dd>
|
||
<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 to be copied. </li>
|
||
<li><code class="docutils literal"><span class="pre">_size</span></code>: Size of data to be copied.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7makeRefEPKv8uint32_t9ReleaseFnPv">
|
||
<span id="bgfx::makeRef__voidCP.uint32_t.ReleaseFn.voidP"></span><span class="target" id="namespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<code class="descclassname">bgfx::</code><code class="descname">makeRef</code><span class="sig-paren">(</span><em class="property">const</em> void *<em>_data</em>, uint32_t <em>_size</em>, ReleaseFn <em>_releaseFn</em> = NULL, void *<em>_userData</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7makeRefEPKv8uint32_t9ReleaseFnPv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Make reference to data to pass to bgfx. Unlike <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code>, this call doesn’t allocate memory for data. It just copies the _data pointer. You can pass <code class="docutils literal"><span class="pre">ReleaseFn</span></code> function pointer to release this memory after it’s consumed, otherwise you must make sure _data is available for at least 2 <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> calls. <code class="docutils literal"><span class="pre">ReleaseFn</span></code> function must be able to be called from any thread. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Data passed must be available for at least 2 <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code> calls. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent are <code class="docutils literal"><span class="pre">bgfx_make_ref</span></code>, <code class="docutils literal"><span class="pre">bgfx_make_ref_release</span></code>. </dd>
|
||
<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">_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>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<div class="section" id="shaders-and-programs">
|
||
<h3>Shaders and Programs<a class="headerlink" href="#shaders-and-programs" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12createShaderEPK6Memory">
|
||
<span id="bgfx::createShader__MemoryCP"></span><span class="target" id="namespacebgfx_1af575a29f8b3e555cb1b13f01fadbeb37"></span>ShaderHandle <code class="descclassname">bgfx::</code><code class="descname">createShader</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12createShaderEPK6Memory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create shader from memory buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_shader</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17getShaderUniformsE12ShaderHandleP13UniformHandle8uint16_t">
|
||
<span id="bgfx::getShaderUniforms__ShaderHandle.UniformHandleP.uint16_t"></span><span class="target" id="namespacebgfx_1a2e9de394b0d4aac971efa7b7f2fa3d3e"></span>uint16_t <code class="descclassname">bgfx::</code><code class="descname">getShaderUniforms</code><span class="sig-paren">(</span>ShaderHandle <em>_handle</em>, UniformHandle *<em>_uniforms</em> = NULL, uint16_t <em>_max</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17getShaderUniformsE12ShaderHandleP13UniformHandle8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the number of uniforms and uniform handles used inside a shader. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Number of uniforms used by shader.</dd>
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Only non-predefined uniforms are returned.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_shader_uniforms</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">_uniforms</span></code>: UniformHandle array where data will be stored. </li>
|
||
<li><code class="docutils literal"><span class="pre">_max</span></code>: Maximum capacity of array. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE12ShaderHandle">
|
||
<span id="bgfx::destroy__ShaderHandle"></span><span class="target" id="namespacebgfx_1aee6eab22226f936cc82291b261792597"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>ShaderHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE12ShaderHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy shader. Once a shader program is created with _handle, it is safe to destroy that shader. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_shader</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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13createProgramE12ShaderHandle12ShaderHandleb">
|
||
<span id="bgfx::createProgram__ShaderHandle.ShaderHandle.b"></span><span class="target" id="namespacebgfx_1a5b3bafcd7948f54136c7b731236e3b7a"></span>ProgramHandle <code class="descclassname">bgfx::</code><code class="descname">createProgram</code><span class="sig-paren">(</span>ShaderHandle <em>_vsh</em>, ShaderHandle <em>_fsh</em>, bool <em>_destroyShaders</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13createProgramE12ShaderHandle12ShaderHandleb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create program with vertex and fragment shaders. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Program handle if vertex shader output and fragment shader input are matching, otherwise returns invalid program handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_program</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_vsh</span></code>: Vertex shader. </li>
|
||
<li><code class="docutils literal"><span class="pre">_fsh</span></code>: Fragment shader. </li>
|
||
<li><code class="docutils literal"><span class="pre">_destroyShaders</span></code>: If true, shaders will be destroyed when program is destroyed. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13createProgramE12ShaderHandleb">
|
||
<span id="bgfx::createProgram__ShaderHandle.b"></span><span class="target" id="namespacebgfx_1aca7241539155409a3aaa0f81e2a9c7ff"></span>ProgramHandle <code class="descclassname">bgfx::</code><code class="descname">createProgram</code><span class="sig-paren">(</span>ShaderHandle <em>_csh</em>, bool <em>_destroyShader</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13createProgramE12ShaderHandleb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create program with compute shader. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Program handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_compute_program</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_csh</span></code>: Compute shader. </li>
|
||
<li><code class="docutils literal"><span class="pre">_destroyShader</span></code>: If true, shader will be destroyed when program is destroyed. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE13ProgramHandle">
|
||
<span id="bgfx::destroy__ProgramHandle"></span><span class="target" id="namespacebgfx_1a2b851eb71165e274b9a3d83388e45ed0"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>ProgramHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE13ProgramHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy program. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_program</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>: Program handle.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="uniforms">
|
||
<h3>Uniforms<a class="headerlink" href="#uniforms" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13createUniformEPKcN11UniformType4EnumE8uint16_t">
|
||
<span id="bgfx::createUniform__cCP.UniformType::Enum.uint16_t"></span><span class="target" id="namespacebgfx_1a45614b96172b438fd644c858e2c434b2"></span>UniformHandle <code class="descclassname">bgfx::</code><code class="descname">createUniform</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_name</em>, <a class="reference internal" href="#_CPPv2N4bgfx11UniformTypeE" title="bgfx::UniformType">UniformType</a>::<a class="reference internal" href="#_CPPv2N4bgfx11UniformType4EnumE" title="bgfx::UniformType::Enum">Enum</a> <em>_type</em>, uint16_t <em>_num</em> = 1<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13createUniformEPKcN11UniformType4EnumE8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create shader uniform parameter. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Handle to uniform object.</dd>
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd><ol class="arabic simple">
|
||
<li>Uniform names are unique. It’s valid to call <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a45614b96172b438fd644c858e2c434b2"><span><span class="pre">bgfx::createUniform</span></span></a></code> multiple times with the same uniform name. The library will always return the same handle, but the handle reference count will be incremented. This means that the same number of <code class="docutils literal"><span class="pre">bgfx::destroyUniform</span></code> must be called to properly destroy the uniform.</li>
|
||
<li>Predefined uniforms (declared in <code class="docutils literal"><span class="pre">bgfx_shader.sh</span></code>):<ul>
|
||
<li><code class="docutils literal"><span class="pre">u_viewRect</span> <span class="pre">vec4(x,</span> <span class="pre">y,</span> <span class="pre">width,</span> <span class="pre">height)</span></code> - view rectangle for current view, in pixels.</li>
|
||
<li><code class="docutils literal"><span class="pre">u_viewTexel</span> <span class="pre">vec4(1.0/width,</span> <span class="pre">1.0/height,</span> <span class="pre">undef,</span> <span class="pre">undef)</span></code> - inverse width and height</li>
|
||
<li><code class="docutils literal"><span class="pre">u_view</span> <span class="pre">mat4</span></code> - view matrix</li>
|
||
<li><code class="docutils literal"><span class="pre">u_invView</span> <span class="pre">mat4</span></code> - inverted view matrix</li>
|
||
<li><code class="docutils literal"><span class="pre">u_proj</span> <span class="pre">mat4</span></code> - projection matrix</li>
|
||
<li><code class="docutils literal"><span class="pre">u_invProj</span> <span class="pre">mat4</span></code> - inverted projection matrix</li>
|
||
<li><code class="docutils literal"><span class="pre">u_viewProj</span> <span class="pre">mat4</span></code> - concatenated view projection matrix</li>
|
||
<li><code class="docutils literal"><span class="pre">u_invViewProj</span> <span class="pre">mat4</span></code> - concatenated inverted view projection matrix</li>
|
||
<li><code class="docutils literal"><span class="pre">u_model</span> <span class="pre">mat4[BGFX_CONFIG_MAX_BONES]</span></code> - array of model matrices.</li>
|
||
<li><code class="docutils literal"><span class="pre">u_modelView</span> <span class="pre">mat4</span></code> - concatenated model view matrix, only first model matrix from array is used.</li>
|
||
<li><code class="docutils literal"><span class="pre">u_modelViewProj</span> <span class="pre">mat4</span></code> - concatenated model view projection matrix.</li>
|
||
<li><code class="docutils literal"><span class="pre">u_alphaRef</span> <span class="pre">float</span></code> - alpha reference value for alpha test.</li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_uniform</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_name</span></code>: Uniform name in shader. </li>
|
||
<li><code class="docutils literal"><span class="pre">_type</span></code>: Type of uniform (See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_uniform_type"><span><span class="pre">bgfx::UniformType</span></span></a></code>). </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of elements in array.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14getUniformInfoE13UniformHandleR11UniformInfo">
|
||
<span id="bgfx::getUniformInfo__UniformHandle.UniformInfoR"></span><span class="target" id="namespacebgfx_1aa57213d4971e397983c217ee97326e37"></span>void <code class="descclassname">bgfx::</code><code class="descname">getUniformInfo</code><span class="sig-paren">(</span>UniformHandle <em>_handle</em>, <a class="reference internal" href="#_CPPv2N4bgfx11UniformInfoE" title="bgfx::UniformInfo">UniformInfo</a> &<em>_info</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14getUniformInfoE13UniformHandleR11UniformInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve uniform info. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_uniform_info</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>: Handle to uniform object. </li>
|
||
<li><code class="docutils literal"><span class="pre">_info</span></code>: Uniform info.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE13UniformHandle">
|
||
<span id="bgfx::destroy__UniformHandle"></span><span class="target" id="namespacebgfx_1a3758fba789e327a1f3b02f887a95052b"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>UniformHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE13UniformHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy shader uniform parameter. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_uniform</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>: Handle to uniform object.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx11UniformTypeE">
|
||
<span id="bgfx::UniformType"></span><span class="target" id="structbgfx_1_1_uniform_type"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">UniformType</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformTypeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Uniform type enum. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_uniform_type_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx11UniformType4EnumE">
|
||
<span id="bgfx::UniformType::Enum"></span><span class="target" id="structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Uniform types: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Int1E">
|
||
<span class="target" id="structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79a173664bed3eef9991e511cb9815f4522"></span><code class="descname">Int1</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Int1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Int, used for samplers only. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx11UniformType3EndE">
|
||
<span class="target" id="structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79af032fc38d9876bbc4f4609116ced94c9"></span><code class="descname">End</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType3EndE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Reserved, do not use. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Vec4E">
|
||
<span class="target" id="structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79ad3a487a974362da30ed861d5e60134dd"></span><code class="descname">Vec4</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Vec4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>4 floats vector. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Mat3E">
|
||
<span class="target" id="structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79a4912934f4e16efd08a14a396fed267f2"></span><code class="descname">Mat3</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Mat3E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>3x3 matrix. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Mat4E">
|
||
<span class="target" id="structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79ac875f375dfc3adf73780a4114c6cc851"></span><code class="descname">Mat4</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Mat4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>4x4 matrix. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx11UniformType5CountE">
|
||
<span class="target" id="structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79aa7cf5e8e3c979dcb60476fe4dc891dd1"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx11UniformInfoE">
|
||
<span id="bgfx::UniformInfo"></span><span class="target" id="structbgfx_1_1_uniform_info"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">UniformInfo</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformInfoE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Uniform info. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_uniform_info_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformInfo4nameE">
|
||
<span id="bgfx::UniformInfo::name__cA"></span><span class="target" id="structbgfx_1_1_uniform_info_1a31297c5b74a406c6a3aeb992524076ad"></span>char <code class="descname">name</code>[256]<a class="headerlink" href="#_CPPv2N4bgfx11UniformInfo4nameE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Uniform name. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformInfo4typeE">
|
||
<span id="bgfx::UniformInfo::type__UniformType::Enum"></span><span class="target" id="structbgfx_1_1_uniform_info_1a0f485153be537102d0350111bb58efbd"></span><a class="reference internal" href="#_CPPv2N4bgfx11UniformTypeE" title="bgfx::UniformType">UniformType</a>::<a class="reference internal" href="#_CPPv2N4bgfx11UniformType4EnumE" title="bgfx::UniformType::Enum">Enum</a> <code class="descname">type</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformInfo4typeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Uniform type. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformInfo3numE">
|
||
<span id="bgfx::UniformInfo::num__uint16_t"></span><span class="target" id="structbgfx_1_1_uniform_info_1acab624b397b0c788e6bd011f92823e88"></span>uint16_t <code class="descname">num</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformInfo3numE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of elements in array. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="vertex-buffers">
|
||
<h3>Vertex Buffers<a class="headerlink" href="#vertex-buffers" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx18createVertexBufferEPK6MemoryRK10VertexDecl8uint16_t">
|
||
<span id="bgfx::createVertexBuffer__MemoryCP.VertexDeclCR.uint16_t"></span><span class="target" id="namespacebgfx_1ac65f76911ef289f1bfcf7e4d6e5dcc52"></span>VertexBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createVertexBuffer</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>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em>, uint16_t <em>_flags</em> = BGFX_BUFFER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx18createVertexBufferEPK6MemoryRK10VertexDecl8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create static vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Static vertex buffer handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Vertex buffer data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Buffer creation flags.<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_NONE</span></code> - No flags.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ</span></code> - Buffer will be read from by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> - Buffer will be written into by compute shader. When buffer is created with <code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> flag it cannot be updated from CPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ_WRITE</span></code> - Buffer will be used for read/write by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_ALLOW_RESIZE</span></code> - Buffer will resize on buffer update if a different amount of data is passed. If this flag is not specified, and more data is passed on update, the buffer will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_INDEX32</span></code> - Buffer is using 32-bit indices. This flag has effect only on index buffers. </li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE18VertexBufferHandle">
|
||
<span id="bgfx::destroy__VertexBufferHandle"></span><span class="target" id="namespacebgfx_1aca9e51180be7d3e391cc8601e443e9ea"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE18VertexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy static vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_vertex_buffer</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>: Static vertex buffer handle.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx10VertexDeclE">
|
||
<span id="bgfx::VertexDecl"></span><span class="target" id="structbgfx_1_1_vertex_decl"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">VertexDecl</code><a class="headerlink" href="#_CPPv2N4bgfx10VertexDeclE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vertex declaration. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Functions</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl5beginEN12RendererType4EnumE">
|
||
<span id="bgfx::VertexDecl::begin__RendererType::Enum"></span><span class="target" id="structbgfx_1_1_vertex_decl_1ab5794ea5c4dab7dfb20f0e125b64733d"></span><a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<code class="descname">begin</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx12RendererTypeE" title="bgfx::RendererType">RendererType</a>::<a class="reference internal" href="#_CPPv2N4bgfx12RendererType4EnumE" title="bgfx::RendererType::Enum">Enum</a> <em>_renderer</em> = RendererType::Noop<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl5beginEN12RendererType4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Start <a class="reference internal" href="#structbgfx_1_1_vertex_decl"><span>VertexDecl</span></a>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_begin</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl3endEv">
|
||
<span id="bgfx::VertexDecl::end"></span><span class="target" id="structbgfx_1_1_vertex_decl_1a8f2871fedb1d0e9bfa586f51d071848d"></span>void <code class="descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl3endEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>End <a class="reference internal" href="#structbgfx_1_1_vertex_decl"><span>VertexDecl</span></a>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_end</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl3addEN6Attrib4EnumE7uint8_tN10AttribType4EnumEbb">
|
||
<span id="bgfx::VertexDecl::add__Attrib::Enum.uint8_t.AttribType::Enum.b.b"></span><span class="target" id="structbgfx_1_1_vertex_decl_1a4a640620e8cda3742e465ba9109de72f"></span><a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<code class="descname">add</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attrib</em>, uint8_t <em>_num</em>, <a class="reference internal" href="#_CPPv2N4bgfx10AttribTypeE" title="bgfx::AttribType">AttribType</a>::<a class="reference internal" href="#_CPPv2N4bgfx10AttribType4EnumE" title="bgfx::AttribType::Enum">Enum</a> <em>_type</em>, bool <em>_normalized</em> = false, bool <em>_asInt</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl3addEN6Attrib4EnumE7uint8_tN10AttribType4EnumEbb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add attribute to <a class="reference internal" href="#structbgfx_1_1_vertex_decl"><span>VertexDecl</span></a>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Must be called between begin/end.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_add</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_attrib</span></code>: Attribute semantics. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_attrib"><span><span class="pre">bgfx::Attrib</span></span></a></code> </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of elements 1, 2, 3 or 4. </li>
|
||
<li><code class="docutils literal"><span class="pre">_type</span></code>: Element type. </li>
|
||
<li><code class="docutils literal"><span class="pre">_normalized</span></code>: When using fixed point <a class="reference internal" href="#structbgfx_1_1_attrib_type"><span>AttribType</span></a> (f.e. Uint8) value will be normalized for vertex shader usage. When normalized is set to true, <a class="reference internal" href="#structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4a68937a9abcfa9556980f9e127e234748"><span>AttribType::Uint8</span></a> value in range 0-255 will be in range 0.0-1.0 in vertex shader. </li>
|
||
<li><code class="docutils literal"><span class="pre">_asInt</span></code>: Packaging rule for vertexPack, vertexUnpack, and vertexConvert for <a class="reference internal" href="#structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4a68937a9abcfa9556980f9e127e234748"><span>AttribType::Uint8</span></a> and <a class="reference internal" href="#structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4ae0cd559664652e9d0086ea4316280f1b"><span>AttribType::Int16</span></a>. Unpacking code must be implemented inside vertex shader.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl4skipE7uint8_t">
|
||
<span id="bgfx::VertexDecl::skip__uint8_t"></span><span class="target" id="structbgfx_1_1_vertex_decl_1aee5c6543aedf83780a83a733d7de8e47"></span><a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<code class="descname">skip</code><span class="sig-paren">(</span>uint8_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl4skipE7uint8_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Skip _num bytes in vertex stream. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_skip</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2NK4bgfx10VertexDecl6decodeEN6Attrib4EnumER7uint8_tRN10AttribType4EnumERbRb">
|
||
<span id="bgfx::VertexDecl::decode__Attrib::Enum.uint8_tR.AttribType::EnumR.bR.bRC"></span><span class="target" id="structbgfx_1_1_vertex_decl_1a915f65137652582b4e6be86b28dc1e25"></span>void <code class="descname">decode</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attrib</em>, uint8_t &<em>_num</em>, <a class="reference internal" href="#_CPPv2N4bgfx10AttribTypeE" title="bgfx::AttribType">AttribType</a>::<a class="reference internal" href="#_CPPv2N4bgfx10AttribType4EnumE" title="bgfx::AttribType::Enum">Enum</a> &<em>_type</em>, bool &<em>_normalized</em>, bool &<em>_asInt</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK4bgfx10VertexDecl6decodeEN6Attrib4EnumER7uint8_tRN10AttribType4EnumERbRb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Decode attribute. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_decode</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2NK4bgfx10VertexDecl3hasEN6Attrib4EnumE">
|
||
<span id="bgfx::VertexDecl::has__Attrib::EnumC"></span><span class="target" id="structbgfx_1_1_vertex_decl_1a49f2052830fd5d4676b7f3c23190f436"></span>bool <code class="descname">has</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attrib</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK4bgfx10VertexDecl3hasEN6Attrib4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns true if <a class="reference internal" href="#structbgfx_1_1_vertex_decl"><span>VertexDecl</span></a> contains attribute. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_vertex_decl_has</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2NK4bgfx10VertexDecl9getOffsetEN6Attrib4EnumE">
|
||
<span id="bgfx::VertexDecl::getOffset__Attrib::EnumC"></span><span class="target" id="structbgfx_1_1_vertex_decl_1ac9e7b127e2cb88e41bb58fdc04fe759a"></span>uint16_t <code class="descname">getOffset</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx6AttribE" title="bgfx::Attrib">Attrib</a>::<a class="reference internal" href="#_CPPv2N4bgfx6Attrib4EnumE" title="bgfx::Attrib::Enum">Enum</a> <em>_attrib</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK4bgfx10VertexDecl9getOffsetEN6Attrib4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns relative attribute offset from the vertex. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2NK4bgfx10VertexDecl9getStrideEv">
|
||
<span id="bgfx::VertexDecl::getStrideC"></span><span class="target" id="structbgfx_1_1_vertex_decl_1aea33232b36e3f3930823baff54c57083"></span>uint16_t <code class="descname">getStride</code><span class="sig-paren">(</span><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK4bgfx10VertexDecl9getStrideEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns vertex stride. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2NK4bgfx10VertexDecl7getSizeE8uint32_t">
|
||
<span id="bgfx::VertexDecl::getSize__uint32_tC"></span><span class="target" id="structbgfx_1_1_vertex_decl_1a3178d5b80d1a2f1a82e4dd830983cf8b"></span>uint32_t <code class="descname">getSize</code><span class="sig-paren">(</span>uint32_t <em>_num</em><span class="sig-paren">)</span> <em class="property">const</em><a class="headerlink" href="#_CPPv2NK4bgfx10VertexDecl7getSizeE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns size of vertex buffer for number of vertices. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx6AttribE">
|
||
<span id="bgfx::Attrib"></span><span class="target" id="structbgfx_1_1_attrib"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">Attrib</code><a class="headerlink" href="#_CPPv2N4bgfx6AttribE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vertex attribute enum. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_attrib_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx6Attrib4EnumE">
|
||
<span id="bgfx::Attrib::Enum"></span><span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Corresponds to vertex shader attribute. </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib8PositionE">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a444e880622319fc0eb0c7780d31cbc9d"></span><code class="descname">Position</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib8PositionE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_position </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib6NormalE">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a09cc6a5be35f6888511d48dab335d8aa"></span><code class="descname">Normal</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib6NormalE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_normal </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib7TangentE">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804abe44e93b67a4e48aabe3218eabd5d2c7"></span><code class="descname">Tangent</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib7TangentE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_tangent </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9BitangentE">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a50aec54f390f3a2c7a8c1e0b10b65796"></span><code class="descname">Bitangent</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9BitangentE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_bitangent </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib6Color0E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804aa338a476b1dfd61f3ed33bbb87c7f50d"></span><code class="descname">Color0</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib6Color0E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_color0 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib6Color1E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804acf56be5ceeef8242b540cbd6fd5fa35d"></span><code class="descname">Color1</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib6Color1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_color1 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib6Color2E">
|
||
<span class="target" id="structbgfx_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="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib6Color3E">
|
||
<span class="target" id="structbgfx_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="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib7IndicesE">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804aec853fa913eaa3fe7000e8de29221251"></span><code class="descname">Indices</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib7IndicesE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_indices </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib6WeightE">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804ab2b1c6cdb809113d4e7a00d1ea3e9553"></span><code class="descname">Weight</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib6WeightE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_weight </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord0E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804af411508986750772763964faf2cd9f30"></span><code class="descname">TexCoord0</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord0E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord0 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord1E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804aaa9c4433664b958ea22b848d42800c0e"></span><code class="descname">TexCoord1</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord1 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord2E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a06241a5d80e48e22c7298b293d2365d1"></span><code class="descname">TexCoord2</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord2E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord2 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord3E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a6100dccd6abe910c75c7510736100746"></span><code class="descname">TexCoord3</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord3E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord3 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord4E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a0db1ca4e5406499e8c99e8fba13b9c6c"></span><code class="descname">TexCoord4</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord4 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord5E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a6c9428b5dab98f29bc21c3a4dd754a9a"></span><code class="descname">TexCoord5</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord5E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord5 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord6E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a788ec43ba852d3aaee1b936bcd90867d"></span><code class="descname">TexCoord6</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord6E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord6 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord7E">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804a52f610def404c268cb1eb4108770529f"></span><code class="descname">TexCoord7</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib9TexCoord7E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a_texcoord7 </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx6Attrib5CountE">
|
||
<span class="target" id="structbgfx_1_1_attrib_1a1c2416ba7a7a1bbd4d6e74bf57f03804af776fac0e35a1394d9fcf135f1a77ad0"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx6Attrib5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx10AttribTypeE">
|
||
<span id="bgfx::AttribType"></span><span class="target" id="structbgfx_1_1_attrib_type"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">AttribType</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribTypeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Vertex attribute type enum. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_attrib_type_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx10AttribType4EnumE">
|
||
<span id="bgfx::AttribType::Enum"></span><span class="target" id="structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribType4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Attribute types: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx10AttribType5Uint8E">
|
||
<span class="target" id="structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4a68937a9abcfa9556980f9e127e234748"></span><code class="descname">Uint8</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribType5Uint8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Uint8. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx10AttribType6Uint10E">
|
||
<span class="target" id="structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4aa208b1e17e7dc91ff1bf6c5c2866be9b"></span><code class="descname">Uint10</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribType6Uint10E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Uint10, availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ATTRIB_UINT10</span></code>. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx10AttribType5Int16E">
|
||
<span class="target" id="structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4ae0cd559664652e9d0086ea4316280f1b"></span><code class="descname">Int16</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribType5Int16E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Int16. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx10AttribType4HalfE">
|
||
<span class="target" id="structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4a83110aa60dc97cbd54efe3f7aefe8883"></span><code class="descname">Half</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribType4HalfE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Half, availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ATTRIB_HALF</span></code>. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx10AttribType5FloatE">
|
||
<span class="target" id="structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4ac2efa452accd984882d0e93b3a42aef6"></span><code class="descname">Float</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribType5FloatE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Float. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx10AttribType5CountE">
|
||
<span class="target" id="structbgfx_1_1_attrib_type_1a5cfa80e17fd4932a9704f95ed80ae3b4ae6135e6c7c4e885761c3fffe5613fac0"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx10AttribType5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx25createDynamicVertexBufferE8uint32_tRK10VertexDecl8uint16_t">
|
||
<span id="bgfx::createDynamicVertexBuffer__uint32_t.VertexDeclCR.uint16_t"></span><span class="target" id="namespacebgfx_1a5d216a81f8b71d84fc8d87e4e1e4b670"></span>DynamicVertexBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createDynamicVertexBuffer</code><span class="sig-paren">(</span>uint32_t <em>_num</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em>, uint16_t <em>_flags</em> = BGFX_BUFFER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx25createDynamicVertexBufferE8uint32_tRK10VertexDecl8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create empty dynamic vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Dynamic vertex buffer handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_dynamic_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of vertices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Buffer creation flags.<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_NONE</span></code> - No flags.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ</span></code> - Buffer will be read from by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> - Buffer will be written into by compute shader. When buffer is created with <code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> flag it cannot be updated from CPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ_WRITE</span></code> - Buffer will be used for read/write by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_ALLOW_RESIZE</span></code> - Buffer will resize on buffer update if a different amount of data is passed. If this flag is not specified, and more data is passed on update, the buffer will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_INDEX32</span></code> - Buffer is using 32-bit indices. This flag has effect only on index buffers. </li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx25createDynamicVertexBufferEPK6MemoryRK10VertexDecl8uint16_t">
|
||
<span id="bgfx::createDynamicVertexBuffer__MemoryCP.VertexDeclCR.uint16_t"></span><span class="target" id="namespacebgfx_1a5cd50e5ddae47e26491243b249a72a1b"></span>DynamicVertexBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createDynamicVertexBuffer</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>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em>, uint16_t <em>_flags</em> = BGFX_BUFFER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx25createDynamicVertexBufferEPK6MemoryRK10VertexDecl8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create dynamic vertex buffer and initialize it. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Dynamic vertex buffer handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_dynamic_vertex_buffer_mem</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Vertex buffer data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex declaration. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Buffer creation flags.<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_NONE</span></code> - No flags.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ</span></code> - Buffer will be read from by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> - Buffer will be written into by compute shader. When buffer is created with <code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> flag it cannot be updated from CPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ_WRITE</span></code> - Buffer will be used for read/write by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_ALLOW_RESIZE</span></code> - Buffer will resize on buffer update if a different amount of data is passed. If this flag is not specified, and more data is passed on update, the buffer will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_INDEX32</span></code> - Buffer is using 32-bit indices. This flag has effect only on index buffers. </li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx6updateE25DynamicVertexBufferHandle8uint32_tPK6Memory">
|
||
<span id="bgfx::update__DynamicVertexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1ae443751595715ba47e61a97c45cbf939"></span>void <code class="descclassname">bgfx::</code><code class="descname">update</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6updateE25DynamicVertexBufferHandle8uint32_tPK6Memory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update dynamic vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_dynamic_vertex_buffer</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>: Dynamic vertex buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startVertex</span></code>: Start vertex. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Vertex buffer data.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE25DynamicVertexBufferHandle">
|
||
<span id="bgfx::destroy__DynamicVertexBufferHandle"></span><span class="target" id="namespacebgfx_1ade001e8189baaa5b3f9f1fbaf1f40055"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE25DynamicVertexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy dynamic vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_dynamic_vertex_buffer</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>: Dynamic vertex buffer handle.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx29getAvailTransientVertexBufferE8uint32_tRK10VertexDecl">
|
||
<span id="bgfx::getAvailTransientVertexBuffer__uint32_t.VertexDeclCR"></span><span class="target" id="namespacebgfx_1ae0e28bf67e70d4f7d7fa9d9f1740e2f8"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">getAvailTransientVertexBuffer</code><span class="sig-paren">(</span>uint32_t <em>_num</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx29getAvailTransientVertexBufferE8uint32_tRK10VertexDecl" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns number of requested or maximum available vertices. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_avail_transient_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of required vertices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex declaration.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx26allocTransientVertexBufferEP21TransientVertexBuffer8uint32_tRK10VertexDecl">
|
||
<span id="bgfx::allocTransientVertexBuffer__TransientVertexBufferP.uint32_t.VertexDeclCR"></span><span class="target" id="namespacebgfx_1a6a4d9cc701bc40867080297ab59390e7"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocTransientVertexBuffer</code><span class="sig-paren">(</span>TransientVertexBuffer *<em>_tvb</em>, uint32_t <em>_num</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx10VertexDeclE" title="bgfx::VertexDecl">VertexDecl</a> &<em>_decl</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx26allocTransientVertexBufferEP21TransientVertexBuffer8uint32_tRK10VertexDecl" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Allocate transient vertex buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_transient_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_tvb</span></code>: TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of vertices to allocate. </li>
|
||
<li><code class="docutils literal"><span class="pre">_decl</span></code>: Vertex declaration.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="index-buffers">
|
||
<h3>Index Buffers<a class="headerlink" href="#index-buffers" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17createIndexBufferEPK6Memory8uint16_t">
|
||
<span id="bgfx::createIndexBuffer__MemoryCP.uint16_t"></span><span class="target" id="namespacebgfx_1aee241406cd5d456d3e0a1fdb7da18309"></span>IndexBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createIndexBuffer</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>, uint16_t <em>_flags</em> = BGFX_BUFFER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createIndexBufferEPK6Memory8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create static index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Index buffer data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Buffer creation flags.<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_NONE</span></code> - No flags.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ</span></code> - Buffer will be read from by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> - Buffer will be written into by compute shader. When buffer is created with <code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> flag it cannot be updated from CPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ_WRITE</span></code> - Buffer will be used for read/write by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_ALLOW_RESIZE</span></code> - Buffer will resize on buffer update if a different amount of data is passed. If this flag is not specified, and more data is passed on update, the buffer will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_INDEX32</span></code> - Buffer is using 32-bit indices. This flag has effect only on index buffers.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE17IndexBufferHandle">
|
||
<span id="bgfx::destroy__IndexBufferHandle"></span><span class="target" id="namespacebgfx_1a0947090e39a6a46433418166d7e09cc1"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE17IndexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy static index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_index_buffer</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>: Static index buffer handle.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx24createDynamicIndexBufferE8uint32_t8uint16_t">
|
||
<span id="bgfx::createDynamicIndexBuffer__uint32_t.uint16_t"></span><span class="target" id="namespacebgfx_1abc0f27b5cc29b3fb0c5f3c2fe9571429"></span>DynamicIndexBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createDynamicIndexBuffer</code><span class="sig-paren">(</span>uint32_t <em>_num</em>, uint16_t <em>_flags</em> = BGFX_BUFFER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx24createDynamicIndexBufferE8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create empty dynamic index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Dynamic index buffer handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_dynamic_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of indices. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Buffer creation flags.<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_NONE</span></code> - No flags.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ</span></code> - Buffer will be read from by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> - Buffer will be written into by compute shader. When buffer is created with <code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> flag it cannot be updated from CPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ_WRITE</span></code> - Buffer will be used for read/write by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_ALLOW_RESIZE</span></code> - Buffer will resize on buffer update if a different amount of data is passed. If this flag is not specified, and more data is passed on update, the buffer will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_INDEX32</span></code> - Buffer is using 32-bit indices. This flag has effect only on index buffers. </li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx24createDynamicIndexBufferEPK6Memory8uint16_t">
|
||
<span id="bgfx::createDynamicIndexBuffer__MemoryCP.uint16_t"></span><span class="target" id="namespacebgfx_1a5d05655535947b053858b2abed7e3cb9"></span>DynamicIndexBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createDynamicIndexBuffer</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>, uint16_t <em>_flags</em> = BGFX_BUFFER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx24createDynamicIndexBufferEPK6Memory8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create dynamic index buffer and initialized it. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Dynamic index buffer handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_dynamic_index_buffer_mem</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Index buffer data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_flags</span></code>: Buffer creation flags.<ul>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_NONE</span></code> - No flags.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ</span></code> - Buffer will be read from by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> - Buffer will be written into by compute shader. When buffer is created with <code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_WRITE</span></code> flag it cannot be updated from CPU.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_COMPUTE_READ_WRITE</span></code> - Buffer will be used for read/write by compute shader.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_ALLOW_RESIZE</span></code> - Buffer will resize on buffer update if a different amount of data is passed. If this flag is not specified, and more data is passed on update, the buffer will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_BUFFER_INDEX32</span></code> - Buffer is using 32-bit indices. This flag has effect only on index buffers. </li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx6updateE24DynamicIndexBufferHandle8uint32_tPK6Memory">
|
||
<span id="bgfx::update__DynamicIndexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="namespacebgfx_1abdc14b2d18b00e5c85b9b099d63c5d99"></span>void <code class="descclassname">bgfx::</code><code class="descname">update</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em>, uint32_t <em>_startIndex</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6updateE24DynamicIndexBufferHandle8uint32_tPK6Memory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update dynamic index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_dynamic_index_buffer</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>: Dynamic index buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_startIndex</span></code>: Start index. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Index buffer data.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE24DynamicIndexBufferHandle">
|
||
<span id="bgfx::destroy__DynamicIndexBufferHandle"></span><span class="target" id="namespacebgfx_1a18d6f331ad2fdb0adfbbc5b907d7559b"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE24DynamicIndexBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy dynamic index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_dynamic_index_buffer</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>: Dynamic index buffer handle.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx28getAvailTransientIndexBufferE8uint32_t">
|
||
<span id="bgfx::getAvailTransientIndexBuffer__uint32_t"></span><span class="target" id="namespacebgfx_1a6f7d3cc2105f88d41cbc1f2f1d0c2bd6"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">getAvailTransientIndexBuffer</code><span class="sig-paren">(</span>uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx28getAvailTransientIndexBufferE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns number of requested or maximum available indices. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_avail_transient_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of required indices.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx25allocTransientIndexBufferEP20TransientIndexBuffer8uint32_t">
|
||
<span id="bgfx::allocTransientIndexBuffer__TransientIndexBufferP.uint32_t"></span><span class="target" id="namespacebgfx_1a9526c5d498cfacda5d1a0008d3f61f1e"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocTransientIndexBuffer</code><span class="sig-paren">(</span>TransientIndexBuffer *<em>_tib</em>, uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx25allocTransientIndexBufferEP20TransientIndexBuffer8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Allocate transient index buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Only 16-bit index buffer is supported.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_transient_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_tib</span></code>: TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of indices to allocate.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="textures">
|
||
<h3>Textures<a class="headerlink" href="#textures" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx13TextureFormatE">
|
||
<span id="bgfx::TextureFormat"></span><span class="target" id="structbgfx_1_1_texture_format"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">TextureFormat</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormatE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture format enum. </p>
|
||
<p>Notation: <div class="highlight-python"><div class="highlight"><pre> RGBA16S
|
||
^ ^ ^
|
||
| | +-- [ ]Unorm
|
||
| | [F]loat
|
||
| | [S]norm
|
||
| | [I]nt
|
||
| | [U]int
|
||
| +---- Number of bits per component
|
||
+-------- Components
|
||
</pre></div>
|
||
</div>
|
||
</p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on <a class="reference internal" href="#structbgfx_1_1_caps"><span>Caps</span></a> (see: formats).</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_texture_format_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4EnumE">
|
||
<span id="bgfx::TextureFormat::Enum"></span><span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture formats: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC1E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aee125d92e0e80015bd586b5621cc3d83"></span><code class="descname">BC1</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3BC1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>DXT1. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC2E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a4d77afc75cacfa609303940e1c9cddc2"></span><code class="descname">BC2</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3BC2E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>DXT3. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC3E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a113e64fa135fca0459a7c2ea40425c4f"></span><code class="descname">BC3</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3BC3E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>DXT5. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC4E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a1937f7640ffa842f2c6678286c313e7a"></span><code class="descname">BC4</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3BC4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>LATC1/ATI1. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC5E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a9696af3d8af5c8b8dcdb2bba18df54c8"></span><code class="descname">BC5</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3BC5E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>LATC2/ATI2. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4BC6HE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a3e149dd90ceda8997bcf54a97debd703"></span><code class="descname">BC6H</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4BC6HE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>BC6H. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC7E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a880c61bb22f0950eec832c77e7667d96"></span><code class="descname">BC7</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3BC7E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>BC7. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4ETC1E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ac789a4e13dc4efbb9239fa89f54b8205"></span><code class="descname">ETC1</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4ETC1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ETC1 RGB8. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4ETC2E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aba5a8c2a63daebe7f7b6e6530e384662"></span><code class="descname">ETC2</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4ETC2E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ETC2 RGB8. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5ETC2AE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aeae9b14b230f8576efb154b961836ca5"></span><code class="descname">ETC2A</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5ETC2AE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ETC2 RGBA8. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6ETC2A1E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a971bf46d4c28a7b708a2c6df44593720"></span><code class="descname">ETC2A1</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6ETC2A1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ETC2 RGB8A1. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC12E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6abf2b55f4dfd7effbfa64f27d9546512c"></span><code class="descname">PTC12</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5PTC12E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PVRTC1 RGB 2BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC14E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a1b68442c2e582657d2e9c5b2af7480c5"></span><code class="descname">PTC14</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5PTC14E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PVRTC1 RGB 4BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6PTC12AE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a78128a646efda9393122f3a0cbb47ba7"></span><code class="descname">PTC12A</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6PTC12AE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PVRTC1 RGBA 2BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6PTC14AE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a106b764dde7bcb1eb0c4ea6034ea3b24"></span><code class="descname">PTC14A</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6PTC14AE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PVRTC1 RGBA 4BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC22E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a10791d050f8fc01881fb9ce4dfcdaa6d"></span><code class="descname">PTC22</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5PTC22E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PVRTC2 RGBA 2BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC24E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ab4e6bd17ebbcaa1085dd1285aa2c6e23"></span><code class="descname">PTC24</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5PTC24E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PVRTC2 RGBA 4BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3ATCE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6abfbaa50ea905a9af71c60cbfd80e7c66"></span><code class="descname">ATC</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3ATCE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ATC RGB 4BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4ATCEE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a27c3773c6bdbf033c9f14623e569a187"></span><code class="descname">ATCE</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4ATCEE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ATCE RGBA 8 BPP explicit alpha. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4ATCIE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a1ba5cdc0c5cc60853fa37209452d6ec3"></span><code class="descname">ATCI</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4ATCIE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ATCI RGBA 8 BPP interpolated alpha. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7ASTC4x4E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ae992925acb9b25166b93cc445c62daea"></span><code class="descname">ASTC4x4</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7ASTC4x4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ASTC 4x4 8.0 BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7ASTC5x5E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a6bdec333c7fc2259310ba8252665f22a"></span><code class="descname">ASTC5x5</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7ASTC5x5E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ASTC 5x5 5.12 BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7ASTC6x6E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ade44f5a267e9e98a8e1b5506061237b4"></span><code class="descname">ASTC6x6</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7ASTC6x6E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ASTC 6x6 3.56 BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7ASTC8x5E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ab3d82634d3764b46e0b0b2c0101f6792"></span><code class="descname">ASTC8x5</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7ASTC8x5E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ASTC 8x5 3.20 BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7ASTC8x6E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6acba83554ed1e182a631b6bb68204cc96"></span><code class="descname">ASTC8x6</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7ASTC8x6E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ASTC 8x6 2.67 BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat8ASTC10x5E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a0767d4af475f555f330fe814e7937838"></span><code class="descname">ASTC10x5</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat8ASTC10x5E" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ASTC 10x5 2.56 BPP. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7UnknownE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a2113f0ca58d6c12c10663c0ed360681e"></span><code class="descname">Unknown</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7UnknownE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat2R1E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ab01e6044eaff1fe4451232325ad4f9a6"></span><code class="descname">R1</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat2R1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat2A8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a9b43602e80b02cddbaa066bddc137bc6"></span><code class="descname">A8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat2A8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat2R8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a366a4683758cef76e007f4f33801f7b2"></span><code class="descname">R8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat2R8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R8IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ae777e9061538de54841dfd96cc4070c2"></span><code class="descname">R8I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3R8IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R8UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aecd6d1d295020dc61bad08ab39b609df"></span><code class="descname">R8U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3R8UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R8SE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a86b354d3bf6d634605f6d93fad966fd5"></span><code class="descname">R8S</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3R8SE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R16E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a9f2a1e70d71e48558cfae60650b5da1c"></span><code class="descname">R16</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3R16E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a4ea4bea5f457d7aaa855d253ae967538"></span><code class="descname">R16I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4R16IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a6509456e2fb58fc523abd92bfa4f67ce"></span><code class="descname">R16U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4R16UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a0808adf629c43dbaf932e62b48696b41"></span><code class="descname">R16F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4R16FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16SE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aedfd375d04e3cd2a35992d35657def41"></span><code class="descname">R16S</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4R16SE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R32IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a0cfc961a23995b91f1dfba97b4778fc9"></span><code class="descname">R32I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4R32IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R32UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a56674c00d24eff7b1b96005d66842fed"></span><code class="descname">R32U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4R32UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R32FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a6a20e5c95f27448745e6252fbaa63752"></span><code class="descname">R32F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4R32FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3RG8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a044f11d086916dd993181a298b713fe5"></span><code class="descname">RG8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3RG8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG8IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ac022360e199eafdc5965bb16d8e1596b"></span><code class="descname">RG8I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4RG8IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG8UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ae6e1a34243df2512cde0d768fe27831d"></span><code class="descname">RG8U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4RG8UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG8SE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a30ffb32ec2a2f303f3f3c0618d3097b7"></span><code class="descname">RG8S</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4RG8SE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG16E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6abd5c94677dbbcdb12c9137741f71f5a0"></span><code class="descname">RG16</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4RG16E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a4d7378aee4f0c28a3e9dd49733cbc7d4"></span><code class="descname">RG16I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RG16IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6add597603c407eea23cd3a076e2799a23"></span><code class="descname">RG16U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RG16UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aa01f725e68722ccd7e8a842f697ef7b4"></span><code class="descname">RG16F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RG16FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16SE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ada99abb273ad49596e5645a870913203"></span><code class="descname">RG16S</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RG16SE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG32IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a1e9f0cde8652d9582ca00d3cf0522481"></span><code class="descname">RG32I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RG32IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG32UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a10202973fabca8f138748e4829a5a454"></span><code class="descname">RG32U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RG32UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG32FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a0570aa288a4cf06073ecfc272ff66bfa"></span><code class="descname">RG32F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RG32FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RGB8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a343bee8db4bf2bd967aca4422804da99"></span><code class="descname">RGB8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4RGB8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RGB8IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a86364d64bd522cd53ed3f388316f16c4"></span><code class="descname">RGB8I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RGB8IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RGB8UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a67a188a9c637a007b21a6b494497fae8"></span><code class="descname">RGB8U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RGB8UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RGB8SE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a07efdf9e67260607b65e4c818cf5dbc2"></span><code class="descname">RGB8S</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RGB8SE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGB9E5FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ae16f6d03d3fb347cf375b35bca2a0211"></span><code class="descname">RGB9E5F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGB9E5FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5BGRA8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a8f9737f30497f922acb85eabfab5bd8b"></span><code class="descname">BGRA8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5BGRA8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RGBA8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a76f725de734f6f57124bce94ecf6b857"></span><code class="descname">RGBA8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RGBA8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA8IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a9d2eaf79b30d325f6c02d91c6c83fa9d"></span><code class="descname">RGBA8I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6RGBA8IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA8UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a58a5c9b3c280930e63443e58b8b54514"></span><code class="descname">RGBA8U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6RGBA8UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA8SE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a1f654f103d5ed7c2e3254402c9b25b3e"></span><code class="descname">RGBA8S</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6RGBA8SE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA16E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ac84e3e8918ad3ae651fa77cf7c3d1a1f"></span><code class="descname">RGBA16</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6RGBA16E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ac1ee33c840c8ca2bee1dcd21ab8fcf91"></span><code class="descname">RGBA16I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGBA16IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aa34499e3da11fe380fef67248d7b5ba6"></span><code class="descname">RGBA16U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGBA16UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6adadd1cd35bb81b2b43f396a5f5903ac4"></span><code class="descname">RGBA16F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGBA16FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16SE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a6001607ef039dd349cc48155438ab00f"></span><code class="descname">RGBA16S</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGBA16SE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA32IE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a4b5db87abcf93819d12a7a0493bc0283"></span><code class="descname">RGBA32I</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGBA32IE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA32UE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6acf97df6b0145396940f5ea893fc3873b"></span><code class="descname">RGBA32U</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGBA32UE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA32FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ad21d8c3be31a08140a7abbafb1719166"></span><code class="descname">RGBA32F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGBA32FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6R5G6B5E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aec8537567352a4db4088e3e9f1cf978d"></span><code class="descname">R5G6B5</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6R5G6B5E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RGBA4E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a4e9ceae8c33292ac988c494f79bccbe3"></span><code class="descname">RGBA4</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5RGBA4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGB5A1E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a38bfd7f727149e6458f39ade896d18a7"></span><code class="descname">RGB5A1</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat6RGB5A1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGB10A2E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a7c125c1a4eceb2bbc6f7600bb7ccdf92"></span><code class="descname">RGB10A2</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat7RGB10A2E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat8RG11B10FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a41ac710aca293e8831029481b9636a8f"></span><code class="descname">RG11B10F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat8RG11B10FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat12UnknownDepthE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aaffdadbf432e0a4ea3f20330d9e548c6"></span><code class="descname">UnknownDepth</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat12UnknownDepthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3D16E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a086d2b11ba5e98dd6453f26a306366d0"></span><code class="descname">D16</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3D16E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3D24E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a27a39685dd5aaafcad65736692fa5eff"></span><code class="descname">D24</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3D24E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5D24S8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a21a275083cbc63cf567bbe435de52628"></span><code class="descname">D24S8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5D24S8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3D32E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a993af3f99854f2b0b1d879f652da5ea3"></span><code class="descname">D32</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat3D32E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D16FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a0322a3bb98e826a25a3f63d369eb341f"></span><code class="descname">D16F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4D16FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D24FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ad0e87f93c89a2d4661764eb56956b64e"></span><code class="descname">D24F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4D24FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D32FE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6acb8eb8bd274644a29aac381ef53c5c69"></span><code class="descname">D32F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4D32FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D0S8E">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6ab21986c97b19c1b8d198c171f34e4471"></span><code class="descname">D0S8</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat4D0S8E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5CountE">
|
||
<span class="target" id="structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6a18ef8eeb88705ba0fcbbd0e83bd5c401"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<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>
|
||
<dd>True if texture can be successfully created.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_is_texture_valid</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth dimension of volume texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_cubeMap</span></code>: Indicates that texture contains cubemap. </li>
|
||
<li><code class="docutils literal"><span class="pre">_numLayers</span></code>: Number of layers in texture array. </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>: Texture flags. See <code class="docutils literal"><span class="pre">BGFX_TEXTURE_*</span></code>. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx11TextureInfoE">
|
||
<span id="bgfx::TextureInfo"></span><span class="target" id="structbgfx_1_1_texture_info"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">TextureInfo</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfoE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture info. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_texture_info_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo6formatE">
|
||
<span id="bgfx::TextureInfo::format__TextureFormat::Enum"></span><span class="target" id="structbgfx_1_1_texture_info_1ad0efbc4181697f7d6c56808be2f1e138"></span><a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <code class="descname">format</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo6formatE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture format. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo11storageSizeE">
|
||
<span id="bgfx::TextureInfo::storageSize__uint32_t"></span><span class="target" id="structbgfx_1_1_texture_info_1a49ce6106d8eb4aa6b26f798c152b2d0d"></span>uint32_t <code class="descname">storageSize</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo11storageSizeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Total amount of bytes required to store texture. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo5widthE">
|
||
<span id="bgfx::TextureInfo::width__uint16_t"></span><span class="target" id="structbgfx_1_1_texture_info_1a5a9c554958a2d2d039bb3594ac87e5ab"></span>uint16_t <code class="descname">width</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo5widthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture width. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo6heightE">
|
||
<span id="bgfx::TextureInfo::height__uint16_t"></span><span class="target" id="structbgfx_1_1_texture_info_1aef88aff888246b3f26e8ce5eb59da546"></span>uint16_t <code class="descname">height</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo6heightE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture height. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo5depthE">
|
||
<span id="bgfx::TextureInfo::depth__uint16_t"></span><span class="target" id="structbgfx_1_1_texture_info_1afe3fb6aa842fadafe389a396db8d6fb8"></span>uint16_t <code class="descname">depth</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo5depthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture depth. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo9numLayersE">
|
||
<span id="bgfx::TextureInfo::numLayers__uint16_t"></span><span class="target" id="structbgfx_1_1_texture_info_1adf5283a6c14310b4c57a6f64a357f7cd"></span>uint16_t <code class="descname">numLayers</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo9numLayersE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of layers in texture array. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo7numMipsE">
|
||
<span id="bgfx::TextureInfo::numMips__uint8_t"></span><span class="target" id="structbgfx_1_1_texture_info_1a0c381eb6e68dd577a4cbcb5600b1b613"></span>uint8_t <code class="descname">numMips</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo7numMipsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of MIP maps. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo12bitsPerPixelE">
|
||
<span id="bgfx::TextureInfo::bitsPerPixel__uint8_t"></span><span class="target" id="structbgfx_1_1_texture_info_1a5696ec9eee2fcacaab72ab30081417ac"></span>uint8_t <code class="descname">bitsPerPixel</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo12bitsPerPixelE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Format bits per pixel. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11TextureInfo7cubeMapE">
|
||
<span id="bgfx::TextureInfo::cubeMap__b"></span><span class="target" id="structbgfx_1_1_texture_info_1a74ae39231524ae3ddad50cf26fe0f07c"></span>bool <code class="descname">cubeMap</code><a class="headerlink" href="#_CPPv2N4bgfx11TextureInfo7cubeMapE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture is cubemap. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15calcTextureSizeER11TextureInfo8uint16_t8uint16_t8uint16_tbb8uint16_tN13TextureFormat4EnumE">
|
||
<span id="bgfx::calcTextureSize__TextureInfoR.uint16_t.uint16_t.uint16_t.b.b.uint16_t.TextureFormat::Enum"></span><span class="target" id="namespacebgfx_1afad0573ceede40bc76bb9fe7c938655c"></span>void <code class="descclassname">bgfx::</code><code class="descname">calcTextureSize</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv2N4bgfx11TextureInfoE" title="bgfx::TextureInfo">TextureInfo</a> &<em>_info</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint16_t <em>_depth</em>, bool <em>_cubeMap</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15calcTextureSizeER11TextureInfo8uint16_t8uint16_t8uint16_tbb8uint16_tN13TextureFormat4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calculate amount of memory required for texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_calc_texture_size</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_info</span></code>: Resulting texture info structure. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_texture_info"><span><span class="pre">TextureInfo</span></span></a></code>. </li>
|
||
<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">_depth</span></code>: Depth dimension of volume texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_cubeMap</span></code>: Indicates that texture contains cubemap. </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. </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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<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, <a class="reference internal" href="#_CPPv2N4bgfx11TextureInfoE" title="bgfx::TextureInfo">TextureInfo</a> *<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>
|
||
<dd>Texture handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_texture</span></code>. </dd>
|
||
<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>: 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>
|
||
<li><code class="docutils literal"><span class="pre">_info</span></code>: When non-<code class="docutils literal"><span class="pre">NULL</span></code> is specified it returns parsed texture information. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15createTexture2DE8uint16_t8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_tPK6Memory">
|
||
<span id="bgfx::createTexture2D__uint16_t.uint16_t.b.uint16_t.TextureFormat::Enum.uint64_t.MemoryCP"></span><span class="target" id="namespacebgfx_1a5164c7c2fb433f680dc888eaf752c31b"></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>, 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="#_CPPv2N4bgfx15createTexture2DE8uint16_t8uint16_tb8uint16_tN13TextureFormat4EnumE8uint64_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>: 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15createTexture2DEN15BackbufferRatio4EnumEb8uint16_tN13TextureFormat4EnumE8uint64_t">
|
||
<span id="bgfx::createTexture2D__BackbufferRatio::Enum.b.uint16_t.TextureFormat::Enum.uint64_t"></span><span class="target" id="namespacebgfx_1a67620ab3afd29e7acdacd9180ae86cd4"></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>, uint64_t <em>_flags</em> = BGFX_TEXTURE_NONE|BGFX_SAMPLER_NONE<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15createTexture2DEN15BackbufferRatio4EnumEb8uint16_tN13TextureFormat4EnumE8uint64_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>: 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<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>
|
||
<dd><p>Update 2D texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_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">_handle</span></code>: Texture handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_layer</span></code>: Layers in texture array. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mip</span></code>: Mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: X offset in texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Y offset in texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of texture block. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of texture block. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Texture update data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_pitch</span></code>: Pitch of input image (bytes). When _pitch is set to UINT16_MAX, it will be calculated internally based on _width.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<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>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_texture_3d</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">_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>: 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15updateTexture3DE13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory">
|
||
<span id="bgfx::updateTexture3D__TextureHandle.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t.MemoryCP"></span><span class="target" id="namespacebgfx_1a06eac3248ec624cabb955c1798d70f6a"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateTexture3D</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, uint8_t <em>_mip</em>, uint16_t <em>_x</em>, uint16_t <em>_y</em>, uint16_t <em>_z</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint16_t <em>_depth</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15updateTexture3DE13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update 3D texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_texture_3d</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">_mip</span></code>: Mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: X offset in texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Y offset in texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_z</span></code>: Z offset in texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of texture block. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of texture block. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depth</span></code>: Depth of texture block. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Texture update data.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<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>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_texture_cube</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_size</span></code>: Cube side size. </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_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>: 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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17updateTextureCubeE13TextureHandle8uint16_t7uint8_t7uint8_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory8uint16_t">
|
||
<span id="bgfx::updateTextureCube__TextureHandle.uint16_t.uint8_t.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.MemoryCP.uint16_t"></span><span class="target" id="namespacebgfx_1ac9d22140d3eb8366a77e14dbd02a89d2"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateTextureCube</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, uint16_t <em>_layer</em>, uint8_t <em>_side</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="#_CPPv2N4bgfx17updateTextureCubeE13TextureHandle8uint16_t7uint8_t7uint8_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update Cube texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_update_texture_cube</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">_layer</span></code>: Layers in texture array. </li>
|
||
<li><code class="docutils literal"><span class="pre">_side</span></code>: Cubemap side <code class="docutils literal"><span class="pre">BGFX_CUBE_MAP_<POSITIVE</span> <span class="pre">or</span> <span class="pre">NEGATIVE>_<X,</span> <span class="pre">Y</span> <span class="pre">or</span> <span class="pre">Z></span></code>, where 0 is +X, 1 is -X, 2 is +Y, 3 is -Y, 4 is +Z, and 5 is -Z. <div class="highlight-python"><div class="highlight"><pre> +----------+
|
||
|-z 2|
|
||
| ^ +y |
|
||
| | | Unfolded cube:
|
||
| +---->+x |
|
||
+----------+----------+----------+----------+
|
||
|+y 1|+y 4|+y 0|+y 5|
|
||
| ^ -x | ^ +z | ^ +x | ^ -z |
|
||
| | | | | | | | |
|
||
| +---->+z | +---->+x | +---->-z | +---->-x |
|
||
+----------+----------+----------+----------+
|
||
|+z 3|
|
||
| ^ -y |
|
||
| | |
|
||
| +---->+x |
|
||
+----------+
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><code class="docutils literal"><span class="pre">_mip</span></code>: Mip level. </li>
|
||
<li><code class="docutils literal"><span class="pre">_x</span></code>: X offset in texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_y</span></code>: Y offset in texture. </li>
|
||
<li><code class="docutils literal"><span class="pre">_width</span></code>: Width of texture block. </li>
|
||
<li><code class="docutils literal"><span class="pre">_height</span></code>: Height of texture block. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mem</span></code>: Texture update data. </li>
|
||
<li><code class="docutils literal"><span class="pre">_pitch</span></code>: Pitch of input image (bytes). When _pitch is set to UINT16_MAX, it will be calculated internally based on _width.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11readTextureE13TextureHandlePv7uint8_t">
|
||
<span id="bgfx::readTexture__TextureHandle.voidP.uint8_t"></span><span class="target" id="namespacebgfx_1a917250df0398e10837853d1a2d416279"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">readTexture</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, void *<em>_data</em>, uint8_t <em>_mip</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11readTextureE13TextureHandlePv7uint8_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read back texture content. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Frame number when the result will be available. See: <code class="docutils literal"><a class="reference internal" href="#namespacebgfx_1a7b228b3e83595148e428a248d73480e8"><span><span class="pre">bgfx::frame</span></span></a></code>.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_READ_BACK</span></code> flag. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_READ_BACK</span></code>. </dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_read_texture</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">_data</span></code>: Destination buffer. </li>
|
||
<li><code class="docutils literal"><span class="pre">_mip</span></code>: Mip level.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx18getDirectAccessPtrE13TextureHandle">
|
||
<span id="bgfx::getDirectAccessPtr__TextureHandle"></span><span class="target" id="namespacebgfx_1a4d5729a970dc429b53b9fd1aae57d78b"></span>void *<code class="descclassname">bgfx::</code><code class="descname">getDirectAccessPtr</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx18getDirectAccessPtrE13TextureHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns texture direct access pointer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Pointer to texture memory. If returned pointer is <code class="docutils literal"><span class="pre">NULL</span></code> direct access is not available for this texture. If pointer is <code class="docutils literal"><span class="pre">UINTPTR_MAX</span></code> sentinel value it means texture is pending creation. Pointer returned can be cached and it will be valid until texture is destroyed.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_DIRECT_ACCESS</span></code>. This feature is available on GPUs that have unified memory architecture (UMA) support.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_direct_access_ptr</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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE13TextureHandle">
|
||
<span id="bgfx::destroy__TextureHandle"></span><span class="target" id="namespacebgfx_1a28453c61a3b211da273ee4f4957dc66d"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE13TextureHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_texture</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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</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_tN13TextureFormat4EnumE8uint64_t">
|
||
<span id="bgfx::createFrameBuffer__uint16_t.uint16_t.TextureFormat::Enum.uint64_t"></span><span class="target" id="namespacebgfx_1aa94cfbb370d1b658ffd8fceb305fe247"></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>, uint64_t <em>_textureFlags</em> = BGFX_SAMPLER_U_CLAMP|BGFX_SAMPLER_V_CLAMP<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferE8uint16_t8uint16_tN13TextureFormat4EnumE8uint64_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_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>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17createFrameBufferEN15BackbufferRatio4EnumEN13TextureFormat4EnumE8uint64_t">
|
||
<span id="bgfx::createFrameBuffer__BackbufferRatio::Enum.TextureFormat::Enum.uint64_t"></span><span class="target" id="namespacebgfx_1a6be2c49c878583ad701bc6eab72bc0af"></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>, uint64_t <em>_textureFlags</em> = BGFX_SAMPLER_U_CLAMP|BGFX_SAMPLER_V_CLAMP<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferEN15BackbufferRatio4EnumEN13TextureFormat4EnumE8uint64_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_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>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<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>
|
||
<dd><p>Create MRT frame buffer from texture handles (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_from_handles</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of texture attachments. </li>
|
||
<li><code class="docutils literal"><span class="pre">_handles</span></code>: Texture attachments. </li>
|
||
<li><code class="docutils literal"><span class="pre">_destroyTextures</span></code>: If true, textures will be destroyed when frame buffer is destroyed.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17createFrameBufferEPv8uint16_t8uint16_tN13TextureFormat4EnumEN13TextureFormat4EnumE">
|
||
<span id="bgfx::createFrameBuffer__voidP.uint16_t.uint16_t.TextureFormat::Enum.TextureFormat::Enum"></span><span class="target" id="namespacebgfx_1a71ca85e47af91a6f74a9de1695357603"></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>_format</em> = TextureFormat::Count, <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::Count<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferEPv8uint16_t8uint16_tN13TextureFormat4EnumEN13TextureFormat4EnumE" 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’ 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">_format</span></code>: Window back buffer color format. </li>
|
||
<li><code class="docutils literal"><span class="pre">_depthFormat</span></code>: Window back buffer depth format.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<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>
|
||
<dd><p>Frame buffer texture attachment info. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_attachment_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Attachment6handleE">
|
||
<span id="bgfx::Attachment::handle__TextureHandle"></span><span class="target" id="structbgfx_1_1_attachment_1a9eb8a8e6925c92291c43781a304f2acb"></span>TextureHandle <code class="descname">handle</code><a class="headerlink" href="#_CPPv2N4bgfx10Attachment6handleE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Texture handle. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Attachment3mipE">
|
||
<span id="bgfx::Attachment::mip__uint16_t"></span><span class="target" id="structbgfx_1_1_attachment_1add533a2475b7340c010a2718f7f5ed1e"></span>uint16_t <code class="descname">mip</code><a class="headerlink" href="#_CPPv2N4bgfx10Attachment3mipE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Mip level. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Attachment5layerE">
|
||
<span id="bgfx::Attachment::layer__uint16_t"></span><span class="target" id="structbgfx_1_1_attachment_1aea8de271c840deb81f0d0d8743f034b2"></span>uint16_t <code class="descname">layer</code><a class="headerlink" href="#_CPPv2N4bgfx10Attachment5layerE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Cubemap side or depth layer/slice. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx10Attachment7resolveE">
|
||
<span id="bgfx::Attachment::resolve__uint8_t"></span><span class="target" id="structbgfx_1_1_attachment_1ac84f3fa991b954245f5bf6e6efa2a364"></span>uint8_t <code class="descname">resolve</code><a class="headerlink" href="#_CPPv2N4bgfx10Attachment7resolveE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resolve flags. See: <code class="docutils literal"><span class="pre">BGFX_RESOLVE_*</span></code> </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17createFrameBufferE7uint8_tPK10Attachmentb">
|
||
<span id="bgfx::createFrameBuffer__uint8_t.AttachmentCP.b"></span><span class="target" id="namespacebgfx_1abbcc1474325bfa2c48d24e8fa4d28459"></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> <a class="reference internal" href="#_CPPv2N4bgfx10AttachmentE" title="bgfx::Attachment">Attachment</a> *<em>_attachment</em>, bool <em>_destroyTextures</em> = false<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferE7uint8_tPK10Attachmentb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create MRT frame buffer from texture handles with specific layer and mip level. </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_from_attachment</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of texture attachments. </li>
|
||
<li><code class="docutils literal"><span class="pre">_attachment</span></code>: <a class="reference internal" href="#structbgfx_1_1_attachment"><span>Attachment</span></a> texture info. See: <code class="docutils literal"><a class="reference internal" href="#structbgfx_1_1_attachment"><span><span class="pre">bgfx::Attachment</span></span></a></code>. </li>
|
||
<li><code class="docutils literal"><span class="pre">_destroyTextures</span></code>: If true, textures will be destroyed when frame buffer is destroyed.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10getTextureE17FrameBufferHandle7uint8_t">
|
||
<span id="bgfx::getTexture__FrameBufferHandle.uint8_t"></span><span class="target" id="namespacebgfx_1a2da13e6e8e942839d08390db8374b9e7"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">getTexture</code><span class="sig-paren">(</span>FrameBufferHandle <em>_handle</em>, uint8_t <em>_attachment</em> = 0<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10getTextureE17FrameBufferHandle7uint8_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Obtain texture handle of frame buffer attachment. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Returns invalid texture handle if attachment index is not correct, or frame buffer is created with native window handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_texture</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>: Frame buffer handle. </li>
|
||
<li><code class="docutils literal"><span class="pre">_attachment</span></code>: Frame buffer attachment index.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE17FrameBufferHandle">
|
||
<span id="bgfx::destroy__FrameBufferHandle"></span><span class="target" id="namespacebgfx_1aedeb0832cfdb4835cc3b631be5bf35db"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>FrameBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE17FrameBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy frame buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_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">_handle</span></code>: Frame buffer handle.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="instance-buffer">
|
||
<h3>Instance Buffer<a class="headerlink" href="#instance-buffer" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx26getAvailInstanceDataBufferE8uint32_t8uint16_t">
|
||
<span id="bgfx::getAvailInstanceDataBuffer__uint32_t.uint16_t"></span><span class="target" id="namespacebgfx_1abf9468e87a327e237d561229b5b917cb"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">getAvailInstanceDataBuffer</code><span class="sig-paren">(</span>uint32_t <em>_num</em>, uint16_t <em>_stride</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx26getAvailInstanceDataBufferE8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns number of requested or maximum available instance buffer slots. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_avail_instance_data_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of required instances. </li>
|
||
<li><code class="docutils literal"><span class="pre">_stride</span></code>: Stride per instance.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx23allocInstanceDataBufferEP18InstanceDataBuffer8uint32_t8uint16_t">
|
||
<span id="bgfx::allocInstanceDataBuffer__InstanceDataBufferP.uint32_t.uint16_t"></span><span class="target" id="namespacebgfx_1a57f18c024a3c7f0f1e902dc85b987757"></span>void <code class="descclassname">bgfx::</code><code class="descname">allocInstanceDataBuffer</code><span class="sig-paren">(</span>InstanceDataBuffer *<em>_idb</em>, uint32_t <em>_num</em>, uint16_t <em>_stride</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx23allocInstanceDataBufferEP18InstanceDataBuffer8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Allocate instance data buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_instance_data_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_idb</span></code>: InstanceDataBuffer structure is filled and is valid for duration of frame, and it can be reused for multiple draw calls. </li>
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of instances. </li>
|
||
<li><code class="docutils literal"><span class="pre">_stride</span></code>: Instance stride. Must be multiple of 16.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="indirect-buffer">
|
||
<h3>Indirect Buffer<a class="headerlink" href="#indirect-buffer" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx20createIndirectBufferE8uint32_t">
|
||
<span id="bgfx::createIndirectBuffer__uint32_t"></span><span class="target" id="namespacebgfx_1a8a3c563fcf814144a76360b17b60f7e8"></span>IndirectBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createIndirectBuffer</code><span class="sig-paren">(</span>uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx20createIndirectBufferE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create draw indirect buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Indirect buffer handle.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_indirect_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last simple">
|
||
<li><code class="docutils literal"><span class="pre">_num</span></code>: Number of indirect calls. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE20IndirectBufferHandle">
|
||
<span id="bgfx::destroy__IndirectBufferHandle"></span><span class="target" id="namespacebgfx_1a5ff8e7d7902e4cd61125955df3aa9daa"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>IndirectBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE20IndirectBufferHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy draw indirect buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_indirect_buffer</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>: Indirect buffer handle.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="occlusion-query">
|
||
<h3>Occlusion Query<a class="headerlink" href="#occlusion-query" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx20createOcclusionQueryEv">
|
||
<span id="bgfx::createOcclusionQuery"></span><span class="target" id="namespacebgfx_1a6c9054faddeffa204c82105b9b5814dd"></span>OcclusionQueryHandle <code class="descclassname">bgfx::</code><code class="descname">createOcclusionQuery</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx20createOcclusionQueryEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create occlusion query. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Handle to occlusion query object.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_occlusion_query</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx20OcclusionQueryResultE">
|
||
<span id="bgfx::OcclusionQueryResult"></span><span class="target" id="structbgfx_1_1_occlusion_query_result"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">OcclusionQueryResult</code><a class="headerlink" href="#_CPPv2N4bgfx20OcclusionQueryResultE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Occlusion query result. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_occlusion_query_result_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Types</p>
|
||
<dl class="type">
|
||
<dt id="_CPPv2N4bgfx20OcclusionQueryResult4EnumE">
|
||
<span id="bgfx::OcclusionQueryResult::Enum"></span><span class="target" id="structbgfx_1_1_occlusion_query_result_1ac0c21b4efbf73289b19a035bd75b8e8c"></span><em class="property">enum </em><code class="descname">Enum</code><a class="headerlink" href="#_CPPv2N4bgfx20OcclusionQueryResult4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Occlusion query results: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx20OcclusionQueryResult9InvisibleE">
|
||
<span class="target" id="structbgfx_1_1_occlusion_query_result_1ac0c21b4efbf73289b19a035bd75b8e8ca2364647c4ea4e3b1999f9602323fad4c"></span><code class="descname">Invisible</code><a class="headerlink" href="#_CPPv2N4bgfx20OcclusionQueryResult9InvisibleE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Query failed test. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx20OcclusionQueryResult7VisibleE">
|
||
<span class="target" id="structbgfx_1_1_occlusion_query_result_1ac0c21b4efbf73289b19a035bd75b8e8ca61b3fa648c1c7acc8a3b62e17920a798"></span><code class="descname">Visible</code><a class="headerlink" href="#_CPPv2N4bgfx20OcclusionQueryResult7VisibleE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Query passed test. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx20OcclusionQueryResult8NoResultE">
|
||
<span class="target" id="structbgfx_1_1_occlusion_query_result_1ac0c21b4efbf73289b19a035bd75b8e8ca19ab4aa30c501d80de1ee07962bbe6be"></span><code class="descname">NoResult</code><a class="headerlink" href="#_CPPv2N4bgfx20OcclusionQueryResult8NoResultE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Query result is not available yet. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="enumerator">
|
||
<dt id="_CPPv2N4bgfx20OcclusionQueryResult5CountE">
|
||
<span class="target" id="structbgfx_1_1_occlusion_query_result_1ac0c21b4efbf73289b19a035bd75b8e8ca7d146e3527bb06d8c6b3934eead6b22a"></span><code class="descname">Count</code><a class="headerlink" href="#_CPPv2N4bgfx20OcclusionQueryResult5CountE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9getResultE20OcclusionQueryHandleP7int32_t">
|
||
<span id="bgfx::getResult__OcclusionQueryHandle.int32_tP"></span><span class="target" id="namespacebgfx_1abccef1bca742db8d7b55e81ad5088f1a"></span><a class="reference internal" href="#_CPPv2N4bgfx20OcclusionQueryResultE" title="bgfx::OcclusionQueryResult">OcclusionQueryResult</a>::<a class="reference internal" href="#_CPPv2N4bgfx20OcclusionQueryResult4EnumE" title="bgfx::OcclusionQueryResult::Enum">Enum</a> <code class="descclassname">bgfx::</code><code class="descname">getResult</code><span class="sig-paren">(</span>OcclusionQueryHandle <em>_handle</em>, int32_t *<em>_result</em> = NULL<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx9getResultE20OcclusionQueryHandleP7int32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieve occlusion query result from previous frame. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Occlusion query result.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_get_result</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>: Handle to occlusion query object. </li>
|
||
<li><code class="docutils literal"><span class="pre">_result</span></code>: Number of pixels that passed test. This argument can be <code class="docutils literal"><span class="pre">NULL</span></code> if result of occlusion query is not needed. </li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx7destroyE20OcclusionQueryHandle">
|
||
<span id="bgfx::destroy__OcclusionQueryHandle"></span><span class="target" id="namespacebgfx_1ac23e1de099833621a7ca0121f0ccae6d"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroy</code><span class="sig-paren">(</span>OcclusionQueryHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx7destroyE20OcclusionQueryHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy occlusion query. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_destroy_occlusion_query</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>: Handle to occlusion query object.</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="tools.html" class="btn btn-neutral float-right" title="Tools" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="examples.html" class="btn btn-neutral" title="Examples" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2010-2018, Branimir Karadžić.
|
||
|
||
</p>
|
||
</div>
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'./',
|
||
VERSION:'1.0',
|
||
COLLAPSE_INDEX:false,
|
||
FILE_SUFFIX:'.html',
|
||
HAS_SOURCE: false
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.StickyNav.enable();
|
||
});
|
||
</script>
|
||
|
||
|
||
</body>
|
||
</html> |