Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 2.51 KB

AGENTS.md

File metadata and controls

42 lines (34 loc) · 2.51 KB

Repository Guidelines

Project Structure & Modules

  • Core source lives in framework/ (application, decode, encode, format, util, generated) and the Vulkan capture layer is in layer/.
  • Tools are in tools/ (replay, compress, convert, extract, info), with helper scripts under scripts/.
  • Build configuration files live in cmake/ and CMakeLists.txt; platform specifics under android/ and docs/ for usage notes.
  • Tests and sample workloads reside in test/ (see test/test_apps and launcher code); third-party code is in external/.
  • C++ code under framework/generated/ is generated by python scripts that reside in the same directory. Do not modify generated c++ code in this directory directly, instead change the generator python scripts. Named of generated files will start with the prefix generated_.

Build, Test, and Development Commands

  • python scripts/build.py -j 8 --test-apps – configure and build for desktop (runs clang-format check and builds tests).
  • Quick incremental build: ( cd build/<platform>/<arch>/cmake_output ; make -j 8 )

Coding Style & Naming Conventions

  • C++ follows the Google C++ Style Guide with the repo’s .clang-format (ClangFormat 14). Use GFXRECON_ASSERT.
  • Python follows PEP 8; use yapf -i with .style.yapf.
  • Keep interfaces STL-like when intended; prefer explicit.

Testing Guidelines

  • After a build, run the test script build/<platform>/<arch>/output/test/run-tests.sh.

Extra information

  • If investigating an extension that you are not familiar with, download the extension text from https://docs.vulkan.org/refpages/latest/refpages/source/<extension name>.html and read it.
  • For design reviews, read and consider docs/GFXReconstruct\ Architectural\ Principles.md first.

Modifying capture functionality

  • Capture is often also called encode or trace in the code.
  • Much of the capture code is under framework/encode/ while the main library entry points are in layer/layer_vulkan_entry.cpp

Modifying replay functionality (gfxrecon-replay)

  • Replay is often also called decode in the code.
  • Much of the replay code is under framework/decode/
  • Window system related code is under framework/application/
  • The main replayer code is in tools/replay/desktop_main.cpp (for desktop builds) and tools/replay/android_main.cpp (for Android).

Modifying post-processing functionality (gfxrecon-optimize)

  • Most post-processing specific code lies under tools/optimize/ and the main entry point is tools/optimize/main.cpp