- Core source lives in
framework/(application, decode, encode, format, util, generated) and the Vulkan capture layer is inlayer/. - Tools are in
tools/(replay,compress,convert,extract,info), with helper scripts underscripts/. - Build configuration files live in
cmake/andCMakeLists.txt; platform specifics underandroid/anddocs/for usage notes. - Tests and sample workloads reside in
test/(seetest/test_appsand launcher code); third-party code is inexternal/. - 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 prefixgenerated_.
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 )
- C++ follows the Google C++ Style Guide with the repo’s
.clang-format(ClangFormat 14). UseGFXRECON_ASSERT. - Python follows PEP 8; use
yapf -iwith.style.yapf. - Keep interfaces STL-like when intended; prefer explicit.
- After a build, run the test script
build/<platform>/<arch>/output/test/run-tests.sh.
- 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>.htmland read it. - For design reviews, read and consider
docs/GFXReconstruct\ Architectural\ Principles.mdfirst.
- Capture is often also called
encodeortracein the code. - Much of the capture code is under
framework/encode/while the main library entry points are inlayer/layer_vulkan_entry.cpp
- Replay is often also called
decodein 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) andtools/replay/android_main.cpp(for Android).
- Most post-processing specific code lies under
tools/optimize/and the main entry point istools/optimize/main.cpp