Documentation

Cross-platform, graphics API agnostic, “Bring Your Own Engine/Framework” style rendering library, licensed under permissive BSD-2 clause open source license.

Source at GitHub:

• https://github.com/bkaradzic/bgfx

Contents

• Overview
  • What is it?
    • Supported rendering backends
    • Supported Platforms
    • Supported Compilers
    • Supported Languages
    • Project Page
    • Contact
  • Debugging and Profiling
    • RenderDoc
  • SDL, GLFW, etc.
  • Getting Involved
    • Contributors
    • Repository visualization
• Building
  • Dependencies & Getting the source
  • Quick Start for Windows
  • Prerequisites
    • Android
    • Linux
    • Windows
  • Build
    • General (Makefile wrapper)
    • General (Directly with GENie)
    • Windows
    • macOS
    • Linux
    • WinRT / UWP
  • Amalgamated Build
  • Tools
  • Alternative build systems
  • Minimal example without bgfx’s example harness
• Examples
  • 00-helloworld
  • 01-cubes
  • 02-metaballs
  • 03-raymarch
  • 04-mesh
  • 05-instancing
  • 06-bump
  • 07-callback
  • 08-update
  • 09-hdr
  • 10-font
  • 11-fontsdf
  • 12-lod
  • 13-stencil
  • 14-shadowvolumes
  • 15-shadowmaps-simple
  • 16-shadowmaps
  • 17-drawstress
    • 60Hz
    • 30Hz (test for browsers)
  • 18-ibl
  • 19-oit
  • 20-nanovg
  • 21-deferred
  • 22-windows
  • 23-vectordisplay
  • 24-nbody
  • 25-c99
  • 26-occlusion
  • 27-terrain
  • 28-wireframe
  • 29-debugdraw
  • 30-picking
  • 31-rsm
  • 32-particles
  • 33-pom
  • 34-mvs
  • 35-dynamic
  • 36-sky
  • 37-gpudrivenrendering
  • 38-bloom
  • 39-assao
  • 40-svt
  • 41-tess
  • 42-bunnylod
  • 43-denoise
  • 44-sss
  • 45-bokeh
  • 46-fsr
  • 47-pixelformats
  • 48-drawindirect
  • 49-hextile
• API Reference
  • General
    • Initialization and Shutdown
    • Updating
    • Debug
    • Querying information
    • Platform specific
    • Miscellaneous
  • Views
    • setViewName()
    • setViewRect()
    • setViewRect()
    • setViewScissor()
    • setViewClear()
    • setViewClear()
    • ViewMode
    • setViewMode()
    • setViewFrameBuffer()
    • setViewTransform()
    • setViewOrder()
    • resetView()
  • Encoder
    • Encoder
    • Draw
    • Compute
    • Blit
  • Resources
    • Memory
    • alloc()
    • copy()
    • makeRef()
    • Shaders and Programs
    • Uniforms
    • Vertex Buffers
    • Index Buffers
    • Textures
    • Frame Buffers
    • Instance Buffer
    • Indirect Buffer
    • Occlusion Query
• Tools
  • Geometry Compiler (geometryc)
  • Geometry Viewer (geometryv)
  • Shader Compiler (shaderc)
    • Defines
    • Predefined Uniforms
    • Vertex Shader Attributes
    • Options
    • Building shaders
  • Texture Compiler (texturec)
  • Texture Viewer (texturev)
• Internals
  • Sort based draw call bucketing
  • API and render thread
  • Resource API
  • View API
  • Encoder API
  • Customization
    • Options
• License
  • License (BSD 2-clause)
  • 3rd Party Libraries
  • Assets