bgfx - Documentation¶
bgfx is Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework” style rendering library.
https://github.com/bkaradzic/bgfx
General¶
Initialization¶
Warning
doxygenfunction: Cannot find function “bgfx::init” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::CallbackI” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::shutdown” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Updating¶
Warning
doxygenfunction: Cannot find function “bgfx::reset” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::frame” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Debug¶
Warning
doxygenfunction: Cannot find function “bgfx::setDebug” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::dbgTextClear” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::dbgTextPrintf” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Quering information¶
Warning
doxygenfunction: Cannot find function “bgfx::getRendererType” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::RendererType” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::getCaps” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::Caps” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::getStats” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::Stats” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::getHMD” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::HMD” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Platform specific¶
These are platform specific APIs. It is only necessary to use these APIs in conjunction with creating windows.
Warning
doxygenfunction: Cannot find function “bgfx::renderFrame” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::RenderFrame” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setPlatformData” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::PlatformData” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Miscelaneous¶
Warning
doxygenfunction: Cannot find function “bgfx::discard” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::touch” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setClearColor” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setClearColor” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setClearColor” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::saveScreenShot” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Views¶
Warning
doxygenfunction: Cannot find function “bgfx::setViewName” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewRect” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewScissor” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewClear” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewClear” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewSeq” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewTransform” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewRemap” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setViewFrameBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Draw¶
State¶
Warning
doxygenfunction: Cannot find function “bgfx::setMarker” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setState” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setStencil” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setScissor” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setScissor” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::allocTransform” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setTransform” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setTransform” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Buffers¶
Warning
doxygenfunction: Cannot find function “bgfx::setIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setInstanceDataBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setInstanceDataBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setInstanceDataBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Textures¶
Warning
doxygenfunction: Cannot find function “bgfx::setTexture” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setTexture” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Submit¶
Warning
doxygenfunction: Cannot find function “bgfx::submit” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::submit” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Compute¶
Buffers¶
Warning
doxygenfunction: Cannot find function “bgfx::setBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Images¶
Warning
doxygenfunction: Cannot find function “bgfx::setImage” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::setImage” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Dispatch¶
Warning
doxygenfunction: Cannot find function “bgfx::dispatch” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::dispatch” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Resources¶
Warning
doxygenfunction: Cannot find function “bgfx::alloc” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::copy” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::makeRef” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::Memory” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Frame buffers¶
Warning
doxygenfunction: Cannot find function “createFrameBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “createFrameBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “createFrameBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “destroyFrameBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Index Buffers¶
Warning
doxygenfunction: Cannot find function “bgfx::createIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createDynamicIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createDynamicIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::updateDynamicIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyDynamicIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::checkAvailTransientIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::allocTransientIndexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Vertex Buffers¶
Warning
doxygenfunction: Cannot find function “bgfx::createVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::VertexDecl” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::Attrib” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createDynamicVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createDynamicVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::updateDynamicVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyDynamicVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::checkAvailTransientVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::allocTransientVertexBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Instance Buffer¶
Warning
doxygenfunction: Cannot find function “bgfx::checkAvailInstanceDataBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::allocInstanceDataBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Indirect Buffer¶
Warning
doxygenfunction: Cannot find function “bgfx::createIndirectBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyIndirectBuffer” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Shaders and Programs¶
Warning
doxygenfunction: Cannot find function “bgfx::createShader” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::getShaderUniforms” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyShader” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createProgram” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createProgram” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyProgram” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Textures¶
Warning
doxygenfunction: Cannot find function “bgfx::calcTextureSize” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createTexture” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createTexture2D” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createTexture2D” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::updateTexture2D” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createTexture3D” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::updateTexture3D” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::createTextureCube” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::updateTextureCube” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyTexture” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Uniforms¶
Warning
doxygenfunction: Cannot find function “bgfx::createUniform” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenfunction: Cannot find function “bgfx::destroyUniform” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml
Warning
doxygenstruct: Cannot find class “bgfx::UniformType” in doxygen xml output for project “project0” from directory: ../../.build/docs/xml