This page gives a quick path from source tree to a working build.
What the Project Provides
wx_BGI_Graphics combines:
- classic BGI-style immediate drawing
- retained DDS scene replay and serialization
- 2D/3D cameras and world-coordinate drawing
- 3D solids and retained affine composition
- standalone windows and wxWidgets embedded canvases
Supported Platforms
Main Dependencies
Most C/C++ dependencies are fetched automatically by CMake:
- GLFW 3.4
- GLEW 2.2.0
- GLM 1.0.1
- wxWidgets 3.2.5+
- nlohmann/json
- yaml-cpp
- Manifold
Optional external tools:
- Doxygen
- LaTeX / MiKTeX
- FreePascal
- Python 3
Build Commands
Windows
cmake -S . -B build
cmake --build build -j --config Debug
cmake --build build -j --config Release
Linux
cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build -j
macOS
cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build -j
For detailed platform notes, optional flags, OpenLB staging, and macOS-specific workarounds, see Building.md in the Developer Guide.
Run Tests
Windows
ctest --test-dir build -C Debug --output-on-failure
Linux / macOS
ctest --test-dir build --output-on-failure
For the full test catalog and platform-specific notes, see Tests.md.
Suggested Reading Path
- Tutorial.md for classic buffering and animation
- DDS.md for retained scenes and serialization
- Object-Operation.md for transforms and set operations
- WxWidgets.md if you want embedded GUI integration
- OpenLB-Support.md if you want solver/live-view integration
Next
