89 lines
4 KiB
ReStructuredText
89 lines
4 KiB
ReStructuredText
|
|
C++ Build System Deep Dive
|
|
======================
|
|
|
|
The recommended approach to build the project is as out-of-source build in the ``build`` folder. This project comes with a ``Makefile`` that provides a set of commands that help with developer workflows. You can see some of the commands if you want to add some of the more advanced commands.
|
|
|
|
For a base build you just have to run:
|
|
|
|
.. code-block::
|
|
|
|
cmake -Bbuild
|
|
|
|
This by default configures without any of the extra build tasks (such as building shaders) and compiles without the optional dependencies. The table below provides more detail.
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Flag
|
|
- Description
|
|
* - -DCMAKE_INSTALL_PREFIX="build/src/CMakefiles/Export/"
|
|
- Enables local installation (which won't require admin privileges)
|
|
* - -DCMAKE_TOOLCHAIN_FILE="..."
|
|
- This is the path for your package manager if you use it such as vcpkg.
|
|
* - -DKOMPUTE_OPT_BUILD_TESTS=ON
|
|
- Enable if you want to build tests.
|
|
* - -DKOMPUTE_OPT_CODE_COVERAGE=ON
|
|
- Enable if you want code coverage.
|
|
* - -DKOMPUTE_OPT_BUILD_DOCS=ON
|
|
- Enable if you want to build documentation.
|
|
* - -DKOMPUTE_OPT_INSTALL=ON
|
|
- Enable if you want to enable installation.
|
|
* - -DKOMPUTE_OPT_BUILD_PYTHON=ON
|
|
- Enable if you want to build python bindings.
|
|
* - -DKOMPUTE_OPT_LOG_LEVEL="Trace"
|
|
- Internally we use spdlog for logging. The log level used can be changed here.
|
|
* - -DKOMPUTE_OPT_ANDROID_BUILD=ON
|
|
- Enable android compilation flags required.
|
|
* - -DKOMPUTE_OPT_DISABLE_VK_DEBUG_LAYERS=ON
|
|
- Explicitly disable debug layers even on debug.
|
|
* - -DKOMPUTE_OPT_DISABLE_VULKAN_VERSION_CHECK=ON
|
|
- Whether to check if your driver supports the Vulkan Header version you are linking against. This might be useful in case you build shared on a different system than you run later.
|
|
* - -DKOMPUTE_OPT_USE_BUILD_IN_SPDLOG=ON
|
|
- Use the build in version of Spdlog.
|
|
* - -DKOMPUTE_OPT_USE_BUILD_IN_FMT=ON
|
|
- Use the build in version of fmt.
|
|
* - -DKOMPUTE_OPT_USE_BUILD_IN_GOOGLE_TEST=ON
|
|
- Use the build in version of GoogleTest.
|
|
* - -DKOMPUTE_OPT_USE_BUILD_IN_PYBIND11=ON
|
|
- Use the build in version of pybind11.
|
|
* - -DKOMPUTE_OPT_USE_BUILD_IN_VULKAN_HEADER=ON
|
|
- Use the build in version of Vulkan Headers. This could be helpful in case your system Vulkan Headers are to new for your driver. If you set this to false, please make sure your system Vulkan Header are supported by your driver.
|
|
* - -DKOMPUTE_OPT_BUILD_IN_VULKAN_HEADER_TAG="v1.2.203"
|
|
- The git tag used for the build in Vulkan Headers when 'KOMPUTE_OPT_USE_BUILD_IN_VULKAN_HEADER' is enabled. A list of tags can be found here: https://github.com/KhronosGroup/Vulkan-Headers/tags
|
|
|
|
Compile Flags
|
|
~~~~~~~~~~~~~
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Flag
|
|
- Description
|
|
* - KOMPUTE_CREATE_PIPELINE_RESULT_VALUE
|
|
- Ensure the return value of createPipeline is processed as ResultValue instead of Result
|
|
|
|
Other CMake Flags
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Flag
|
|
- Description
|
|
* - -DPYTHON_INCLUDE_DIR
|
|
- Path to where Python.h is found, used for specifying installation of Python (see `this PR <https://github.com/KomputeProject/kompute/pull/222>`_)
|
|
* - -DPYTHON_LIBRARY
|
|
- Path to the Python library, used for specifying installation of Python (see `this PR <https://github.com/KomputeProject/kompute/pull/222>`_)
|
|
* - -DCMAKE_OSX_ARCHITECTURES
|
|
- Specifies the target architecture for Apple platforms (see `this issue <https://github.com/KomputeProject/kompute/issues/223>`_)
|
|
|
|
Dependencies
|
|
^^^^^^^^^^^^
|
|
|
|
Given Kompute is expected to be used across a broad range of architectures and hardware, it will be important to make sure we are able to minimise dependencies.
|
|
|
|
Required dependencies
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
The only required dependency in the build is the Vulkan SDK. More specifically, the header files vulkan.h and vulkan.hpp, which are both part of the Vulkan SDK. If you haven't installed the Vulkan SDK yet, you can `download it here <https://vulkan.lunarg.com/>`_.
|