Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

To get started with vk-graph, add it as a project dependency to your Cargo.toml:

# Cargo.toml

[dependencies]
vk-graph = "0.14"

Features

vk-graph puts a lot of functionality behind optional features in order to optimize compile time for the most common use cases. The following features are available.

  • loaded (enabled by default) — Support searching for the Vulkan loader manually at runtime.
  • linked — Link the Vulkan loader at compile time.
  • profile_with_ — Use the specified profiling backend
    • …puffin
    • …optick
    • …superluminal
    • …tracy

Required Development Packages

Linux (Debian-like):

  • sudo apt install cmake uuid-dev libfontconfig-dev libssl-dev

Mac OS (10.15 or later):

  • Xcode 12
  • Python 2.7
  • brew install cmake ossp-uuid

Windows:

  • TODO

Vulkan SDK

Debug mode (setting the debug field of DeviceInfo or InstanceInfo to true) is only supported when certain validation layers are installed. The Vulkan SDK provides these layers and a number of helpful tools.

Important

The installed Vulkan SDK version must be at least v1.3.281.

Optional Distribution-Provided Validation Layers

Linux (Debian-like):

  • sudo apt install vulkan-validationlayers