4501 lines
315 KiB
HTML
4501 lines
315 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-nav-search">
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> bgfx
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<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><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-is-it">What is it?</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-rendering-backends">Supported rendering backends</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-hmd">Supported HMD</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-platforms">Supported Platforms</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-compilers">Supported Compilers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#supported-languages">Supported Languages</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#project-page">Project Page</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contact">Contact</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#internals">Internals</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#customization">Customization</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#debugging-and-profiling">Debugging and Profiling</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#renderdoc">RenderDoc</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#intelgpa">IntelGPA</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#other-debuggers-and-profilers">Other Debuggers and Profilers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#sdl-glfw-etc">SDL, GLFW, etc.</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#todo">Todo</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html#getting-involved">Getting Involved</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#contributors">Contributors</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="overview.html#repository-visualization">Repository visualization</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="build.html">Building</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="build.html#dependencies">Dependencies</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="build.html#getting-source">Getting Source</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="build.html#quick-start">Quick Start</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="build.html#prerequisites">Prerequisites</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#android">Android</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#linux">Linux</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#native-client">Native Client</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#windows">Windows</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="build.html#build">Build</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#general">General</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#id1">Windows</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#xcode-5">Xcode 5</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#id2">Linux</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="build.html#winrt-windows-phone-8-1">WinRT / Windows Phone 8.1</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="build.html#amalgamated-build">Amalgamated Build</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="build.html#oculusvr-integration">OculusVR Integration</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#helloworld">00-helloworld</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#cubes">01-cubes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#metaballs">02-metaballs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#raymarch">03-raymarch</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#mesh">04-mesh</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#instancing">05-instancing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#bump">06-bump</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#callback">07-callback</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#update">08-update</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#hdr">09-hdr</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#font">10-font</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#fontsdf">11-fontsdf</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#lod">12-lod</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#stencil">13-stencil</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowvolumes">14-shadowvolumes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps-simple">15-shadowmaps-simple</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#shadowmaps">16-shadowmaps</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#drawstress">17-drawstress</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz">60Hz</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="examples.html#hz-test-for-browsers">30Hz (test for browsers)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#ibl">18-ibl</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#oit">19-oit</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nanovg">20-nanovg</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#deferred">21-deferred</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#windows">22-windows</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#vectordisplay">23-vectordisplay</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="examples.html#nbody">24-nbody</a></li>
|
||
</ul>
|
||
</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>
|
||
<li class="toctree-l4"><a class="reference internal" href="#head-mounted-display">Head Mounted Display</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="#draw">Draw</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#state">State</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id1">Debug</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id2">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>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#buffers">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="#submit">Submit</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#compute">Compute</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id3">Buffers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#images">Images</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#dispatch">Dispatch</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#blit">Blit</a></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="#id4">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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tools.html">Tools</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="tools.html#shader-compiler-shaderc">Shader Compiler (shaderc)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tools.html#texture-compiler-texturec">Texture Compiler (texturec)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tools.html#geometry-compiler-geometryc">Geometry Compiler (geometryc)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="license.html#license-bsd-2-clause">License (BSD 2-clause)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="license.html#rd-party-libraries">3rd Party Libraries</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#blendish-mit">Blendish (MIT)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#edtaa3-mit">edtaa3 (MIT)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#fcpp-bsd">fcpp (BSD)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#forsyth-triangle-order-optimizer-public-domain">Forsyth Triangle Order Optimizer (Public Domain)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#freetype">FreeType</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#glsl-optimizer-mit">glsl-optimizer (MIT)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#nanovg-zlib">NanoVG (ZLIB)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#imgui-mit">ImGui (MIT)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#sdf-mit">SDF (MIT)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#stb-public-domain">stb (Public Domain)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="license.html#vertex-cache-optimised-index-buffer-compression-bsd">Vertex Cache Optimised Index Buffer Compression (BSD)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="license.html#assets">Assets</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
</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">
|
||
|
||
<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="function">
|
||
<dt id="_CPPv2N4bgfx4initEN12RendererType4EnumE8uint16_t8uint16_tP9CallbackIPN2bx12ReallocatorIE">
|
||
<span id="bgfx::init__RendererType::Enum.uint16_t.uint16_t.CallbackIP.bx::ReallocatorIP"></span><span class="target" id="project0namespacebgfx_1ae8474ed41cf78992f5aa1285652fdaa9"></span>bool <code class="descclassname">bgfx::</code><code class="descname">init</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>_type</em>, uint16_t <em>_vendorId</em>, uint16_t <em>_deviceId</em>, <a class="reference internal" href="#_CPPv2N4bgfx9CallbackIE" title="bgfx::CallbackI">CallbackI</a> *<em>_callback</em>, bx::ReallocatorI *<em>_reallocator</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4initEN12RendererType4EnumE8uint16_t8uint16_tP9CallbackIPN2bx12ReallocatorIE" 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 is sucessful.</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">
|
||
<li><code class="first docutils literal"><span class="pre">_type</span></code> - <p>Select rendering backend. When set to RendererType::Count default rendering backend will be selected. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_renderer_type"><span><span class="pre">bgfx::RendererType</span></span></a></code></p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_vendorId</span></code> - <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.<ul class="simple">
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_NONE</span></code> - autoselect.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_AMD</span></code> - AMD.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_INTEL</span></code> - Intel.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_PCI_ID_NVIDIA</span></code> - nVidia.</li>
|
||
</ul>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_deviceId</span></code> - <p>Device id. If set to 0 it will select first device, or device with matching id.</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_callback</span></code> - <p>Provide application specific callback interface. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_callback_i"><span><span class="pre">bgfx::CallbackI</span></span></a></code></p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_reallocator</span></code> - <p>Custom allocator. When custom allocator is not specified, library uses default CRT allocator. The library assumes icustom allocator is thread safe.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_PCI_ID_NONE">
|
||
<span class="target" id="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0structbgfx_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="_CPPv2N4bgfx9CallbackI5fatalEN5Fatal4EnumEPKc">
|
||
<span id="bgfx::CallbackI::fatal__Fatal::Enum.cCP"></span>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1af750c41067cd6ee600d841cf557065aa"></span>void <code class="descname">fatal</code><span class="sig-paren">(</span>Fatal::Enum <em>_code</em>, <em class="property">const</em> char *<em>_str</em><span class="sig-paren">)</span> = 0<a class="headerlink" href="#_CPPv2N4bgfx9CallbackI5fatalEN5Fatal4EnumEPKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If fatal code code is not Fatal::DebugCheck this callback is called on unrecoverable error. It’s not safe to continue, inform user and terminate application from this call. </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">
|
||
<li><code class="first docutils literal"><span class="pre">_code</span></code> - <p>Fatal error code. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_str</span></code> - <p>More information about error.</p>
|
||
</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>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1a55bde1947f1347a2c9360824d08314da"></span>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">
|
||
<li><code class="first docutils literal"><span class="pre">_filePath</span></code> - <p>File path where debug message was generated. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_line</span></code> - <p>Line where debug message was generated. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p><code class="docutils literal"><span class="pre">printf</span></code> style format. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_argList</span></code> - <p>Variable arguments list initialized with <code class="docutils literal"><span class="pre">va_start</span></code>.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI13cacheReadSizeE8uint64_t">
|
||
<span id="bgfx::CallbackI::cacheReadSize__uint64_t"></span>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1a0e42c49e7a21b94a8866f4ad0e76a317"></span>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>Return size of for cached item. Return 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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>Cache id. </p>
|
||
</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>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1a37f081ba5631e93449e64886190d5c90"></span>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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>Cache id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Buffer where to read data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_size</span></code> - <p>Size of data to read.</p>
|
||
</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>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1af4cf9d4f3ce9d5280a5f6cd0cd78600e"></span>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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>Cache id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Data to write. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_size</span></code> - <p>Size of data to write.</p>
|
||
</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>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"></span>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">
|
||
<li><code class="first docutils literal"><span class="pre">_filePath</span></code> - <p>File path. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Image width. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Image height. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_pitch</span></code> - <p>Number of bytes to skip to next line. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Image data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_size</span></code> - <p>Image size. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_yflip</span></code> - <p>If true image origin is bottom left.</p>
|
||
</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>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1afbf52f537e1bf54a4c20f6efb2654231"></span>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 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>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9CallbackI10captureEndEv">
|
||
<span id="bgfx::CallbackI::captureEnd"></span>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1af4a233dccba408ad9c0c1fa3a8491c4b"></span>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 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>virtual <span class="target" id="project0structbgfx_1_1_callback_i_1a02b34e3ca8968184330c8247984c2365"></span>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">
|
||
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Image data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_size</span></code> - <p>Image size.</p>
|
||
</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="project0namespacebgfx_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_t">
|
||
<span id="bgfx::reset__uint32_t.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1ab2506f91853a4c3bb0f25b581638291c"></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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5resetE8uint32_t8uint32_t8uint32_t" 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><p class="first">This call doesn’t actually change window size, it just resizes back-buffer. Windowing code has to change window size.</p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_reset</span></code>. </p>
|
||
</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Back-buffer width. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Back-buffer height. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>See: <code class="docutils literal"><span class="pre">BGFX_RESET_*</span></code> for more info.<ul class="simple">
|
||
<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_HMD</span></code> - <a class="reference internal" href="#project0structbgfx_1_1_h_m_d"><span>HMD</span></a> stereo rendering.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD_DEBUG</span></code> - <a class="reference internal" href="#project0structbgfx_1_1_h_m_d"><span>HMD</span></a> stereo rendering debug mode.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_RESET_HMD_RECENTER</span></code> - <a class="reference internal" href="#project0structbgfx_1_1_h_m_d"><span>HMD</span></a> calibration.</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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_NONE">
|
||
<span class="target" id="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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_HMD">
|
||
<span class="target" id="project0bgfxdefines_8h_1a10365b783e6435920a2a4e107d3cf0af"></span><code class="descname">BGFX_RESET_HMD</code><a class="headerlink" href="#c.BGFX_RESET_HMD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HMD stereo rendering. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_HMD_DEBUG">
|
||
<span class="target" id="project0bgfxdefines_8h_1a35ee9c476985f91c2cedef68e1ffdd6e"></span><code class="descname">BGFX_RESET_HMD_DEBUG</code><a class="headerlink" href="#c.BGFX_RESET_HMD_DEBUG" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HMD stereo rendering debug mode. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_HMD_RECENTER">
|
||
<span class="target" id="project0bgfxdefines_8h_1ab078d316ca2bc294a5661b9a7d99910c"></span><code class="descname">BGFX_RESET_HMD_RECENTER</code><a class="headerlink" href="#c.BGFX_RESET_HMD_RECENTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HMD calibration. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_RESET_FLUSH_AFTER_RENDER">
|
||
<span class="target" id="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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>
|
||
|
||
</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="_CPPv2N4bgfx5frameEv">
|
||
<span id="bgfx::frame"></span><span class="target" id="project0namespacebgfx_1afdc2d817c439383ffffdc0a7610e2fa1"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">frame</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5frameEv" 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="#project0namespacebgfx_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>
|
||
</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="project0namespacebgfx_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">
|
||
<li><code class="first docutils literal"><span class="pre">_debug</span></code> - <p>Available flags:<ul class="simple">
|
||
<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. It’s useful when profiling to quickly assess bottleneck between CPU and GPU.</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>
|
||
</p>
|
||
</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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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="project0bgfxdefines_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>
|
||
|
||
</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="project0namespacebgfx_1ac7c16eafe7657464ed6fef8eca0c4c2a"></span>void <code class="descclassname">bgfx::</code><code class="descname">dbgTextClear</code><span class="sig-paren">(</span>uint8_t <em>_attr</em>, bool <em>_small</em><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>
|
||
</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="project0namespacebgfx_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 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_printf</span></code>. </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="project0namespacebgfx_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="project0structbgfx_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="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType4NullE">
|
||
<span id="bgfx::RendererType::Null"></span><span class="target" id="project0structbgfx_1_1_renderer_type_1a23d258e890027d7deff9d971e2493a32ab2e5390624b2fd978b59099c1b65763d"></span><code class="descname">Null</code><a class="headerlink" href="#_CPPv2N4bgfx12RendererType4NullE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>No rendering. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType9Direct3D9E">
|
||
<span id="bgfx::RendererType::Direct3D9"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType10Direct3D11E">
|
||
<span id="bgfx::RendererType::Direct3D11"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType10Direct3D12E">
|
||
<span id="bgfx::RendererType::Direct3D12"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType5MetalE">
|
||
<span id="bgfx::RendererType::Metal"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType8OpenGLESE">
|
||
<span id="bgfx::RendererType::OpenGLES"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType6OpenGLE">
|
||
<span id="bgfx::RendererType::OpenGL"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType6VulkanE">
|
||
<span id="bgfx::RendererType::Vulkan"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx12RendererType5CountE">
|
||
<span id="bgfx::RendererType::Count"></span><span class="target" id="project0structbgfx_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="project0namespacebgfx_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="#project0structbgfx_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="project0structbgfx_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="project0structbgfx_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="#project0structbgfx_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="project0structbgfx_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><ul class="simple">
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_COMPARE_LEQUAL</span></code> - Less equal texture compare mode.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_COMPARE_ALL</span></code> - All texture compare modes.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_3D</span></code> - 3D textures.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_VERTEX_ATTRIB_HALF</span></code> - AttribType::Half.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_INSTANCING</span></code> - Vertex instancing.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_RENDERER_MULTITHREADED</span></code> - Renderer on separate thread.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FRAGMENT_DEPTH</span></code> - Fragment shader can modify depth buffer value (gl_FragDepth).</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_BLEND_INDEPENDENT</span></code> - Multiple render targets can have different blend mode set individually.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_COMPUTE</span></code> - Renderer has compute shaders.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FRAGMENT_ORDERING</span></code> - Intel’s pixel sync.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_SWAP_CHAIN</span></code> - Multiple windows. </li>
|
||
</ul>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps12maxDrawCallsE">
|
||
<span id="bgfx::Caps::maxDrawCalls__uint32_t"></span><span class="target" id="project0structbgfx_1_1_caps_1ad1a16dbb664ceb94b6edc6ca028b7818"></span>uint32_t <code class="descname">maxDrawCalls</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps12maxDrawCallsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum draw calls. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps14maxTextureSizeE">
|
||
<span id="bgfx::Caps::maxTextureSize__uint16_t"></span><span class="target" id="project0structbgfx_1_1_caps_1a7e1866dc19eab68f57bac12525abca00"></span>uint16_t <code class="descname">maxTextureSize</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps14maxTextureSizeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum texture size. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps8maxViewsE">
|
||
<span id="bgfx::Caps::maxViews__uint16_t"></span><span class="target" id="project0structbgfx_1_1_caps_1a8b071c5f3e4f398910b664ba7e9fbb27"></span>uint16_t <code class="descname">maxViews</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps8maxViewsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum views. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps16maxFBAttachmentsE">
|
||
<span id="bgfx::Caps::maxFBAttachments__uint8_t"></span><span class="target" id="project0structbgfx_1_1_caps_1a5ab92b6fa6f5929d73de24a8291dd33f"></span>uint8_t <code class="descname">maxFBAttachments</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps16maxFBAttachmentsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Maximum frame buffer attachments. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps7numGPUsE">
|
||
<span id="bgfx::Caps::numGPUs__uint8_t"></span><span class="target" id="project0structbgfx_1_1_caps_1a4b1b11f121ff1ce7df944f4a5538406f"></span>uint8_t <code class="descname">numGPUs</code><a class="headerlink" href="#_CPPv2N4bgfx4Caps7numGPUsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of enumerated GPUs. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps8vendorIdE">
|
||
<span id="bgfx::Caps::vendorId__uint16_t"></span><span class="target" id="project0structbgfx_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="#project0structbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> vendor id. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps8deviceIdE">
|
||
<span id="bgfx::Caps::deviceId__uint16_t"></span><span class="target" id="project0structbgfx_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="#project0structbgfx_1_1_caps_1_1_g_p_u"><span>GPU</span></a> device id. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx4Caps3gpuE">
|
||
<span id="bgfx::Caps::gpu__GPUA"></span><span class="target" id="project0structbgfx_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="project0structbgfx_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 formats. </p>
|
||
<p><ul class="simple">
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_NONE</span></code> - not supported</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_2D</span></code> - supported</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_2D_EMULATED</span></code> - emulated</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_CAPS_FORMAT_TEXTURE_VERTEX</span></code> - supported vertex texture </li>
|
||
</ul>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx4Caps3GPUE">
|
||
<span id="bgfx::Caps::GPU"></span><span class="target" id="project0structbgfx_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="#project0structbgfx_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>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_TEXTURE_COMPARE_LEQUAL">
|
||
<span class="target" id="project0bgfxdefines_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_COMPARE_ALL">
|
||
<span class="target" id="project0bgfxdefines_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_3D">
|
||
<span class="target" id="project0bgfxdefines_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_VERTEX_ATTRIB_HALF">
|
||
<span class="target" id="project0bgfxdefines_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_INSTANCING">
|
||
<span class="target" id="project0bgfxdefines_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_RENDERER_MULTITHREADED">
|
||
<span class="target" id="project0bgfxdefines_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_FRAGMENT_DEPTH">
|
||
<span class="target" id="project0bgfxdefines_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_BLEND_INDEPENDENT">
|
||
<span class="target" id="project0bgfxdefines_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="project0bgfxdefines_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_FRAGMENT_ORDERING">
|
||
<span class="target" id="project0bgfxdefines_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_SWAP_CHAIN">
|
||
<span class="target" id="project0bgfxdefines_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_HMD">
|
||
<span class="target" id="project0bgfxdefines_8h_1a90daba42512c59b433058031335c0c47"></span><code class="descname">BGFX_CAPS_HMD</code><a class="headerlink" href="#c.BGFX_CAPS_HMD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Head Mounted Display is available. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_CAPS_INDEX32">
|
||
<span class="target" id="project0bgfxdefines_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_DRAW_INDIRECT">
|
||
<span class="target" id="project0bgfxdefines_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_HIDPI">
|
||
<span class="target" id="project0bgfxdefines_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>
|
||
|
||
</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="project0namespacebgfx_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>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx5StatsE">
|
||
<span id="bgfx::Stats"></span><span class="target" id="project0structbgfx_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>
|
||
</dl>
|
||
</p>
|
||
<div class="breathe-sectiondef container">
|
||
<p class="breathe-sectiondef-title rubric">Public Members</p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats7cpuTimeE">
|
||
<span id="bgfx::Stats::cpuTime__uint64_t"></span><span class="target" id="project0structbgfx_1_1_stats_1a127f672343a0dcfa3e0b174d26b8c544"></span>uint64_t <code class="descname">cpuTime</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats7cpuTimeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CPU frame time. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12cpuTimerFreqE">
|
||
<span id="bgfx::Stats::cpuTimerFreq__uint64_t"></span><span class="target" id="project0structbgfx_1_1_stats_1a0e62b1361829901d9f79f62ba557c7bd"></span>uint64_t <code class="descname">cpuTimerFreq</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats12cpuTimerFreqE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>CPU timer frequency. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats7gpuTimeE">
|
||
<span id="bgfx::Stats::gpuTime__uint64_t"></span><span class="target" id="project0structbgfx_1_1_stats_1a281de41a5f0f42c24cf64bc88bb35ed4"></span>uint64_t <code class="descname">gpuTime</code><a class="headerlink" href="#_CPPv2N4bgfx5Stats7gpuTimeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>GPU frame time. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx5Stats12gpuTimerFreqE">
|
||
<span id="bgfx::Stats::gpuTimerFreq__uint64_t"></span><span class="target" id="project0structbgfx_1_1_stats_1a832843b2601fa8c81ba6794e7780b563"></span>uint64_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>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="head-mounted-display">
|
||
<h4>Head Mounted Display<a class="headerlink" href="#head-mounted-display" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx6getHMDEv">
|
||
<span id="bgfx::getHMD"></span><span class="target" id="project0namespacebgfx_1a4da6ccef4febaf717d877852ac6b2b25"></span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx3HMDE" title="bgfx::HMD">HMD</a> *<code class="descclassname">bgfx::</code><code class="descname">getHMD</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6getHMDEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns <a class="reference internal" href="#project0structbgfx_1_1_h_m_d"><span>HMD</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_get_hmd</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx3HMDE">
|
||
<span id="bgfx::HMD"></span><span class="target" id="project0structbgfx_1_1_h_m_d"></span><em class="property">struct </em><code class="descclassname">bgfx::</code><code class="descname">HMD</code><a class="headerlink" href="#_CPPv2N4bgfx3HMDE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#project0structbgfx_1_1_h_m_d"><span>HMD</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_hmd_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="_CPPv2N4bgfx3HMD5widthE">
|
||
<span id="bgfx::HMD::width__uint16_t"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1ad093809cc663ce7f272282c7b049611c"></span>uint16_t <code class="descname">width</code><a class="headerlink" href="#_CPPv2N4bgfx3HMD5widthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Framebuffer width. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx3HMD6heightE">
|
||
<span id="bgfx::HMD::height__uint16_t"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1a8b918bcaef2145d1783926b3241d9f18"></span>uint16_t <code class="descname">height</code><a class="headerlink" href="#_CPPv2N4bgfx3HMD6heightE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Framebuffer width. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx3HMD11deviceWidthE">
|
||
<span id="bgfx::HMD::deviceWidth__uint32_t"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1aaf60b6bb2a1c6b46cd1637e62a2a1b32"></span>uint32_t <code class="descname">deviceWidth</code><a class="headerlink" href="#_CPPv2N4bgfx3HMD11deviceWidthE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device resolution width. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx3HMD12deviceHeightE">
|
||
<span id="bgfx::HMD::deviceHeight__uint32_t"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1afc717cd684b68ec13ff8ce3e5228008f"></span>uint32_t <code class="descname">deviceHeight</code><a class="headerlink" href="#_CPPv2N4bgfx3HMD12deviceHeightE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Device resolution height. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx3HMD5flagsE">
|
||
<span id="bgfx::HMD::flags__uint8_t"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1ad06355a240c30f266462745624b6d5db"></span>uint8_t <code class="descname">flags</code><a class="headerlink" href="#_CPPv2N4bgfx3HMD5flagsE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Status flags. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx3HMD3EyeE">
|
||
<span id="bgfx::HMD::Eye"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1_1_eye"></span><em class="property">struct </em><code class="descname">Eye</code><a class="headerlink" href="#_CPPv2N4bgfx3HMD3EyeE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#project0structbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a>. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_hmd_eye_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="_CPPv2N4bgfx3HMD3Eye8rotationE">
|
||
<span id="bgfx::HMD::Eye::rotation__floatA"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1_1_eye_1a5cd423f29878115cce05edd155e7323d"></span>float <code class="descname">rotation</code>[4]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye8rotationE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#project0structbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a> rotation represented as quaternion. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx3HMD3Eye11translationE">
|
||
<span id="bgfx::HMD::Eye::translation__floatA"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1_1_eye_1a668e56a83e86667feb2475d4f7023da8"></span>float <code class="descname">translation</code>[3]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye11translationE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#project0structbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a> translation. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx3HMD3Eye3fovE">
|
||
<span id="bgfx::HMD::Eye::fov__floatA"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1_1_eye_1ae13f19ce665f317cf96b36a0271e0126"></span>float <code class="descname">fov</code>[4]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye3fovE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Field of view (up, down, left, right). </p>
|
||
</dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx3HMD3Eye10viewOffsetE">
|
||
<span id="bgfx::HMD::Eye::viewOffset__floatA"></span><span class="target" id="project0structbgfx_1_1_h_m_d_1_1_eye_1a66c74ef9fc006582cbb89dc1a66d9802"></span>float <code class="descname">viewOffset</code>[3]<a class="headerlink" href="#_CPPv2N4bgfx3HMD3Eye10viewOffsetE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><a class="reference internal" href="#project0structbgfx_1_1_h_m_d_1_1_eye"><span>Eye</span></a> view matrix translation adjustment. </p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_HMD_NONE">
|
||
<span class="target" id="project0bgfxdefines_8h_1a3ac67824cc42497782025993b6bb54f3"></span><code class="descname">BGFX_HMD_NONE</code><a class="headerlink" href="#c.BGFX_HMD_NONE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>None. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_HMD_DEVICE_RESOLUTION">
|
||
<span class="target" id="project0bgfxdefines_8h_1a3d7805ee1a27ac0d128e245e2d9639d7"></span><code class="descname">BGFX_HMD_DEVICE_RESOLUTION</code><a class="headerlink" href="#c.BGFX_HMD_DEVICE_RESOLUTION" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Has HMD native resolution. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_HMD_RENDERING">
|
||
<span class="target" id="project0bgfxdefines_8h_1a28f6309e935fdd3919402a3622aba5eb"></span><code class="descname">BGFX_HMD_RENDERING</code><a class="headerlink" href="#c.BGFX_HMD_RENDERING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Rendering to HMD. </p>
|
||
</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="_CPPv2N4bgfx11renderFrameEv">
|
||
<span id="bgfx::renderFrame"></span><span class="target" id="project0namespacebgfx_1a317be13a4bbc51e8bdf29b48e0eb9e56"></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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11renderFrameEv" 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="#project0structbgfx_1_1_render_frame"><span><span class="pre">bgfx::RenderFrame</span></span></a></code>.</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="#project0namespacebgfx_1ae8474ed41cf78992f5aa1285652fdaa9"><span>bgfx::init</span></a>, render thread won’t be created by <a class="reference internal" href="#project0namespacebgfx_1ae8474ed41cf78992f5aa1285652fdaa9"><span>bgfx::init</span></a> call. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx11RenderFrameE">
|
||
<span id="bgfx::RenderFrame"></span><span class="target" id="project0structbgfx_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="project0namespacebgfx_1aab900e25dcd02d003071bdee6b9b1435"></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>_hooks</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="#project0namespacebgfx_1ae8474ed41cf78992f5aa1285652fdaa9"><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="project0structbgfx_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="project0structbgfx_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="project0structbgfx_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="project0structbgfx_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="project0structbgfx_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="project0structbgfx_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>
|
||
|
||
</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="_CPPv2N4bgfx7discardEv">
|
||
<span id="bgfx::discard"></span><span class="target" id="project0namespacebgfx_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="_CPPv2N4bgfx5touchE7uint8_t">
|
||
<span id="bgfx::touch__uint8_t"></span><span class="target" id="project0namespacebgfx_1ad618bc888550110ff95d1b78c635e460"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">touch</code><span class="sig-paren">(</span>uint8_t <em>_id</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx5touchE7uint8_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Touch view. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setPaletteColorE7uint8_t8uint32_t">
|
||
<span id="bgfx::setPaletteColor__uint8_t.uint32_t"></span><span class="target" id="project0namespacebgfx_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">
|
||
<li><code class="first docutils literal"><span class="pre">_index</span></code> - <p>Index into palette. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_rgba</span></code> - <p>Packed 32-bit RGBA value.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setPaletteColorE7uint8_tKf">
|
||
<span id="bgfx::setPaletteColor__uint8_t.floatC"></span><span class="target" id="project0namespacebgfx_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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setPaletteColorE7uint8_tKf" 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">
|
||
<li><code class="first docutils literal"><span class="pre">_index</span></code> - <p>Index into palette. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_rgba</span></code> - <p>RGBA floating point value.</p>
|
||
</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="project0namespacebgfx_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">
|
||
<li><code class="first docutils literal"><span class="pre">_index</span></code> - <p>Index into palette. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_r</span><span class="pre">_g</span><span class="pre">_b</span><span class="pre">_a</span></code> - <p>RGBA floating point values.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14saveScreenShotEPKc">
|
||
<span id="bgfx::saveScreenShot__cCP"></span><span class="target" id="project0namespacebgfx_1ae03f0dcaf3bcad95d487861674c17428"></span>void <code class="descclassname">bgfx::</code><code class="descname">saveScreenShot</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>_filePath</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14saveScreenShotEPKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Request screen shot. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd><code class="docutils literal"><a class="reference internal" href="#project0structbgfx_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>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_save_screen_shot</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_filePath</span></code> - <p>Will be passed to <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_callback_i_1a44d38debc9d86b9815d55058afc762c6"><span><span class="pre">bgfx::CallbackI::screenShot</span></span></a></code> callback.</p>
|
||
</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::setViewRemap</cite>.</p>
|
||
<p>View state is preserved between multiple frames.</p>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11setViewNameE7uint8_tPKc">
|
||
<span id="bgfx::setViewName__uint8_t.cCP"></span><span class="target" id="project0namespacebgfx_1ab0d0a3f61f5adc31ee7f59f2893cfcd9"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewName</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, <em class="property">const</em> char *<em>_name</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11setViewNameE7uint8_tPKc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view name. </p>
|
||
<p>
|
||
In graphics debugger view name will appear as:<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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_name</span></code> - <p>View name.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
<p>“nnnce <view name>” ^ ^^ ^ | |+ eye (L/R) | + compute (C) + view id</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="_CPPv2N4bgfx11setViewRectE7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::setViewRect__uint8_t.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="project0namespacebgfx_1a0d9b4f0ae1b9ca9d637c1062910d468a"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewRect</code><span class="sig-paren">(</span>uint8_t <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="#_CPPv2N4bgfx11setViewRectE7uint8_t8uint16_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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_x</span></code> - <p>Position x from the left corner of the window. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_y</span></code> - <p>Position y from the top corner of the window. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of view port region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of view port region.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11setViewRectE7uint8_t8uint16_t8uint16_tN15BackbufferRatio4EnumE">
|
||
<span id="bgfx::setViewRect__uint8_t.uint16_t.uint16_t.BackbufferRatio::Enum"></span><span class="target" id="project0namespacebgfx_1a60262b4046cf2510dd3c216e13829c87"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewRect</code><span class="sig-paren">(</span>uint8_t <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="#_CPPv2N4bgfx11setViewRectE7uint8_t8uint16_t8uint16_tN15BackbufferRatio4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setViewScissorE7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::setViewScissor__uint8_t.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="project0namespacebgfx_1a3d1b68d9678d716e25795aa3eef2bfe1"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewScissor</code><span class="sig-paren">(</span>uint8_t <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="#_CPPv2N4bgfx14setViewScissorE7uint8_t8uint16_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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_x</span></code> - <p>Position x from the left corner of the window. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_y</span></code> - <p>Position y from the top corner of the window. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of scissor region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of scissor region.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setViewClearE7uint8_t8uint16_t8uint32_tf7uint8_t">
|
||
<span id="bgfx::setViewClear__uint8_t.uint16_t.uint32_t.float.uint8_t"></span><span class="target" id="project0namespacebgfx_1aa1caf5f59c3505034c652d08e9b3e752"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewClear</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, uint16_t <em>_flags</em>, uint32_t <em>_rgba</em>, float <em>_depth</em>, uint8_t <em>_stencil</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setViewClearE7uint8_t8uint16_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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>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>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_rgba</span></code> - <p>Color clear value. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>Depth clear value. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_stencil</span></code> - <p>Stencil clear value.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setViewClearE7uint8_t8uint16_tf7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t7uint8_t">
|
||
<span id="bgfx::setViewClear__uint8_t.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="project0namespacebgfx_1a0c9bfcccd7744ddade8c8cb40f688de5"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewClear</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, uint16_t <em>_flags</em>, float <em>_depth</em>, uint8_t <em>_stencil</em>, uint8_t <em>_0</em>, uint8_t <em>_1</em>, uint8_t <em>_2</em>, uint8_t <em>_3</em>, uint8_t <em>_4</em>, uint8_t <em>_5</em>, uint8_t <em>_6</em>, uint8_t <em>_7</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setViewClearE7uint8_t8uint16_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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>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>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>Depth clear value. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_stencil</span></code> - <p>Stencil clear value. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_0</span></code> - <p>Palette index for frame buffer attachment 0. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_1</span></code> - <p>Palette index for frame buffer attachment 1. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_2</span></code> - <p>Palette index for frame buffer attachment 2. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_3</span></code> - <p>Palette index for frame buffer attachment 3. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_4</span></code> - <p>Palette index for frame buffer attachment 4. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_5</span></code> - <p>Palette index for frame buffer attachment 5. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_6</span></code> - <p>Palette index for frame buffer attachment 6. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_7</span></code> - <p>Palette index for frame buffer attachment 7.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10setViewSeqE7uint8_tb">
|
||
<span id="bgfx::setViewSeq__uint8_t.b"></span><span class="target" id="project0namespacebgfx_1afa23fa7302046f7744bc1e27cca1c3b4"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewSeq</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, bool <em>_enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setViewSeqE7uint8_tb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set view into sequential mode. Draw calls will be sorted in the same order in which submit calls were called. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_set_view_seq</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx16setViewTransformE7uint8_tPKvPKv7uint8_tPKv">
|
||
<span id="bgfx::setViewTransform__uint8_t.voidCP.voidCP.uint8_t.voidCP"></span><span class="target" id="project0namespacebgfx_1a62647b80c0b15422a32a287ef04198b1"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewTransform</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, <em class="property">const</em> void *<em>_view</em>, <em class="property">const</em> void *<em>_projL</em>, uint8_t <em>_flags</em>, <em class="property">const</em> void *<em>_projR</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx16setViewTransformE7uint8_tPKvPKv7uint8_tPKv" 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 are <code class="docutils literal"><span class="pre">bgfx_set_view_transform</span></code>, <code class="docutils literal"><span class="pre">bgfx_set_view_transform_stereo</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_view</span></code> - <p>View matrix. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_projL</span></code> - <p>Projection matrix. When using stereo rendering this projection matrix represent projection matrix for left eye. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>View flags. Use<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_projR</span></code> - <p>Projection matrix for right eye in stereo mode.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx12setViewRemapE7uint8_t7uint8_tPKv">
|
||
<span id="bgfx::setViewRemap__uint8_t.uint8_t.voidCP"></span><span class="target" id="project0namespacebgfx_1aa38e5d04763c5473411055c7eb4c069c"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewRemap</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, uint8_t <em>_num</em>, <em class="property">const</em> void *<em>_remap</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx12setViewRemapE7uint8_t7uint8_tPKv" 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_remap</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>First view id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of views to remap. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_remap</span></code> - <p>View remap id table. Passing <code class="docutils literal"><span class="pre">NULL</span></code> will reset view ids to default state.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx18setViewFrameBufferE7uint8_t17FrameBufferHandle">
|
||
<span id="bgfx::setViewFrameBuffer__uint8_t.FrameBufferHandle"></span><span class="target" id="project0namespacebgfx_1ad7fba17d491dd60be65bed55ef95483c"></span>void <code class="descclassname">bgfx::</code><code class="descname">setViewFrameBuffer</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, FrameBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx18setViewFrameBufferE7uint8_t17FrameBufferHandle" 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="#project0namespacebgfx_1ab2506f91853a4c3bb0f25b581638291c"><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">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>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.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="draw">
|
||
<h2>Draw<a class="headerlink" href="#draw" title="Permalink to this headline">¶</a></h2>
|
||
<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="state">
|
||
<h3>State<a class="headerlink" href="#state" title="Permalink to this headline">¶</a></h3>
|
||
<div class="section" id="id1">
|
||
<h4>Debug<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setMarkerEPKc">
|
||
<span id="bgfx::setMarker__cCP"></span><span class="target" id="project0namespacebgfx_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>
|
||
|
||
</div>
|
||
<div class="section" id="id2">
|
||
<h4>State<a class="headerlink" href="#id2" 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="project0namespacebgfx_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><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>Use <code class="docutils literal"><span class="pre">BGFX_STATE_ALPHA_REF</span></code>, <code class="docutils literal"><span class="pre">BGFX_STATE_POINT_SIZE</span></code> and <code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_FUNC</span></code> macros to setup more complex states.</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">
|
||
<li><code class="first docutils literal"><span class="pre">_state</span></code> - <p>State flags. Default state for primitive type is triangles. See: <code class="docutils literal"><span class="pre">BGFX_STATE_DEFAULT</span></code>.<ul class="simple">
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_ALPHA_WRITE</span></code> - Enable alpha write.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_DEPTH_WRITE</span></code> - Enable depth write.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_DEPTH_TEST_*</span></code> - Depth test function.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_*</span></code> - See remark 1 about BGFX_STATE_BLEND_FUNC.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_BLEND_EQUATION_*</span></code> - See remark 2.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_CULL_*</span></code> - Backface culling mode.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_RGB_WRITE</span></code> - Enable RGB write.</li>
|
||
<li><code class="docutils literal"><span class="pre">BGFX_STATE_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>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_rgba</span></code> - <p>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.</p>
|
||
</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>
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_RGB_WRITE">
|
||
<span class="target" id="project0bgfxdefines_8h_1aff0cc52a35c2c01f874bb283a6103f03"></span><code class="descname">BGFX_STATE_RGB_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_RGB_WRITE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable RGB write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_ALPHA_WRITE">
|
||
<span class="target" id="project0bgfxdefines_8h_1aa6611f657f8f1b311dfc466b79c9290e"></span><code class="descname">BGFX_STATE_ALPHA_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_ALPHA_WRITE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable alpha write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEPTH_WRITE">
|
||
<span class="target" id="project0bgfxdefines_8h_1acf5681b2e7477ac01186cc535ea59213"></span><code class="descname">BGFX_STATE_DEPTH_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_WRITE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Enable depth write. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="macro">
|
||
<dt id="c.BGFX_STATE_DEFAULT">
|
||
<span class="target" id="project0bgfxdefines_8h_1a7f87ba52187999ca674a61ccc27170db"></span><code class="descname">BGFX_STATE_DEFAULT</code><a class="headerlink" href="#c.BGFX_STATE_DEFAULT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default state is write to RGB, alpha, and depth with depth test less enabled, with clockwise culling and MSAA (when writing into MSAA frame buffer, otherwise this flag is ignored). </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="project0namespacebgfx_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><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">
|
||
<li><code class="first docutils literal"><span class="pre">_fstencil</span></code> - <p>Front stencil state. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_bstencil</span></code> - <p>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.</p>
|
||
</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="project0bgfxdefines_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="project0namespacebgfx_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="#project0namespacebgfx_1a3d1b68d9678d716e25795aa3eef2bfe1"><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">
|
||
<li><code class="first docutils literal"><span class="pre">_x</span></code> - <p>Position x from the left corner of the window. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_y</span></code> - <p>Position y from the top corner of the window. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of scissor region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of scissor region. </p>
|
||
</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="project0namespacebgfx_1a2cad724d5941acf0719c007792fcde3e"></span>void <code class="descclassname">bgfx::</code><code class="descname">setScissor</code><span class="sig-paren">(</span>uint16_t <em>_cache</em><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">
|
||
<li><code class="first docutils literal"><span class="pre">_cache</span></code> - <p>Index in scissor cache. Passing UINT16_MAX unset primitive scissor and primitive will use view scissor instead.</p>
|
||
</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="project0namespacebgfx_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. Pointer returned can be modifed until <code class="docutils literal"><a class="reference internal" href="#project0namespacebgfx_1afdc2d817c439383ffffdc0a7610e2fa1"><span><span class="pre">bgfx::frame</span></span></a></code> is called. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>index into matrix cache.</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">
|
||
<li><code class="first docutils literal"><span class="pre">_transform</span></code> - <p>Pointer to <code class="docutils literal"><span class="pre">Transform</span></code> structure. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of matrices. </p>
|
||
</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="project0namespacebgfx_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><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 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_set_transform</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_mtx</span></code> - <p>Pointer to first matrix in array. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of matrices in array. </p>
|
||
</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="project0namespacebgfx_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><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">
|
||
<li><code class="first docutils literal"><span class="pre">_cache</span></code> - <p>Index in matrix cache. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of matrices from cache.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="buffers">
|
||
<h3>Buffers<a class="headerlink" href="#buffers" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferE17IndexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setIndexBuffer__IndexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1adce84edbab8794d9979476ccecc797aa"></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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Index buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_firstIndex</span></code> - <p>First index to render. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numIndices</span></code> - <p>Number of indices to render.</p>
|
||
</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="project0namespacebgfx_1ad5aa3d6a895bb2963df4d04426584543"></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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic index buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_firstIndex</span></code> - <p>First index to render. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numIndices</span></code> - <p>Number of indices to render.</p>
|
||
</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="project0namespacebgfx_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">
|
||
<li><code class="first docutils literal"><span class="pre">_tib</span></code> - <p>Transient index buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_firstIndex</span></code> - <p>First index to render. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numIndices</span></code> - <p>Number of indices to render.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14setIndexBufferEPK20TransientIndexBuffer">
|
||
<span id="bgfx::setIndexBuffer__TransientIndexBufferCP"></span><span class="target" id="project0namespacebgfx_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">
|
||
<li><code class="first docutils literal"><span class="pre">_tib</span></code> - <p>Transient index buffer.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle">
|
||
<span id="bgfx::setVertexBuffer__VertexBufferHandle"></span><span class="target" id="project0namespacebgfx_1a641a1e05d472617461413faf67b3705f"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle" 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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Vertex buffer.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle8uint32_t8uint32_t">
|
||
<span id="bgfx::setVertexBuffer__VertexBufferHandle.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1a099832dfa79aad96a624588f67119b9d"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE18VertexBufferHandle8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Vertex buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_startVertex</span></code> - <p>First vertex to render. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numVertices</span></code> - <p>Number of vertices to render.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_t">
|
||
<span id="bgfx::setVertexBuffer__DynamicVertexBufferHandle.uint32_t"></span><span class="target" id="project0namespacebgfx_1a8f0fd5ff0b80aa3f4ffcedad7b39130a"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_numVertices</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferE25DynamicVertexBufferHandle8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic vertex buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numVertices</span></code> - <p>Number of vertices to render.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer">
|
||
<span id="bgfx::setVertexBuffer__TransientVertexBufferCP"></span><span class="target" id="project0namespacebgfx_1a90a4a1acbd8447e3cf1f148876b36802"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span><em class="property">const</em> TransientVertexBuffer *<em>_tvb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer" 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">
|
||
<li><code class="first docutils literal"><span class="pre">_tvb</span></code> - <p>Transient vertex buffer.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer8uint32_t8uint32_t">
|
||
<span id="bgfx::setVertexBuffer__TransientVertexBufferCP.uint32_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1ae99a5f6863b3cc9a2c0fdb4c9b28ca48"></span>void <code class="descclassname">bgfx::</code><code class="descname">setVertexBuffer</code><span class="sig-paren">(</span><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="#_CPPv2N4bgfx15setVertexBufferEPK21TransientVertexBuffer8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_tvb</span></code> - <p>Transient vertex buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_startVertex</span></code> - <p>First vertex to render. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numVertices</span></code> - <p>Number of vertices to render.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_t">
|
||
<span id="bgfx::setInstanceDataBuffer__InstanceDataBufferCP.uint32_t"></span><span class="target" id="project0namespacebgfx_1a81b11930fa83a0616e8e1ab9d7af982a"></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>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21setInstanceDataBufferEPK18InstanceDataBuffer8uint32_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>
|
||
</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="project0namespacebgfx_1a659331644300a320dbbd5ac9f69a5949"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</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>
|
||
</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="project0namespacebgfx_1ab9d044f4cbfd0d8272507f2fe65b050e"></span>void <code class="descclassname">bgfx::</code><code class="descname">setInstanceDataBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em>, uint32_t <em>_startVertex</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>
|
||
</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="function">
|
||
<dt id="_CPPv2N4bgfx10setTextureE7uint8_t13UniformHandle13TextureHandle8uint32_t">
|
||
<span id="bgfx::setTexture__uint8_t.UniformHandle.TextureHandle.uint32_t"></span><span class="target" id="project0namespacebgfx_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><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">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Texture unit. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_sampler</span></code> - <p>Program sampler. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Texture sampling mode. Default value UINT32_MAX uses texture sampling settings from the texture.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Texture sampler filtering flags. UINT32_MAX use the sampler filtering mode set by texture.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10setTextureE7uint8_t13UniformHandle17FrameBufferHandle7uint8_t8uint32_t">
|
||
<span id="bgfx::setTexture__uint8_t.UniformHandle.FrameBufferHandle.uint8_t.uint32_t"></span><span class="target" id="project0namespacebgfx_1a95af3e2cb424a4eed41bd038ba93825a"></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>, FrameBufferHandle <em>_handle</em>, uint8_t <em>_attachment</em>, uint32_t <em>_flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx10setTextureE7uint8_t13UniformHandle17FrameBufferHandle7uint8_t8uint32_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_from_frame_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Texture unit. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_sampler</span></code> - <p>Program sampler. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Frame buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_attachment</span></code> - <p>Frame buffer attachment index. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Texture sampling mode. Default value UINT32_MAX uses texture sampling settings from the texture.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="submit">
|
||
<h3>Submit<a class="headerlink" href="#submit" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle7int32_t">
|
||
<span id="bgfx::submit__uint8_t.ProgramHandle.int32_t"></span><span class="target" id="project0namespacebgfx_1a10799bca819bfc884724ae4add65238e"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">submit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_handle</em>, int32_t <em>_depth</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle7int32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Submit primitive for rendering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Number of draw calls.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_submit</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Program. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>Depth for sorting. </p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7int32_t">
|
||
<span id="bgfx::submit__uint8_t.ProgramHandle.IndirectBufferHandle.uint16_t.uint16_t.int32_t"></span><span class="target" id="project0namespacebgfx_1a9599b8855e45ceaa035fee1313b638a3"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">submit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_handle</em>, IndirectBufferHandle <em>_indirectHandle</em>, uint16_t <em>_start</em>, uint16_t <em>_num</em>, int32_t <em>_depth</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx6submitE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7int32_t" 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_submit_indirect</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Program. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_indirectHandle</span></code> - <p>Indirect buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_start</span></code> - <p>First element in indirect buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of dispatches. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>Depth for sorting.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="compute">
|
||
<h2>Compute<a class="headerlink" href="#compute" title="Permalink to this headline">¶</a></h2>
|
||
<p>Compute state is not preserved between two compute dispatches. All state is cleared after calling
|
||
<cite>bgfx::dispatch</cite>.</p>
|
||
<div class="section" id="id3">
|
||
<h3>Buffers<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx9setBufferE7uint8_t17IndexBufferHandleN6Access4EnumE">
|
||
<span id="bgfx::setBuffer__uint8_t.IndexBufferHandle.Access::Enum"></span><span class="target" id="project0namespacebgfx_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>, Access::Enum <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">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Compute stage. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Index buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Buffer access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>.</p>
|
||
</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="project0namespacebgfx_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>, Access::Enum <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">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Compute stage. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Vertex buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Buffer access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>.</p>
|
||
</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="project0namespacebgfx_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>, Access::Enum <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">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Compute stage. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic index buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Buffer access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>.</p>
|
||
</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="project0namespacebgfx_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>, Access::Enum <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">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Compute stage. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic vertex buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Buffer access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>.</p>
|
||
</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="project0namespacebgfx_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>, Access::Enum <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">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Compute stage. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Indirect buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Buffer access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="images">
|
||
<h3>Images<a class="headerlink" href="#images" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8setImageE7uint8_t13UniformHandle13TextureHandle7uint8_tN6Access4EnumEN13TextureFormat4EnumE">
|
||
<span id="bgfx::setImage__uint8_t.UniformHandle.TextureHandle.uint8_t.Access::Enum.TextureFormat::Enum"></span><span class="target" id="project0namespacebgfx_1ad8db33907881ef115e47ef9702c25f4d"></span>void <code class="descclassname">bgfx::</code><code class="descname">setImage</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, UniformHandle <em>_sampler</em>, TextureHandle <em>_handle</em>, uint8_t <em>_mip</em>, Access::Enum <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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8setImageE7uint8_t13UniformHandle13TextureHandle7uint8_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">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Texture unit. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_sampler</span></code> - <p>Program sampler. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mip</span></code> - <p>Mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Texture access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8setImageE7uint8_t13UniformHandle17FrameBufferHandle7uint8_tN6Access4EnumEN13TextureFormat4EnumE">
|
||
<span id="bgfx::setImage__uint8_t.UniformHandle.FrameBufferHandle.uint8_t.Access::Enum.TextureFormat::Enum"></span><span class="target" id="project0namespacebgfx_1a66009acaf4cddffc483e7192367914db"></span>void <code class="descclassname">bgfx::</code><code class="descname">setImage</code><span class="sig-paren">(</span>uint8_t <em>_stage</em>, UniformHandle <em>_sampler</em>, FrameBufferHandle <em>_handle</em>, uint8_t <em>_attachment</em>, Access::Enum <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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8setImageE7uint8_t13UniformHandle17FrameBufferHandle7uint8_tN6Access4EnumEN13TextureFormat4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Set compute image from frame buffer 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_from_frame_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_stage</span></code> - <p>Texture unit. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_sampler</span></code> - <p>Program sampler. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Frame buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_attachment</span></code> - <p>Frame buffer attachment index. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_access</span></code> - <p>Texture access. See <code class="docutils literal"><span class="pre">Access::Enum</span></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="dispatch">
|
||
<h3>Dispatch<a class="headerlink" href="#dispatch" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8dispatchE7uint8_t13ProgramHandle8uint16_t8uint16_t8uint16_t7uint8_t">
|
||
<span id="bgfx::dispatch__uint8_t.ProgramHandle.uint16_t.uint16_t.uint16_t.uint8_t"></span><span class="target" id="project0namespacebgfx_1af287a9fbfdee622ed186b020cfc8b269"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">dispatch</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_handle</em>, uint16_t <em>_numX</em>, uint16_t <em>_numY</em>, uint16_t <em>_numZ</em>, uint8_t <em>_flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8dispatchE7uint8_t13ProgramHandle8uint16_t8uint16_t8uint16_t7uint8_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_dispatch</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Compute program. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numX</span></code> - <p>Number of groups X. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numY</span></code> - <p>Number of groups Y. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numZ</span></code> - <p>Number of groups Z. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>View flags. Use<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx8dispatchE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7uint8_t">
|
||
<span id="bgfx::dispatch__uint8_t.ProgramHandle.IndirectBufferHandle.uint16_t.uint16_t.uint8_t"></span><span class="target" id="project0namespacebgfx_1ad5cf95158eedbf8f164cb67a87e06c75"></span>uint32_t <code class="descclassname">bgfx::</code><code class="descname">dispatch</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, ProgramHandle <em>_handle</em>, IndirectBufferHandle <em>_indirectHandle</em>, uint16_t <em>_start</em>, uint16_t <em>_num</em>, uint8_t <em>_flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx8dispatchE7uint8_t13ProgramHandle20IndirectBufferHandle8uint16_t8uint16_t7uint8_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_dispatch_indirect</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Compute program. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_indirectHandle</span></code> - <p>Indirect buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_start</span></code> - <p>First element in indirect buffer. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of dispatches. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>View flags. Use<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="blit">
|
||
<h2>Blit<a class="headerlink" href="#blit" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4blitE7uint8_t13TextureHandle8uint16_t8uint16_t13TextureHandle8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::blit__uint8_t.TextureHandle.uint16_t.uint16_t.TextureHandle.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="project0namespacebgfx_1a0ced752657573f20fd4fb3006b6287c8"></span>void <code class="descclassname">bgfx::</code><code class="descname">blit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, TextureHandle <em>_dst</em>, uint16_t <em>_dstX</em>, uint16_t <em>_dstY</em>, TextureHandle <em>_src</em>, uint16_t <em>_srcX</em>, uint16_t <em>_srcY</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4blitE7uint8_t13TextureHandle8uint16_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><p class="first">Destination texture must be create with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </p>
|
||
<p>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_blit</span></code>. </p>
|
||
</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dst</span></code> - <p>Destination texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstX</span></code> - <p>Destination texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstY</span></code> - <p>Destination texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_src</span></code> - <p>Source texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcX</span></code> - <p>Source texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcY</span></code> - <p>Source texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of region.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4blitE7uint8_t13TextureHandle8uint16_t8uint16_t17FrameBufferHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::blit__uint8_t.TextureHandle.uint16_t.uint16_t.FrameBufferHandle.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="project0namespacebgfx_1aacf82edb73efb1fcb751f47a013e0999"></span>void <code class="descclassname">bgfx::</code><code class="descname">blit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, TextureHandle <em>_dst</em>, uint16_t <em>_dstX</em>, uint16_t <em>_dstY</em>, FrameBufferHandle <em>_src</em>, uint8_t <em>_attachment</em>, uint16_t <em>_srcX</em>, uint16_t <em>_srcY</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4blitE7uint8_t13TextureHandle8uint16_t8uint16_t17FrameBufferHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blit texture 2D region between 2D frame buffer and 2D texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd><p class="first">Destination texture must be create with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </p>
|
||
<p>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_blit</span></code>. </p>
|
||
</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dst</span></code> - <p>Destination texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstX</span></code> - <p>Destination texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstY</span></code> - <p>Destination texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_src</span></code> - <p>Source frame buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_attachment</span></code> - <p>Source frame buffer attachment index. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcX</span></code> - <p>Source texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcY</span></code> - <p>Source texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of region.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4blitE7uint8_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::blit__uint8_t.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="project0namespacebgfx_1aa14664b2fd3aafb69138fe6ccfe3ca1f"></span>void <code class="descclassname">bgfx::</code><code class="descname">blit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, TextureHandle <em>_dst</em>, 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>, uint16_t <em>_srcX</em>, uint16_t <em>_srcY</em>, uint16_t <em>_srcZ</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint16_t <em>_depth</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4blitE7uint8_t13TextureHandle7uint8_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><p class="first">Destination texture must be create with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </p>
|
||
<p>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_blit</span></code>. </p>
|
||
</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dst</span></code> - <p>Destination texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstMip</span></code> - <p>Destination texture mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstX</span></code> - <p>Destination texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstY</span></code> - <p>Destination texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstZ</span></code> - <p>If texture is 2D this argument should be 0. If destination texture is cube this argument represent destination texture cube face. For 3D texture this argument represent destination texture Z position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_src</span></code> - <p>Source texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcMip</span></code> - <p>Source texture mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcX</span></code> - <p>Source texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcY</span></code> - <p>Source texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcZ</span></code> - <p>If texture is 2D this argument should be 0. If source texture is cube this argument represent source texture cube face. For 3D texture this argument represent source texture Z position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>If texture is 3D this argument represent depth of region, otherwise is unused.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4blitE7uint8_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t17FrameBufferHandle7uint8_t7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t">
|
||
<span id="bgfx::blit__uint8_t.TextureHandle.uint8_t.uint16_t.uint16_t.uint16_t.FrameBufferHandle.uint8_t.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t.uint16_t"></span><span class="target" id="project0namespacebgfx_1a5ac694ecc0ee68d3fcf50a078e4ccf2d"></span>void <code class="descclassname">bgfx::</code><code class="descname">blit</code><span class="sig-paren">(</span>uint8_t <em>_id</em>, TextureHandle <em>_dst</em>, uint8_t <em>_dstMip</em>, uint16_t <em>_dstX</em>, uint16_t <em>_dstY</em>, uint16_t <em>_dstZ</em>, FrameBufferHandle <em>_src</em>, uint8_t <em>_attachment</em>, uint8_t <em>_srcMip</em>, uint16_t <em>_srcX</em>, uint16_t <em>_srcY</em>, uint16_t <em>_srcZ</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint16_t <em>_depth</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx4blitE7uint8_t13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t17FrameBufferHandle7uint8_t7uint8_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Blit texture region between frame buffer and texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd><p class="first">Destination texture must be create with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_BLIT_DST</span></code> flag. </p>
|
||
<p>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_BLIT</span></code>. </p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_blit</span></code>. </p>
|
||
</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_id</span></code> - <p>View id. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dst</span></code> - <p>Destination texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstMip</span></code> - <p>Destination texture mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstX</span></code> - <p>Destination texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstY</span></code> - <p>Destination texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_dstZ</span></code> - <p>If texture is 2D this argument should be 0. If destination texture is cube this argument represent destination texture cube face. For 3D texture this argument represent destination texture Z position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_src</span></code> - <p>Source frame buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_attachment</span></code> - <p>Source frame buffer attachment index. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcMip</span></code> - <p>Source texture mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcX</span></code> - <p>Source texture X position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcY</span></code> - <p>Source texture Y position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_srcZ</span></code> - <p>If texture is 2D this argument should be 0. If source texture is cube this argument represent source texture cube face. For 3D texture this argument represent source texture Z position. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of region. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>If texture is 3D this argument represent depth of region, otherwise is unused.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</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="project0structbgfx_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="#project0structbgfx_1_1_memory"><span>Memory</span></a> obtained by calling <code class="docutils literal"><a class="reference internal" href="#project0namespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code>, <code class="docutils literal"><a class="reference internal" href="#project0namespacebgfx_1abef77615b85f71391e7eda16f24dc5b7"><span><span class="pre">bgfx::copy</span></span></a></code>, or <code class="docutils literal"><a class="reference internal" href="#project0namespacebgfx_1a8dc7bf9f26afcc6f61dc602dfed09044"><span><span class="pre">bgfx::makeRef</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_memory_t</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx5allocE8uint32_t">
|
||
<span id="bgfx::alloc__uint32_t"></span><span class="target" id="project0namespacebgfx_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>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx4copyEPKv8uint32_t">
|
||
<span id="bgfx::copy__voidCP.uint32_t"></span><span class="target" id="project0namespacebgfx_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>
|
||
</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="project0namespacebgfx_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>, void *<em>_userData</em><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="#project0namespacebgfx_1aef1ce8b4b2523171deb7a0dd48cafe38"><span><span class="pre">bgfx::alloc</span></span></a></code> this call doesn’t allocate memory for data. It just copies pointer to data. You can pass <code class="docutils literal"><span class="pre">ReleaseFn</span></code> function pointer to release this memory after it’s consumed, or you must make sure data is available for at least 2 <code class="docutils literal"><a class="reference internal" href="#project0namespacebgfx_1afdc2d817c439383ffffdc0a7610e2fa1"><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 called from any thread. </p>
|
||
<p><dl class="docutils">
|
||
<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>
|
||
</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="project0namespacebgfx_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="project0namespacebgfx_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>, uint16_t <em>_max</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17getShaderUniformsE12ShaderHandleP13UniformHandle8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns num of uniforms, and uniform handles used inside 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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Shader handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_uniforms</span></code> - <p>UniformHandle array where data will be stored. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_max</span></code> - <p>Maximum capacity of array. </p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13destroyShaderE12ShaderHandle">
|
||
<span id="bgfx::destroyShader__ShaderHandle"></span><span class="target" id="project0namespacebgfx_1ac36f39b0ae8cadbb4dfd2f9219561196"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyShader</code><span class="sig-paren">(</span>ShaderHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13destroyShaderE12ShaderHandle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destroy shader. Once program is created with shader it is safe to destroy 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>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13createProgramE12ShaderHandle12ShaderHandleb">
|
||
<span id="bgfx::createProgram__ShaderHandle.ShaderHandle.b"></span><span class="target" id="project0namespacebgfx_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><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">
|
||
<li><code class="first docutils literal"><span class="pre">_vsh</span></code> - <p>Vertex shader. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_fsh</span></code> - <p>Fragment shader. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_destroyShaders</span></code> - <p>If true, shaders will be destroyed when program is destroyed. </p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13createProgramE12ShaderHandleb">
|
||
<span id="bgfx::createProgram__ShaderHandle.b"></span><span class="target" id="project0namespacebgfx_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><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">
|
||
<li><code class="first docutils literal"><span class="pre">_csh</span></code> - <p>Compute shader. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_destroyShader</span></code> - <p>If true, shader will be destroyed when program is destroyed. </p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14destroyProgramE13ProgramHandle">
|
||
<span id="bgfx::destroyProgram__ProgramHandle"></span><span class="target" id="project0namespacebgfx_1aebae6a593fbc016c512cffd01ae48d5b"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyProgram</code><span class="sig-paren">(</span>ProgramHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14destroyProgramE13ProgramHandle" 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>
|
||
</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="project0namespacebgfx_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><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>Predefined uniforms (declared in <code class="docutils literal"><span class="pre">bgfx_shader.sh</span></code>):<ul class="simple">
|
||
<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.</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>
|
||
</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">
|
||
<li><code class="first docutils literal"><span class="pre">_name</span></code> - <p>Uniform name in shader. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_type</span></code> - <p>Type of uniform (See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_uniform_type"><span><span class="pre">bgfx::UniformType</span></span></a></code>). </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of elements in array.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14destroyUniformE13UniformHandle">
|
||
<span id="bgfx::destroyUniform__UniformHandle"></span><span class="target" id="project0namespacebgfx_1a55c0d21cc00b4d7f8a05879e2114d37b"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyUniform</code><span class="sig-paren">(</span>UniformHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14destroyUniformE13UniformHandle" 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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Handle to uniform object.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx11UniformTypeE">
|
||
<span id="bgfx::UniformType"></span><span class="target" id="project0structbgfx_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="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Int1E">
|
||
<span id="bgfx::UniformType::Int1"></span><span class="target" id="project0structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79a173664bed3eef9991e511cb9815f4522"></span><code class="descname">Int1</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Int1E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformType3EndE">
|
||
<span id="bgfx::UniformType::End"></span><span class="target" id="project0structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79af032fc38d9876bbc4f4609116ced94c9"></span><code class="descname">End</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType3EndE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Vec4E">
|
||
<span id="bgfx::UniformType::Vec4"></span><span class="target" id="project0structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79ad3a487a974362da30ed861d5e60134dd"></span><code class="descname">Vec4</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Vec4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Mat3E">
|
||
<span id="bgfx::UniformType::Mat3"></span><span class="target" id="project0structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79a4912934f4e16efd08a14a396fed267f2"></span><code class="descname">Mat3</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Mat3E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformType4Mat4E">
|
||
<span id="bgfx::UniformType::Mat4"></span><span class="target" id="project0structbgfx_1_1_uniform_type_1a50bf3685e07ddb0cbcf34b4a2e134c79ac875f375dfc3adf73780a4114c6cc851"></span><code class="descname">Mat4</code><a class="headerlink" href="#_CPPv2N4bgfx11UniformType4Mat4E" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx11UniformType5CountE">
|
||
<span id="bgfx::UniformType::Count"></span><span class="target" id="project0structbgfx_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>
|
||
|
||
</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="project0namespacebgfx_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><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">
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Vertex buffer data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex declaration. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Buffer creation flags.<ul class="simple">
|
||
<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 different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit 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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx19destroyVertexBufferE18VertexBufferHandle">
|
||
<span id="bgfx::destroyVertexBuffer__VertexBufferHandle"></span><span class="target" id="project0namespacebgfx_1a3444a0530f0f0f7c620a0d2f28c545eb"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyVertexBuffer</code><span class="sig-paren">(</span>VertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx19destroyVertexBufferE18VertexBufferHandle" 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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Static vertex buffer handle.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx10VertexDeclE">
|
||
<span id="bgfx::VertexDecl"></span><span class="target" id="project0structbgfx_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="project0structbgfx_1_1_vertex_decl_1a0d711e9b9451ee68d20acddc7ae824bc"></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><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="#project0structbgfx_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="project0structbgfx_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="#project0structbgfx_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="_CPPv2N4bgfx10VertexDecl3addEN6Attrib4EnumE7uint8_tN10AttribType4EnumEbb">
|
||
<span id="bgfx::VertexDecl::add__Attrib::Enum.uint8_t.AttribType::Enum.b.b"></span><span class="target" id="project0structbgfx_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>, AttribType::Enum <em>_type</em>, bool <em>_normalized</em>, bool <em>_asInt</em><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="#project0structbgfx_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">
|
||
<li><code class="first docutils literal"><span class="pre">_attrib</span></code> - <p>Attribute semantics. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_attrib"><span><span class="pre">bgfx::Attrib</span></span></a></code> </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of elements 1, 2, 3 or 4. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_type</span></code> - <p>Element type. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_normalized</span></code> - <p>When using fixed point AttribType (f.e. Uint8) value will be normalized for vertex shader usage. When normalized is set to true, AttribType::Uint8 value in range 0-255 will be in range 0.0-1.0 in vertex shader. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_asInt</span></code> - <p>Packaging rule for vertexPack, vertexUnpack, and vertexConvert for AttribType::Uint8 and AttribType::Int16. Unpacking code must be implemented inside vertex shader.</p>
|
||
</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="project0structbgfx_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="_CPPv2N4bgfx10VertexDecl6decodeEN6Attrib4EnumER7uint8_tRN10AttribType4EnumERbRb">
|
||
<span id="bgfx::VertexDecl::decode__Attrib::Enum.uint8_tR.AttribType::EnumR.bR.bR"></span><span class="target" id="project0structbgfx_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>, AttribType::Enum &<em>_type</em>, bool &<em>_normalized</em>, bool &<em>_asInt</em><span class="sig-paren">)</span> const<a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl6decodeEN6Attrib4EnumER7uint8_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 ``. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl3hasEN6Attrib4EnumE">
|
||
<span id="bgfx::VertexDecl::has__Attrib::Enum"></span><span class="target" id="project0structbgfx_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> const<a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl3hasEN6Attrib4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns true if <a class="reference internal" href="#project0structbgfx_1_1_vertex_decl"><span>VertexDecl</span></a> contains attribute. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl9getOffsetEN6Attrib4EnumE">
|
||
<span id="bgfx::VertexDecl::getOffset__Attrib::Enum"></span><span class="target" id="project0structbgfx_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> const<a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl9getOffsetEN6Attrib4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns relative attribute offset from the vertex. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl9getStrideEv">
|
||
<span id="bgfx::VertexDecl::getStride"></span><span class="target" id="project0structbgfx_1_1_vertex_decl_1aea33232b36e3f3930823baff54c57083"></span>uint16_t <code class="descname">getStride</code><span class="sig-paren">(</span><span class="sig-paren">)</span> const<a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl9getStrideEv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns vertex stride. </p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx10VertexDecl7getSizeE8uint32_t">
|
||
<span id="bgfx::VertexDecl::getSize__uint32_t"></span><span class="target" id="project0structbgfx_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> const<a class="headerlink" href="#_CPPv2N4bgfx10VertexDecl7getSizeE8uint32_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="project0structbgfx_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="project0structbgfx_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. Attributes: </p>
|
||
<p><em>Values:</em></p>
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib8PositionE">
|
||
<span id="bgfx::Attrib::Position"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib6NormalE">
|
||
<span id="bgfx::Attrib::Normal"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib7TangentE">
|
||
<span id="bgfx::Attrib::Tangent"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9BitangentE">
|
||
<span id="bgfx::Attrib::Bitangent"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib6Color0E">
|
||
<span id="bgfx::Attrib::Color0"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib6Color1E">
|
||
<span id="bgfx::Attrib::Color1"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib7IndicesE">
|
||
<span id="bgfx::Attrib::Indices"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib6WeightE">
|
||
<span id="bgfx::Attrib::Weight"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord0E">
|
||
<span id="bgfx::Attrib::TexCoord0"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord1E">
|
||
<span id="bgfx::Attrib::TexCoord1"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord2E">
|
||
<span id="bgfx::Attrib::TexCoord2"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord3E">
|
||
<span id="bgfx::Attrib::TexCoord3"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord4E">
|
||
<span id="bgfx::Attrib::TexCoord4"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord5E">
|
||
<span id="bgfx::Attrib::TexCoord5"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord6E">
|
||
<span id="bgfx::Attrib::TexCoord6"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib9TexCoord7E">
|
||
<span id="bgfx::Attrib::TexCoord7"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx6Attrib5CountE">
|
||
<span id="bgfx::Attrib::Count"></span><span class="target" id="project0structbgfx_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="function">
|
||
<dt id="_CPPv2N4bgfx25createDynamicVertexBufferE8uint32_tRK10VertexDecl8uint16_t">
|
||
<span id="bgfx::createDynamicVertexBuffer__uint32_t.VertexDeclCR.uint16_t"></span><span class="target" id="project0namespacebgfx_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><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>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">
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of vertices. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex declaration. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Buffer creation flags.<ul class="simple">
|
||
<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 different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit 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>
|
||
</p>
|
||
</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="project0namespacebgfx_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><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>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">
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Vertex buffer data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex declaration. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Buffer creation flags.<ul class="simple">
|
||
<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 different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit 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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx25updateDynamicVertexBufferE25DynamicVertexBufferHandle8uint32_tPK6Memory">
|
||
<span id="bgfx::updateDynamicVertexBuffer__DynamicVertexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="project0namespacebgfx_1a392233c9c36e33a902ccacea28c83299"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateDynamicVertexBuffer</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="#_CPPv2N4bgfx25updateDynamicVertexBufferE25DynamicVertexBufferHandle8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic vertex buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_startVertex</span></code> - <p>Start vertex. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Vertex buffer data.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx26destroyDynamicVertexBufferE25DynamicVertexBufferHandle">
|
||
<span id="bgfx::destroyDynamicVertexBuffer__DynamicVertexBufferHandle"></span><span class="target" id="project0namespacebgfx_1a21c1edd9c6c7e2e877579c067169252a"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyDynamicVertexBuffer</code><span class="sig-paren">(</span>DynamicVertexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx26destroyDynamicVertexBufferE25DynamicVertexBufferHandle" 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>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx31checkAvailTransientVertexBufferE8uint32_tRK10VertexDecl">
|
||
<span id="bgfx::checkAvailTransientVertexBuffer__uint32_t.VertexDeclCR"></span><span class="target" id="project0namespacebgfx_1a868cc4f683f9f16e6c3108cfed15ede9"></span>bool <code class="descclassname">bgfx::</code><code class="descname">checkAvailTransientVertexBuffer</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="#_CPPv2N4bgfx31checkAvailTransientVertexBufferE8uint32_tRK10VertexDecl" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns true if internal transient vertex buffer has enough space. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_check_avail_transient_vertex_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of vertices. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex declaration.</p>
|
||
</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="project0namespacebgfx_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>Remark</strong></dt>
|
||
<dd>You must call setVertexBuffer after alloc in order to avoid memory leak.</dd>
|
||
<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">
|
||
<li><code class="first docutils literal"><span class="pre">_tvb</span></code> - <p>TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of vertices to allocate. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_decl</span></code> - <p>Vertex declaration.</p>
|
||
</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="project0namespacebgfx_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><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">
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Index buffer data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Buffer creation flags.<ul class="simple">
|
||
<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 different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit 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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx18destroyIndexBufferE17IndexBufferHandle">
|
||
<span id="bgfx::destroyIndexBuffer__IndexBufferHandle"></span><span class="target" id="project0namespacebgfx_1ac9cc26d628a53a75c54098be95c91008"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyIndexBuffer</code><span class="sig-paren">(</span>IndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx18destroyIndexBufferE17IndexBufferHandle" 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>
|
||
</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="project0namespacebgfx_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><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>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">
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of indices. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Buffer creation flags.<ul class="simple">
|
||
<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 different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit 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>
|
||
</p>
|
||
</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="project0namespacebgfx_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><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>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">
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Index buffer data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Buffer creation flags.<ul class="simple">
|
||
<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 different amount of data is passed. If this flag is not specified if more data is passed on update buffer will be trimmed to fit 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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx24updateDynamicIndexBufferE24DynamicIndexBufferHandle8uint32_tPK6Memory">
|
||
<span id="bgfx::updateDynamicIndexBuffer__DynamicIndexBufferHandle.uint32_t.MemoryCP"></span><span class="target" id="project0namespacebgfx_1a94bc9d8f473817a271846bc17e321d11"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateDynamicIndexBuffer</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="#_CPPv2N4bgfx24updateDynamicIndexBufferE24DynamicIndexBufferHandle8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic index buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_startIndex</span></code> - <p>Start index. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Index buffer data.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx25destroyDynamicIndexBufferE24DynamicIndexBufferHandle">
|
||
<span id="bgfx::destroyDynamicIndexBuffer__DynamicIndexBufferHandle"></span><span class="target" id="project0namespacebgfx_1a3eafa9fd7f732e27f84edab6e96c42ab"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyDynamicIndexBuffer</code><span class="sig-paren">(</span>DynamicIndexBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx25destroyDynamicIndexBufferE24DynamicIndexBufferHandle" 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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Dynamic index buffer handle.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx30checkAvailTransientIndexBufferE8uint32_t">
|
||
<span id="bgfx::checkAvailTransientIndexBuffer__uint32_t"></span><span class="target" id="project0namespacebgfx_1a911a3c697fd9f340278419b3387034e2"></span>bool <code class="descclassname">bgfx::</code><code class="descname">checkAvailTransientIndexBuffer</code><span class="sig-paren">(</span>uint32_t <em>_num</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx30checkAvailTransientIndexBufferE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns true if internal transient index buffer has enough space. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_check_avail_transient_index_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of indices.</p>
|
||
</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="project0namespacebgfx_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><ol class="arabic simple">
|
||
<li>You must call setIndexBuffer after alloc in order to avoid memory leak.</li>
|
||
<li>Only 16-bit index buffer is supported.</li>
|
||
</ol>
|
||
</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">
|
||
<li><code class="first docutils literal"><span class="pre">_tib</span></code> - <p>TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of indices to allocate.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="id4">
|
||
<h3>Textures<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
|
||
<dl class="class">
|
||
<dt id="_CPPv2N4bgfx13TextureFormatE">
|
||
<span id="bgfx::TextureFormat"></span><span class="target" id="project0structbgfx_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><p class="first">Availability depends on <a class="reference internal" href="#project0structbgfx_1_1_caps"><span>Caps</span></a> (see: formats).</p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_texture_format_t</span></code>. </p>
|
||
</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="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC1E">
|
||
<span id="bgfx::TextureFormat::BC1"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC2E">
|
||
<span id="bgfx::TextureFormat::BC2"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC3E">
|
||
<span id="bgfx::TextureFormat::BC3"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC4E">
|
||
<span id="bgfx::TextureFormat::BC4"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC5E">
|
||
<span id="bgfx::TextureFormat::BC5"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4BC6HE">
|
||
<span id="bgfx::TextureFormat::BC6H"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3BC7E">
|
||
<span id="bgfx::TextureFormat::BC7"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4ETC1E">
|
||
<span id="bgfx::TextureFormat::ETC1"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4ETC2E">
|
||
<span id="bgfx::TextureFormat::ETC2"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5ETC2AE">
|
||
<span id="bgfx::TextureFormat::ETC2A"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6ETC2A1E">
|
||
<span id="bgfx::TextureFormat::ETC2A1"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC12E">
|
||
<span id="bgfx::TextureFormat::PTC12"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC14E">
|
||
<span id="bgfx::TextureFormat::PTC14"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6PTC12AE">
|
||
<span id="bgfx::TextureFormat::PTC12A"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6PTC14AE">
|
||
<span id="bgfx::TextureFormat::PTC14A"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC22E">
|
||
<span id="bgfx::TextureFormat::PTC22"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5PTC24E">
|
||
<span id="bgfx::TextureFormat::PTC24"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7UnknownE">
|
||
<span id="bgfx::TextureFormat::Unknown"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat2R1E">
|
||
<span id="bgfx::TextureFormat::R1"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat2A8E">
|
||
<span id="bgfx::TextureFormat::A8"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat2R8E">
|
||
<span id="bgfx::TextureFormat::R8"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R8IE">
|
||
<span id="bgfx::TextureFormat::R8I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R8UE">
|
||
<span id="bgfx::TextureFormat::R8U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R8SE">
|
||
<span id="bgfx::TextureFormat::R8S"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3R16E">
|
||
<span id="bgfx::TextureFormat::R16"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16IE">
|
||
<span id="bgfx::TextureFormat::R16I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16UE">
|
||
<span id="bgfx::TextureFormat::R16U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16FE">
|
||
<span id="bgfx::TextureFormat::R16F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R16SE">
|
||
<span id="bgfx::TextureFormat::R16S"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R32IE">
|
||
<span id="bgfx::TextureFormat::R32I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R32UE">
|
||
<span id="bgfx::TextureFormat::R32U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4R32FE">
|
||
<span id="bgfx::TextureFormat::R32F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3RG8E">
|
||
<span id="bgfx::TextureFormat::RG8"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG8IE">
|
||
<span id="bgfx::TextureFormat::RG8I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG8UE">
|
||
<span id="bgfx::TextureFormat::RG8U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG8SE">
|
||
<span id="bgfx::TextureFormat::RG8S"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4RG16E">
|
||
<span id="bgfx::TextureFormat::RG16"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16IE">
|
||
<span id="bgfx::TextureFormat::RG16I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16UE">
|
||
<span id="bgfx::TextureFormat::RG16U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16FE">
|
||
<span id="bgfx::TextureFormat::RG16F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG16SE">
|
||
<span id="bgfx::TextureFormat::RG16S"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG32IE">
|
||
<span id="bgfx::TextureFormat::RG32I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG32UE">
|
||
<span id="bgfx::TextureFormat::RG32U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RG32FE">
|
||
<span id="bgfx::TextureFormat::RG32F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGB9E5FE">
|
||
<span id="bgfx::TextureFormat::RGB9E5F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5BGRA8E">
|
||
<span id="bgfx::TextureFormat::BGRA8"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RGBA8E">
|
||
<span id="bgfx::TextureFormat::RGBA8"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA8IE">
|
||
<span id="bgfx::TextureFormat::RGBA8I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA8UE">
|
||
<span id="bgfx::TextureFormat::RGBA8U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA8SE">
|
||
<span id="bgfx::TextureFormat::RGBA8S"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGBA16E">
|
||
<span id="bgfx::TextureFormat::RGBA16"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16IE">
|
||
<span id="bgfx::TextureFormat::RGBA16I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16UE">
|
||
<span id="bgfx::TextureFormat::RGBA16U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16FE">
|
||
<span id="bgfx::TextureFormat::RGBA16F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA16SE">
|
||
<span id="bgfx::TextureFormat::RGBA16S"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA32IE">
|
||
<span id="bgfx::TextureFormat::RGBA32I"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA32UE">
|
||
<span id="bgfx::TextureFormat::RGBA32U"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGBA32FE">
|
||
<span id="bgfx::TextureFormat::RGBA32F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6R5G6B5E">
|
||
<span id="bgfx::TextureFormat::R5G6B5"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5RGBA4E">
|
||
<span id="bgfx::TextureFormat::RGBA4"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat6RGB5A1E">
|
||
<span id="bgfx::TextureFormat::RGB5A1"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat7RGB10A2E">
|
||
<span id="bgfx::TextureFormat::RGB10A2"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat10R11G11B10FE">
|
||
<span id="bgfx::TextureFormat::R11G11B10F"></span><span class="target" id="project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6aadba44b102107a20a1d10e4225c7483e"></span><code class="descname">R11G11B10F</code><a class="headerlink" href="#_CPPv2N4bgfx13TextureFormat10R11G11B10FE" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat12UnknownDepthE">
|
||
<span id="bgfx::TextureFormat::UnknownDepth"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3D16E">
|
||
<span id="bgfx::TextureFormat::D16"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3D24E">
|
||
<span id="bgfx::TextureFormat::D24"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5D24S8E">
|
||
<span id="bgfx::TextureFormat::D24S8"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat3D32E">
|
||
<span id="bgfx::TextureFormat::D32"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D16FE">
|
||
<span id="bgfx::TextureFormat::D16F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D24FE">
|
||
<span id="bgfx::TextureFormat::D24F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D32FE">
|
||
<span id="bgfx::TextureFormat::D32F"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat4D0S8E">
|
||
<span id="bgfx::TextureFormat::D0S8"></span><span class="target" id="project0structbgfx_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="member">
|
||
<dt id="_CPPv2N4bgfx13TextureFormat5CountE">
|
||
<span id="bgfx::TextureFormat::Count"></span><span class="target" id="project0structbgfx_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="_CPPv2N4bgfx15calcTextureSizeER11TextureInfo8uint16_t8uint16_t8uint16_tb7uint8_tN13TextureFormat4EnumE">
|
||
<span id="bgfx::calcTextureSize__TextureInfoR.uint16_t.uint16_t.uint16_t.b.uint8_t.TextureFormat::Enum"></span><span class="target" id="project0namespacebgfx_1ab76d05a11b3698b0bd14a6c264e5b71d"></span>void <code class="descclassname">bgfx::</code><code class="descname">calcTextureSize</code><span class="sig-paren">(</span>TextureInfo &<em>_info</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, uint16_t <em>_depth</em>, bool <em>_cubeMap</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15calcTextureSizeER11TextureInfo8uint16_t8uint16_t8uint16_tb7uint8_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>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx13createTextureEPK6Memory8uint32_t7uint8_tP11TextureInfo">
|
||
<span id="bgfx::createTexture__MemoryCP.uint32_t.uint8_t.TextureInfoP"></span><span class="target" id="project0namespacebgfx_1aaa1bf4d4e000f393bc47f543cef7d6b4"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv2N4bgfx6MemoryE" title="bgfx::Memory">Memory</a> *<em>_mem</em>, uint32_t <em>_flags</em>, uint8_t <em>_skip</em>, TextureInfo *<em>_info</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx13createTextureEPK6Memory8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>DDS, KTX or PVR texture data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_skip</span></code> - <p>Skip top level mips when parsing texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_info</span></code> - <p>When non-<code class="docutils literal"><span class="pre">NULL</span></code> is specified it returns parsed texture information. </p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15createTexture2DE8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_tPK6Memory">
|
||
<span id="bgfx::createTexture2D__uint16_t.uint16_t.uint8_t.TextureFormat::Enum.uint32_t.MemoryCP"></span><span class="target" id="project0namespacebgfx_1ac642640d2b73902d4b6c16f896e78a4c"></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>, 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>, <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="#_CPPv2N4bgfx15createTexture2DE8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_tPK6Memory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create 2D texture. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_texture_2d</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numMips</span></code> - <p>Number of mip-maps. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Texture data. If <code class="docutils literal"><span class="pre">_mem</span></code> is non-NULL, created texture will be immutable.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15createTexture2DEN15BackbufferRatio4EnumE7uint8_tN13TextureFormat4EnumE8uint32_t">
|
||
<span id="bgfx::createTexture2D__BackbufferRatio::Enum.uint8_t.TextureFormat::Enum.uint32_t"></span><span class="target" id="project0namespacebgfx_1a5599540d0f695ba0404eea73973cd639"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTexture2D</code><span class="sig-paren">(</span>BackbufferRatio::Enum <em>_ratio</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15createTexture2DEN15BackbufferRatio4EnumE7uint8_tN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create frame buffer with size based on backbuffer ratio. Frame buffer will maintain ratio if back buffer resolution changes. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_texture_2d_scaled</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_ratio</span></code> - <p>Frame buffer size in respect to back-buffer size. See: <code class="docutils literal"><span class="pre">BackbufferRatio::Enum</span></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numMips</span></code> - <p>Number of mip-maps. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15updateTexture2DE13TextureHandle7uint8_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory8uint16_t">
|
||
<span id="bgfx::updateTexture2D__TextureHandle.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.MemoryCP.uint16_t"></span><span class="target" id="project0namespacebgfx_1aabc817205de683b55c2a4ecb3c6e2bd1"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateTexture2D</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>_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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx15updateTexture2DE13TextureHandle7uint8_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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mip</span></code> - <p>Mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_x</span></code> - <p>X offset in texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_y</span></code> - <p>Y offset in texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of texture block. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of texture block. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Texture update data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_pitch</span></code> - <p>Pitch of input image (bytes). When _pitch is set to UINT16_MAX, it will be calculated internally based on _width.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_tPK6Memory">
|
||
<span id="bgfx::createTexture3D__uint16_t.uint16_t.uint16_t.uint8_t.TextureFormat::Enum.uint32_t.MemoryCP"></span><span class="target" id="project0namespacebgfx_1afe302b53e800c5e5af34d4f6b942a8d1"></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>, 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>, <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="#_CPPv2N4bgfx15createTexture3DE8uint16_t8uint16_t8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>Depth. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numMips</span></code> - <p>Number of mip-maps. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Texture data. If <code class="docutils literal"><span class="pre">_mem</span></code> is non-NULL, created texture will be immutable.</p>
|
||
</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="project0namespacebgfx_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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mip</span></code> - <p>Mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_x</span></code> - <p>X offset in texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_y</span></code> - <p>Y offset in texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_z</span></code> - <p>Z offset in texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of texture block. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of texture block. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depth</span></code> - <p>Depth of texture block. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Texture update data.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17createTextureCubeE8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_tPK6Memory">
|
||
<span id="bgfx::createTextureCube__uint16_t.uint8_t.TextureFormat::Enum.uint32_t.MemoryCP"></span><span class="target" id="project0namespacebgfx_1a98f26a59b7e5d76dd041641fd3873c7b"></span>TextureHandle <code class="descclassname">bgfx::</code><code class="descname">createTextureCube</code><span class="sig-paren">(</span>uint16_t <em>_size</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>, <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="#_CPPv2N4bgfx17createTextureCubeE8uint16_t7uint8_tN13TextureFormat4EnumE8uint32_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">
|
||
<li><code class="first docutils literal"><span class="pre">_size</span></code> - <p>Cube side size. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_numMips</span></code> - <p>Number of mip-maps. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_flags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Texture data. If <code class="docutils literal"><span class="pre">_mem</span></code> is non-NULL, created texture will be immutable.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17updateTextureCubeE13TextureHandle7uint8_t7uint8_t8uint16_t8uint16_t8uint16_t8uint16_tPK6Memory8uint16_t">
|
||
<span id="bgfx::updateTextureCube__TextureHandle.uint8_t.uint8_t.uint16_t.uint16_t.uint16_t.uint16_t.MemoryCP.uint16_t"></span><span class="target" id="project0namespacebgfx_1a5d4813b813490f41cf4c1cded279014c"></span>void <code class="descclassname">bgfx::</code><code class="descname">updateTextureCube</code><span class="sig-paren">(</span>TextureHandle <em>_handle</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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17updateTextureCubeE13TextureHandle7uint8_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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_side</span></code> - <p>Cubemap side, 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 |
|
||
| | |
|
||
| +---->+x |
|
||
+----------+----------+----------+----------+
|
||
|+y 1|+y 4|+y 0|+y 5|
|
||
| ^ -x | ^ +z | ^ +x | ^ -z |
|
||
| | | | | | | | |
|
||
| +---->+z | +---->+x | +---->-z | +---->-x |
|
||
+----------+----------+----------+----------+
|
||
|+z 3|
|
||
| ^ -y |
|
||
| | |
|
||
| +---->+x |
|
||
+----------+
|
||
</pre></div>
|
||
</div>
|
||
</p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mip</span></code> - <p>Mip level. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_x</span></code> - <p>X offset in texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_y</span></code> - <p>Y offset in texture. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Width of texture block. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Height of texture block. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_mem</span></code> - <p>Texture update data. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_pitch</span></code> - <p>Pitch of input image (bytes). When _pitch is set to UINT16_MAX, it will be calculated internally based on _width.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11readTextureE13TextureHandlePv">
|
||
<span id="bgfx::readTexture__TextureHandle.voidP"></span><span class="target" id="project0namespacebgfx_1ac8de0663cbec720564e98e452fcb0ed2"></span>void <code class="descclassname">bgfx::</code><code class="descname">readTexture</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em>, void *<em>_data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11readTextureE13TextureHandlePv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read back texture content. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd><p class="first">Texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_READ_BACK</span></code> flag. </p>
|
||
<p>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_READ_BACK</span></code>. </p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_read_texture</span></code>. </p>
|
||
</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Destination buffer.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx11readTextureE17FrameBufferHandle7uint8_tPv">
|
||
<span id="bgfx::readTexture__FrameBufferHandle.uint8_t.voidP"></span><span class="target" id="project0namespacebgfx_1a3a6e449f0e2986a4a4c7f97ecb7e201f"></span>void <code class="descclassname">bgfx::</code><code class="descname">readTexture</code><span class="sig-paren">(</span>FrameBufferHandle <em>_handle</em>, uint8_t <em>_attachment</em>, void *<em>_data</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx11readTextureE17FrameBufferHandle7uint8_tPv" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read back texture content. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd><p class="first">Texture must be created with <code class="docutils literal"><span class="pre">BGFX_TEXTURE_READ_BACK</span></code> flag. </p>
|
||
<p>Availability depends on: <code class="docutils literal"><span class="pre">BGFX_CAPS_TEXTURE_READ_BACK</span></code>. </p>
|
||
<p class="last">C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_read_texture</span></code>. </p>
|
||
</dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Frame buffer handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_attachment</span></code> - <p>Frame buffer attachment index. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_data</span></code> - <p>Destination buffer.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx14destroyTextureE13TextureHandle">
|
||
<span id="bgfx::destroyTexture__TextureHandle"></span><span class="target" id="project0namespacebgfx_1a3cc8f5416512b46cedee40d444f1bc0e"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyTexture</code><span class="sig-paren">(</span>TextureHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx14destroyTextureE13TextureHandle" 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">
|
||
<li><code class="first docutils literal"><span class="pre">_handle</span></code> - <p>Texture handle.</p>
|
||
</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_tN13TextureFormat4EnumE8uint32_t">
|
||
<span id="bgfx::createFrameBuffer__uint16_t.uint16_t.TextureFormat::Enum.uint32_t"></span><span class="target" id="project0namespacebgfx_1a51e6723db7d8375e211b2ae5046634b5"></span>FrameBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createFrameBuffer</code><span class="sig-paren">(</span>uint16_t <em>_width</em>, uint16_t <em>_height</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_textureFlags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferE8uint16_t8uint16_tN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create frame buffer (simple). </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>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">
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Texture width. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Texture height. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_textureFlags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17createFrameBufferEN15BackbufferRatio4EnumEN13TextureFormat4EnumE8uint32_t">
|
||
<span id="bgfx::createFrameBuffer__BackbufferRatio::Enum.TextureFormat::Enum.uint32_t"></span><span class="target" id="project0namespacebgfx_1a721dad473bb58b7331864e95e6433c46"></span>FrameBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createFrameBuffer</code><span class="sig-paren">(</span>BackbufferRatio::Enum <em>_ratio</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_format</em>, uint32_t <em>_textureFlags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferEN15BackbufferRatio4EnumEN13TextureFormat4EnumE8uint32_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create frame buffer with size based on backbuffer ratio. Frame buffer will maintain ratio if back buffer resolution changes. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>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">
|
||
<li><code class="first docutils literal"><span class="pre">_ratio</span></code> - <p>Frame buffer size in respect to back-buffer size. See: <code class="docutils literal"><span class="pre">BackbufferRatio::Enum</span></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_format</span></code> - <p>Texture format. See: <code class="docutils literal"><a class="reference internal" href="#project0structbgfx_1_1_texture_format_1a4fa5bcce97c848cf091d954362e501e6"><span><span class="pre">TextureFormat::Enum</span></span></a></code>. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_textureFlags</span></code> - <p>Default texture sampling mode is linear, and wrap mode is repeat.<ul class="simple">
|
||
<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>
|
||
</p>
|
||
</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="project0namespacebgfx_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><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferE7uint8_tPK13TextureHandleb" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create frame buffer. </p>
|
||
<p><dl class="docutils">
|
||
<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">
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of texture attachments. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_handles</span></code> - <p>Texture attachments. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_destroyTextures</span></code> - <p>If true, textures will be destroyed when frame buffer is destroyed.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx17createFrameBufferEPv8uint16_t8uint16_tN13TextureFormat4EnumE">
|
||
<span id="bgfx::createFrameBuffer__voidP.uint16_t.uint16_t.TextureFormat::Enum"></span><span class="target" id="project0namespacebgfx_1acb6883cf9094d49e7f1767f9e4b8a8b8"></span>FrameBufferHandle <code class="descclassname">bgfx::</code><code class="descname">createFrameBuffer</code><span class="sig-paren">(</span>void *<em>_nwh</em>, uint16_t <em>_width</em>, uint16_t <em>_height</em>, <a class="reference internal" href="#_CPPv2N4bgfx13TextureFormatE" title="bgfx::TextureFormat">TextureFormat</a>::<a class="reference internal" href="#_CPPv2N4bgfx13TextureFormat4EnumE" title="bgfx::TextureFormat::Enum">Enum</a> <em>_depthFormat</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx17createFrameBufferEPv8uint16_t8uint16_tN13TextureFormat4EnumE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create frame buffer for multiple window rendering. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Return</strong></dt>
|
||
<dd>Handle to frame buffer object.</dd>
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>Frame buffer cannnot 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">
|
||
<li><code class="first docutils literal"><span class="pre">_nwh</span></code> - <p>OS’ target native window handle. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_width</span></code> - <p>Window back buffer width. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_height</span></code> - <p>Window back buffer height. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_depthFormat</span></code> - <p>Window back buffer depth format.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx18destroyFrameBufferE17FrameBufferHandle">
|
||
<span id="bgfx::destroyFrameBuffer__FrameBufferHandle"></span><span class="target" id="project0namespacebgfx_1a17b93a8b3a39ae31081bcdde3f971674"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyFrameBuffer</code><span class="sig-paren">(</span>FrameBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx18destroyFrameBufferE17FrameBufferHandle" 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>
|
||
</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="_CPPv2N4bgfx28checkAvailInstanceDataBufferE8uint32_t8uint16_t">
|
||
<span id="bgfx::checkAvailInstanceDataBuffer__uint32_t.uint16_t"></span><span class="target" id="project0namespacebgfx_1a38f2fee92a6561565993968a371d990f"></span>bool <code class="descclassname">bgfx::</code><code class="descname">checkAvailInstanceDataBuffer</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="#_CPPv2N4bgfx28checkAvailInstanceDataBufferE8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns true if internal instance data buffer has enough space. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_check_avail_instance_data_buffer</span></code>. </dd>
|
||
<dt><strong>Parameters</strong></dt>
|
||
<dd><ul class="breatheparameterlist first last">
|
||
<li><code class="first docutils literal"><span class="pre">_num</span></code> - <p>Number of instances. </p>
|
||
</li>
|
||
<li><code class="first docutils literal"><span class="pre">_stride</span></code> - <p>Stride per instance.</p>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx23allocInstanceDataBufferE8uint32_t8uint16_t">
|
||
<span id="bgfx::allocInstanceDataBuffer__uint32_t.uint16_t"></span><span class="target" id="project0namespacebgfx_1a61a8b2b96c02f6d2d447fbce2b9e6896"></span><em class="property">const</em> InstanceDataBuffer *<code class="descclassname">bgfx::</code><code class="descname">allocInstanceDataBuffer</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="#_CPPv2N4bgfx23allocInstanceDataBufferE8uint32_t8uint16_t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Allocate instance data buffer. </p>
|
||
<p><dl class="docutils">
|
||
<dt><strong>Remark</strong></dt>
|
||
<dd>You must call setInstanceDataBuffer after alloc in order to avoid memory leak.</dd>
|
||
<dt><strong>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_alloc_instance_data_buffer</span></code>. </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="project0namespacebgfx_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>Attention</strong></dt>
|
||
<dd>C99 equivalent is <code class="docutils literal"><span class="pre">bgfx_create_indirect_buffer</span></code>. </dd>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="_CPPv2N4bgfx21destroyIndirectBufferE20IndirectBufferHandle">
|
||
<span id="bgfx::destroyIndirectBuffer__IndirectBufferHandle"></span><span class="target" id="project0namespacebgfx_1ad32cac7107eeffd862221b9bd0922110"></span>void <code class="descclassname">bgfx::</code><code class="descname">destroyIndirectBuffer</code><span class="sig-paren">(</span>IndirectBufferHandle <em>_handle</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv2N4bgfx21destroyIndirectBufferE20IndirectBufferHandle" 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>
|
||
</dl>
|
||
</p>
|
||
</dd></dl>
|
||
|
||
</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 2015, 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> |