mirrors
/
bgfx
mirror of https://github.com/bkaradzic/bgfx
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

This commit is contained in:
Branimir Karadžić 2015-07-26 17:38:06 -07:00
parent 3ad01ad715
commit 1ea01ee3d1
8 changed files with 684 additions and 478 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.buildinfo Normal file
View File

@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 269338f32a65412a8dc8205a026229eb
tags: 645f666f9bcd5a90fca523b33c5a78b7

114
_sources/bgfx.txt
View File

@ -1,4 +1,4 @@
bgfx - Documentation
bgfx - API Reference
====================
bgfx is Cross-platform, graphics API agnostic, "Bring Your Own Engine/Framework" style
@ -28,7 +28,30 @@ Initialization and Shutdown
Updating
~~~~~~~~
Reset
*****
.. doxygenfunction:: bgfx::reset
.. doxygendefine:: BGFX_RESET_NONE
.. doxygendefine:: BGFX_RESET_FULLSCREEN
.. doxygendefine:: BGFX_RESET_MSAA_X2
.. doxygendefine:: BGFX_RESET_MSAA_X4
.. doxygendefine:: BGFX_RESET_MSAA_X8
.. doxygendefine:: BGFX_RESET_MSAA_X16
.. doxygendefine:: BGFX_RESET_VSYNC
.. doxygendefine:: BGFX_RESET_MAXANISOTROPY
.. doxygendefine:: BGFX_RESET_CAPTURE
.. doxygendefine:: BGFX_RESET_HMD
.. doxygendefine:: BGFX_RESET_HMD_DEBUG
.. doxygendefine:: BGFX_RESET_HMD_RECENTER
.. doxygendefine:: BGFX_RESET_FLUSH_AFTER_RENDER
.. doxygendefine:: BGFX_RESET_FLIP_AFTER_RENDER
.. doxygendefine:: BGFX_RESET_SRGB_BACKBUFFER
Frame
*****
.. doxygenfunction:: bgfx::frame
Debug
@ -152,6 +175,9 @@ Views
Draw
----
Draw state is not preserved between two draw calls. All state is cleared after calling
`bgfx::submit`.
State
~~~~~
@ -233,6 +259,9 @@ Submit
Compute
-------
Compute state is not preserved between two compute dispatches. All state is cleared after calling
`bgfx::dispatch`.
Buffers
~~~~~~~
@ -264,27 +293,24 @@ Resources
.. doxygenstruct:: bgfx::Memory
:members:
Frame buffers
~~~~~~~~~~~~~
Shaders and Programs
~~~~~~~~~~~~~~~~~~~~
.. doxygenfunction:: createFrameBuffer(BackbufferRatio::Enum, TextureFormat::Enum, uint32_t)
.. doxygenfunction:: createFrameBuffer(uint8_t, TextureHandle *, bool)
.. doxygenfunction:: createFrameBuffer(void *, uint16_t, uint16_t, TextureFormat::Enum)
.. doxygenfunction:: destroyFrameBuffer
.. doxygenfunction:: bgfx::createShader
.. doxygenfunction:: bgfx::getShaderUniforms
.. doxygenfunction:: bgfx::destroyShader
.. doxygenfunction:: bgfx::createProgram(ShaderHandle, ShaderHandle, bool)
.. doxygenfunction:: bgfx::createProgram(ShaderHandle, bool)
.. doxygenfunction:: bgfx::destroyProgram
Uniforms
~~~~~~~~
Index Buffers
~~~~~~~~~~~~~
.. doxygenfunction:: bgfx::createUniform
.. doxygenfunction:: bgfx::destroyUniform
.. doxygenfunction:: bgfx::createIndexBuffer
.. doxygenfunction:: bgfx::destroyIndexBuffer
.. doxygenfunction:: bgfx::createDynamicIndexBuffer(uint32_t, uint16_t)
.. doxygenfunction:: bgfx::createDynamicIndexBuffer(const Memory *, uint16_t)
.. doxygenfunction:: bgfx::updateDynamicIndexBuffer(DynamicIndexBufferHandle, uint32_t, const Memory *)
.. doxygenfunction:: bgfx::destroyDynamicIndexBuffer(DynamicIndexBufferHandle)
.. doxygenfunction:: bgfx::checkAvailTransientIndexBuffer
.. doxygenfunction:: bgfx::allocTransientIndexBuffer
.. doxygenstruct:: bgfx::UniformType
:members:
Vertex Buffers
~~~~~~~~~~~~~~
@ -306,27 +332,18 @@ Vertex Buffers
.. doxygenfunction:: bgfx::checkAvailTransientVertexBuffer
.. doxygenfunction:: bgfx::allocTransientVertexBuffer
Instance Buffer
~~~~~~~~~~~~~~~
Index Buffers
~~~~~~~~~~~~~
.. doxygenfunction:: bgfx::checkAvailInstanceDataBuffer
.. doxygenfunction:: bgfx::allocInstanceDataBuffer
.. doxygenfunction:: bgfx::createIndexBuffer
.. doxygenfunction:: bgfx::destroyIndexBuffer
.. doxygenfunction:: bgfx::createDynamicIndexBuffer(uint32_t, uint16_t)
.. doxygenfunction:: bgfx::createDynamicIndexBuffer(const Memory *, uint16_t)
.. doxygenfunction:: bgfx::updateDynamicIndexBuffer(DynamicIndexBufferHandle, uint32_t, const Memory *)
.. doxygenfunction:: bgfx::destroyDynamicIndexBuffer(DynamicIndexBufferHandle)
Indirect Buffer
~~~~~~~~~~~~~~~
.. doxygenfunction:: bgfx::createIndirectBuffer
.. doxygenfunction:: bgfx::destroyIndirectBuffer
Shaders and Programs
~~~~~~~~~~~~~~~~~~~~
.. doxygenfunction:: bgfx::createShader
.. doxygenfunction:: bgfx::getShaderUniforms
.. doxygenfunction:: bgfx::destroyShader
.. doxygenfunction:: bgfx::createProgram(ShaderHandle, ShaderHandle, bool)
.. doxygenfunction:: bgfx::createProgram(ShaderHandle, bool)
.. doxygenfunction:: bgfx::destroyProgram
.. doxygenfunction:: bgfx::checkAvailTransientIndexBuffer
.. doxygenfunction:: bgfx::allocTransientIndexBuffer
Textures
~~~~~~~~
@ -342,11 +359,22 @@ Textures
.. doxygenfunction:: bgfx::updateTextureCube
.. doxygenfunction:: bgfx::destroyTexture
Uniforms
~~~~~~~~
Frame Buffers
~~~~~~~~~~~~~
.. doxygenfunction:: bgfx::createUniform
.. doxygenfunction:: bgfx::destroyUniform
.. doxygenfunction:: createFrameBuffer(BackbufferRatio::Enum, TextureFormat::Enum, uint32_t)
.. doxygenfunction:: createFrameBuffer(uint8_t, TextureHandle *, bool)
.. doxygenfunction:: createFrameBuffer(void *, uint16_t, uint16_t, TextureFormat::Enum)
.. doxygenfunction:: destroyFrameBuffer
.. doxygenstruct:: bgfx::UniformType
:members:
Instance Buffer
~~~~~~~~~~~~~~~
.. doxygenfunction:: bgfx::checkAvailInstanceDataBuffer
.. doxygenfunction:: bgfx::allocInstanceDataBuffer
Indirect Buffer
~~~~~~~~~~~~~~~
.. doxygenfunction:: bgfx::createIndirectBuffer
.. doxygenfunction:: bgfx::destroyIndirectBuffer

