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

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić
2016-12-11 22:11:50 -08:00
parent 025ca46726
commit 1bcd3d3dfe
3 changed files with 55 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
bgfx.html
View File

@@ -238,31 +238,31 @@
<dl class="macro">
<dt id="c.BGFX_PCI_ID_NONE">
<span class="target" id="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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>
@@ -516,103 +516,103 @@
<dl class="macro">
<dt id="c.BGFX_RESET_NONE">
<span class="target" id="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_8h_1a74813007bb4401a669842d101bc5da25"></span><code class="descname">BGFX_RESET_SRGB_BACKBUFFER</code><a class="headerlink" href="#c.BGFX_RESET_SRGB_BACKBUFFER" title="Permalink to this definition"></a></dt>
<dd><p>Enable sRGB backbuffer. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_RESET_HIDPI">
<span class="target" id="bgfxbgfxdefines_8h_1a8d31334677672b6a92ea3a17110194fa"></span><code class="descname">BGFX_RESET_HIDPI</code><a class="headerlink" href="#c.BGFX_RESET_HIDPI" title="Permalink to this definition"></a></dt>
<span class="target" id="bgfxdefines_8h_1a8d31334677672b6a92ea3a17110194fa"></span><code class="descname">BGFX_RESET_HIDPI</code><a class="headerlink" href="#c.BGFX_RESET_HIDPI" title="Permalink to this definition"></a></dt>
<dd><p>Enable HiDPI rendering. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_RESET_DEPTH_CLAMP">
<span class="target" id="bgfxbgfxdefines_8h_1af06b6eb7e824929310fd5fb2b2a5e7c4"></span><code class="descname">BGFX_RESET_DEPTH_CLAMP</code><a class="headerlink" href="#c.BGFX_RESET_DEPTH_CLAMP" title="Permalink to this definition"></a></dt>
<span class="target" id="bgfxdefines_8h_1af06b6eb7e824929310fd5fb2b2a5e7c4"></span><code class="descname">BGFX_RESET_DEPTH_CLAMP</code><a class="headerlink" href="#c.BGFX_RESET_DEPTH_CLAMP" title="Permalink to this definition"></a></dt>
<dd><p>Enable depth clamp. </p>
</dd></dl>
@@ -672,31 +672,31 @@
<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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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>
@@ -1136,109 +1136,109 @@
<h5>Available Caps<a class="headerlink" href="#available-caps" title="Permalink to this headline"></a></h5>
<dl class="macro">
<dt id="c.BGFX_CAPS_TEXTURE_COMPARE_LEQUAL">
<span class="target" id="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_8h_1a917840ff950077d8f5964028e5854b42"></span><code class="descname">BGFX_CAPS_HIDPI</code><a class="headerlink" href="#c.BGFX_CAPS_HIDPI" title="Permalink to this definition"></a></dt>
<dd><p>HiDPI rendering is supported. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_CAPS_TEXTURE_BLIT">
<span class="target" id="bgfxbgfxdefines_8h_1a7ddb9c7ef30ca6c8b68b686b5122123f"></span><code class="descname">BGFX_CAPS_TEXTURE_BLIT</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_BLIT" title="Permalink to this definition"></a></dt>
<span class="target" id="bgfxdefines_8h_1a7ddb9c7ef30ca6c8b68b686b5122123f"></span><code class="descname">BGFX_CAPS_TEXTURE_BLIT</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_BLIT" title="Permalink to this definition"></a></dt>
<dd><p>Texture blit is supported. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_CAPS_TEXTURE_READ_BACK">
<span class="target" id="bgfxbgfxdefines_8h_1ac2cd9bdd84fdce3e55b3054413094f0d"></span><code class="descname">BGFX_CAPS_TEXTURE_READ_BACK</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_READ_BACK" title="Permalink to this definition"></a></dt>
<span class="target" id="bgfxdefines_8h_1ac2cd9bdd84fdce3e55b3054413094f0d"></span><code class="descname">BGFX_CAPS_TEXTURE_READ_BACK</code><a class="headerlink" href="#c.BGFX_CAPS_TEXTURE_READ_BACK" title="Permalink to this definition"></a></dt>
<dd><p>Read-back texture is supported. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_CAPS_OCCLUSION_QUERY">
<span class="target" id="bgfxbgfxdefines_8h_1a35626a97a17fc3e2f3b712a8221c38bf"></span><code class="descname">BGFX_CAPS_OCCLUSION_QUERY</code><a class="headerlink" href="#c.BGFX_CAPS_OCCLUSION_QUERY" title="Permalink to this definition"></a></dt>
<span class="target" id="bgfxdefines_8h_1a35626a97a17fc3e2f3b712a8221c38bf"></span><code class="descname">BGFX_CAPS_OCCLUSION_QUERY</code><a class="headerlink" href="#c.BGFX_CAPS_OCCLUSION_QUERY" title="Permalink to this definition"></a></dt>
<dd><p>Occlusion query is supported. </p>
</dd></dl>
@@ -1453,19 +1453,19 @@
<dl class="macro">
<dt id="c.BGFX_HMD_NONE">
<span class="target" id="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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>
@@ -2364,25 +2364,25 @@ In graphics debugger view name will appear as: <div class="highlight-default"><d
<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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_8h_1aff0cc52a35c2c01f874bb283a6103f03"></span><code class="descname">BGFX_STATE_RGB_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_RGB_WRITE" title="Permalink to this definition"></a></dt>
<dd><p>Enable RGB write. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_STATE_ALPHA_WRITE">
<span class="target" id="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_8h_1aa6611f657f8f1b311dfc466b79c9290e"></span><code class="descname">BGFX_STATE_ALPHA_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_ALPHA_WRITE" title="Permalink to this definition"></a></dt>
<dd><p>Enable alpha write. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_STATE_DEPTH_WRITE">
<span class="target" id="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_8h_1acf5681b2e7477ac01186cc535ea59213"></span><code class="descname">BGFX_STATE_DEPTH_WRITE</code><a class="headerlink" href="#c.BGFX_STATE_DEPTH_WRITE" title="Permalink to this definition"></a></dt>
<dd><p>Enable depth write. </p>
</dd></dl>
<dl class="macro">
<dt id="c.BGFX_STATE_DEFAULT">
<span class="target" id="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_8h_1a7f87ba52187999ca674a61ccc27170db"></span><code class="descname">BGFX_STATE_DEFAULT</code><a class="headerlink" href="#c.BGFX_STATE_DEFAULT" title="Permalink to this definition"></a></dt>
<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>
@@ -2413,7 +2413,7 @@ In graphics debugger view name will appear as: <div class="highlight-default"><d
<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="bgfxbgfxdefines_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>
<span class="target" id="bgfxdefines_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>
@@ -3395,7 +3395,7 @@ otherwise prefer <cite>bgfx::setViewScissor</cite>.</p>
<dd>Handle to uniform object.</dd>
<dt><strong>Remark</strong></dt>
<dd><ol class="arabic simple">
<li>Uniform names are unique. It&#8217;s valid to call <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a45614b96172b438fd644c858e2c434b2"><span class="std std-ref"><span class="pre">bgfx::createUniform</span></span></a></code> multiple times with the same uniform name. The library will always return the same handle, but the handle reference count will be incremented. This means that the same number of <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a55c0d21cc00b4d7f8a05879e2114d37b"><span class="std std-ref"><span class="pre">bgfx::destroyUniform</span></span></a></code> must be called to proprely destroy the uniform.</li>
<li>Uniform names are unique. It&#8217;s valid to call <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a45614b96172b438fd644c858e2c434b2"><span class="std std-ref"><span class="pre">bgfx::createUniform</span></span></a></code> multiple times with the same uniform name. The library will always return the same handle, but the handle reference count will be incremented. This means that the same number of <code class="docutils literal"><a class="reference internal" href="#bgfxnamespacebgfx_1a55c0d21cc00b4d7f8a05879e2114d37b"><span class="std std-ref"><span class="pre">bgfx::destroyUniform</span></span></a></code> must be called to properly destroy the uniform.</li>
<li>Predefined uniforms (declared in <code class="docutils literal"><span class="pre">bgfx_shader.sh</span></code>):<ul>
<li><code class="docutils literal"><span class="pre">u_viewRect</span> <span class="pre">vec4(x,</span> <span class="pre">y,</span> <span class="pre">width,</span> <span class="pre">height)</span></code> - view rectangle for current view.</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>

BIN
objects.inv
View File

Binary file not shown.

2
searchindex.js
View File

File diff suppressed because one or more lines are too long