PixelBullet Documentation

Table of Contents

• What Lives Here
• Documentation Map
  • Guides
  • Module Notes
  • API Surface
• Build And Verification Entry Points
• Packaging Notes
• Theme Integration

This site is the generated documentation home for the PixelBullet workspace. It complements the repository root README.md, which remains the main onboarding document for host setup, build/test quickstarts, and day-to-day development workflows.

What Lives Here

• Hand-authored documentation pages under docs/
• Generated API and source documentation for the public include tree under engine/include/pixelbullet plus the implementation tree under engine/src/pixelbullet
• Durable module-local notes that are useful to keep alongside the code they describe

Documentation Map

Guides

• Logging workflow

Module Notes

• The graphics and shader pipeline notes live in the Graphics Module page generated from engine/src/pixelbullet/graphics/README.md.

API Surface

• Public engine headers live under engine/include/pixelbullet and are exported through curated engine Bazel targets.
• //engine:pixelbullet_api is the supported header-only SDK umbrella target for pixelbullet/pixelbullet.hpp.
• The engine implementation surface is split across subsystem libraries such as pixelbullet_core, pixelbullet_filesystem, pixelbullet_assets, pixelbullet_scene, pixelbullet_window, pixelbullet_audio, pixelbullet_shader, pixelbullet_graphics, pixelbullet_application, and pixelbullet_imgui.
• pixelbullet_application is the application framework surface, while pixelbullet_imgui is the optional Vulkan/GLFW ImGui integration layer.
• The packaged SDK ships the curated public header surface from engine/include/pixelbullet. The only supported public include form is pixelbullet/<subsystem>/<snake_case>.hpp. Lower-level backend and plumbing headers remain internal under engine/src/pixelbullet.
• The editor and sandbox stay application-focused; their source trees are organized by app subsystem under editor/src/* and examples/sandbox/src/*, they are not treated as primary API documentation surfaces, and first-party code should use direct includes plus explicit subsystem deps rather than pixelbullet_api.

Build And Verification Entry Points

The repository is Bazel-first. The main entrypoints are:

bazel test //:repo_tests
bazel build --config=debug //editor:pixelbullet-editor
bazel build --config=debug //examples/sandbox:sandbox-app
bazel run //tools/dev:refresh_compile_commands
bazel build //doxygen:html

The generated HTML output is written under bazel-bin/doxygen/html/.

Packaging Notes

PixelBullet currently ships two Bazel packaging targets:

• //packaging:bundle_sdk for a host-specific SDK archive
• //packaging:bundle_release for a host-specific runtime bundle used for local and CI workflows

The SDK bundle is the coherent packaged output of the current repo pass. The runtime bundle should still be treated as a host-specific developer artifact rather than a portable distribution.

The legacy aggregate Bazel targets //engine:pixelbullet_foundation and //engine:pixelbullet_engine are no longer part of the supported surface.

Theme Integration

This site uses a vendored copy of Doxygen Awesome from static/doxygen-theme/. The theme is intentionally kept local for now so the documentation build remains straightforward and reproducible inside the workspace.