Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 3.04 KB

INSTALL.md

File metadata and controls

105 lines (71 loc) · 3.04 KB

Building and Installing KDGpu

Prerequisites

Windows

  • Microsoft Visual Studio C++ 2019 compiler (or later)

  • git

  • CMake, make sure it is in your PATH

  • Vulkan SDK

    • Make sure to install the additional debug libraries when prompted during the install process
    • Make sure VULKAN_SDK is set accordingly in your environment

Linux

  • C++20 compiler (GCC / Clang)

  • git

  • CMake

  • Vulkan SDK

    • Make sure VULKAN_SDK is set accordingly in your environment
    • Note: We recommend installing the Vulkan SDK directly from LunarG rather than relying on your distribution packages as those might not provide all of the tools and Vulkan layers commonly needed.

Mac

Hardware

Anything that supports Vulkan 1.2 or later

Dependencies

Mandatory dependencies will be automatically fetched and downloaded during the configuration process.

Optional Dependencies

Documentation

If you wish to build the documentation locally, you'll need to install the following dependencies

Building & Installation

KDGpu builds with CMake. Unpack or clone the KDGpu sources in the directory of your choosing.

    mkdir build
    cd build
    cmake -DKDGPU_BUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=/path/to/install/location/ ..
    cmake --build . --config Release
    cmake --install .

CMake Options

  • KDGPU_BUILD_KDXR=ON to enable building of the KDXr library and OpenXR backend
  • KDGPU_BUILD_EXAMPLES=ON to enable building of the examples
  • KDGPU_BUILD_TESTS=ON to enable building of the tests
  • KDGPU_HLSL_SUPPORT=OFF to look for the dxc compiler and build an example using HLSL shaders
  • KDGPU_DOCS=ON to build the documentation
  • CMAKE_INSTALL_PREFIX=/path/to/install to override the default installation path

Deployment

Using KDGpu in your project

    find_package(KDGpu REQUIRED)

    set(SOURCES main.cpp ...)

    add_executable(${PROJECT_NAME} ${SOURCES})

    target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_20)
    target_link_libraries(${PROJECT_NAME} PRIVATE  KDGpu::KDGpu)

Notes

CMake will looks for a file named KDGpuConfig.cmake. This file is located in <kdgpu_install_dir>/lib/cmake/KDGpu. If KDGpu was installed into a user defined location, you might have to set the CMAKE_PREFIX_PATH variable to contain the KDGpu install path:

    cmake -DCMAKE_PREFIX_PATH=<kdgpu_install_dir> ..

In case cmake is unable to locate the KDGpu CMake package, you could try to set CMAKE_FIND_DEBUG_MODE=ON to get more insight about where CMake is looking for.

    cmake -DCMAKE_PREFIX_PATH=<kdgpu_install_dir> -DCMAKE_FIND_DEBUG_MODE=ON ..