905
bgfx.html
View File

File diff suppressed because it is too large Load Diff

83
genindex.html
View File

@ -71,10 +71,14 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - Documentation</a><ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#reset">Reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#frame">Frame</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#debug">Debug</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-features">Debug Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-flags">Debug Flags</a></li>
@ -116,14 +120,14 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#resources">Resources</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#vertex-buffers">Vertex Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#instance-buffer">Instance Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#indirect-buffer">Indirect Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
</ul>
</li>
</ul>
@ -569,8 +573,6 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx6MemoryE">bgfx::Memory (C++ class)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx12PlatformDataE">bgfx::PlatformData (C++ class)</a>
</dt>
@ -603,6 +605,8 @@
<dt><a href="bgfx.html#_CPPv2N4bgfx12RendererType5CountE">bgfx::RendererType::Count (C++ class)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="bgfx.html#_CPPv2N4bgfx12RendererType10Direct3D11E">bgfx::RendererType::Direct3D11 (C++ class)</a>
</dt>
@ -948,6 +952,66 @@
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_CAPTURE">BGFX_RESET_CAPTURE (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_FLIP_AFTER_RENDER">BGFX_RESET_FLIP_AFTER_RENDER (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_FLUSH_AFTER_RENDER">BGFX_RESET_FLUSH_AFTER_RENDER (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_FULLSCREEN">BGFX_RESET_FULLSCREEN (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_HMD">BGFX_RESET_HMD (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_HMD_DEBUG">BGFX_RESET_HMD_DEBUG (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_HMD_RECENTER">BGFX_RESET_HMD_RECENTER (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_MAXANISOTROPY">BGFX_RESET_MAXANISOTROPY (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_MSAA_X16">BGFX_RESET_MSAA_X16 (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_MSAA_X2">BGFX_RESET_MSAA_X2 (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_MSAA_X4">BGFX_RESET_MSAA_X4 (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_MSAA_X8">BGFX_RESET_MSAA_X8 (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_NONE">BGFX_RESET_NONE (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_SRGB_BACKBUFFER">BGFX_RESET_SRGB_BACKBUFFER (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_RESET_VSYNC">BGFX_RESET_VSYNC (C macro)</a>
</dt>
<dt><a href="bgfx.html#c.BGFX_STATE_ALPHA_WRITE">BGFX_STATE_ALPHA_WRITE (C macro)</a>
</dt>
@ -983,7 +1047,6 @@
&copy; Copyright 2015, Branimir Karadžić.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

35
index.html
View File

@ -31,7 +31,7 @@
<link rel="top" title="bgfx 1.0 documentation" href="#"/>
<link rel="next" title="bgfx - Documentation" href="bgfx.html"/>
<link rel="next" title="bgfx - API Reference" href="bgfx.html"/>
<script src="_static/js/modernizr.min.js"></script>
@ -71,10 +71,14 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - Documentation</a><ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#reset">Reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#frame">Frame</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#debug">Debug</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-features">Debug Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-flags">Debug Flags</a></li>
@ -116,14 +120,14 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#resources">Resources</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#vertex-buffers">Vertex Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#instance-buffer">Instance Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#indirect-buffer">Indirect Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
</ul>
</li>
</ul>
@ -171,7 +175,7 @@ rendering library.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - Documentation</a><ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a></li>
@ -196,14 +200,14 @@ rendering library.</p>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#resources">Resources</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#vertex-buffers">Vertex Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#instance-buffer">Instance Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#indirect-buffer">Indirect Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
</ul>
</li>
</ul>
@ -218,7 +222,7 @@ rendering library.</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="bgfx.html" class="btn btn-neutral float-right" title="bgfx - Documentation" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="bgfx.html" class="btn btn-neutral float-right" title="bgfx - API Reference" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
@ -231,7 +235,6 @@ rendering library.</p>
&copy; Copyright 2015, Branimir Karadžić.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

BIN
objects.inv
View File

Binary file not shown.

19
search.html
View File

@ -70,10 +70,14 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - Documentation</a><ul>
<li class="toctree-l1"><a class="reference internal" href="bgfx.html">bgfx - API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#general">General</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#initialization-and-shutdown">Initialization and Shutdown</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#updating">Updating</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#reset">Reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#frame">Frame</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#debug">Debug</a><ul>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-features">Debug Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="bgfx.html#debug-flags">Debug Flags</a></li>
@ -115,14 +119,14 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bgfx.html#resources">Resources</a><ul>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#vertex-buffers">Vertex Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#index-buffers">Index Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#frame-buffers">Frame Buffers</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#instance-buffer">Instance Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#indirect-buffer">Indirect Buffer</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#shaders-and-programs">Shaders and Programs</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#id4">Textures</a></li>
<li class="toctree-l3"><a class="reference internal" href="bgfx.html#uniforms">Uniforms</a></li>
</ul>
</li>
</ul>
@ -185,7 +189,6 @@
&copy; Copyright 2015, Branimir Karadžić.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>

2
searchindex.js
View File

File diff suppressed because one or more lines are too long