Building
Quick Start
cmake -B build
cmake --build build
Build Options
Option |
Default |
Description |
|---|---|---|
|
|
Enable OpenGL backend |
|
|
Enable Vulkan backend |
|
|
Build test suite |
|
|
Build examples |
|
|
Build as shared library |
Build Examples
# CPU-only build (no GPU dependencies)
cmake -B build -DINK_ENABLE_GL=OFF
# With OpenGL
cmake -B build -DINK_ENABLE_GL=ON
# Build with tests
cmake -B build -DINK_BUILD_TESTS=ON
cmake --build build
ctest --test-dir build
# Build with examples
cmake -B build -DINK_BUILD_EXAMPLES=ON
cmake --build build
Integration
As a CMake subdirectory
add_subdirectory(third_party/ink)
target_link_libraries(my_app PRIVATE ink)
Manual
Add include/ to your include path and link against the built library.
Requirements
C++17 compiler (GCC, Clang, or MSVC)
CMake 3.16+
Optional: OpenGL + GLEW (for GL backend)
Test-only: Google Test (fetched automatically via CMake FetchContent)