Vulkan-Projects.adoc

Map of Vulkan project GitHub repositories

Vulkan is a big project with many parts, described here in no particular order.

Also see https://www.khronos.org/registry/vulkan/#repos for further information

Khronos/Vulkan® Specification

Vulkan® Specification - formal documentation of the Vulkan API. This includes the main API Specification, the reference (man) pages, the XML API Registry, and related tools and scripts.

• Vulkan Landing Page

• Vulkan Registry

The published Vulkan specifications and reference pages, as well as the published header files, are generated from the sources in this repository:

• Repository: Vulkan-Docs

• License: mixed — approximately:

  • Proprietary Khronos license for the Vulkan Specification published by Khronos on its website

  • CC-BY 4.0 for asciidoctor sources for the Specification and related documents such as the reference pages, style guide, and XML schema documentation.

  • Apache 2 for code, including the XML registry defining API interfaces

• Contacts:

  • Vulkan forum

• Compiler requirements: Use the khronosgroup/docker-images:asciidoctor-spec Docker image on dockerhub for quickest way to build the spec

Khronos/SPIRV-Tools

The SPIR-V Tools project provides an API and commands for processing SPIR-V modules.

• Repository: SPIRV-Tools

• License: Apache

• Contacts:

  • SPIRV-Tools Mailing List

  • <dneto@google.com> (David Neto)

• Compiler requirements: C+11 compatible compiler (MSVC 2013 on Windows)

Khronos/glslang

glslang is a GLSL and HLSL to SPIR-V compiler, usable both as a command-line tool as well as a library.

• Website: glslang Reference Compiler

• Repository: glslang

• License: 3-clause BSD

• Contact: <dneto@google.com> (David Neto)

• Compiler requirements: C+11 compatible compiler (MSVC 2013 on Windows)

Khronos/Vulkan-Headers

Vulkan Header files and API registry

• Repository: Vulkan-Headers

• License: Apache

• Contacts:

  • For now: <karl@lunarg.com> (Karl Schultz)

• Code of Conduct

• Compiler requirements: N/A

• NOTE Vulkan-Headers is just a staging area collecting files generated from other repositories. If you find a problem with anything in Vulkan-Headers, refer to the repository README to determine where to report that problem.

Khronos/Vulkan-Loader

Source code for the Vulkan loader

• Repository: Vulkan-Loader

• License: Apache

• Contacts:

  • <lenny@lunarg.com> (Lenny Komow)

• Code of Conduct

• Compiler requirements: MSVC 2013+ / Python 3 / gcc 4.8.2+ / clang 3.4+

Khronos/Vulkan-ValidationLayers

Source code for the Vulkan validation layers

• Repository: Vulkan-ValidationLayers

• License: Apache

• Contacts:

  • <tobine@google.com> (Tobine Ehlis)

  • <mark@lunarg.com> (Mark Lobodzinski)

• Code of Conduct

• Compiler requirements: MSVC 2013+ / gcc 4.8.2+ / clang 3.4+

Khronos/Vulkan-Tools

Source code for the Vulkan utilities and tools

• Repository: Vulkan-Tools

• License: Apache

• Contacts:

  • <tobine@google.com> (Tobine Ehlis)

  • <mark@lunarg.com> (Mark Lobodzinski)

• Code of Conduct

• Compiler requirements: MSVC 2013+ / gcc 4.8.2+ / clang 3.4+

Khronos/MoltenVK

MoltenVK is an implementation of the high-performance, industry-standard Vulkan graphics and compute API that runs on Apple’s Metal graphics framework, bringing Vulkan compatibility to iOS and macOS

• Repository: https://github.com/KhronosGroup/MoltenVK

• License: Apache

• Contact: <bill.hollings@brenwill.com> (Bill Hollings)

• Compiler requirements: Xcode 9 / python 3

Khronos/Vulkan-HPP

Vulkan-Hpp is a set of lightweight C++ bindings for the Vulkan API.

• Repository: https://github.com/KhronosGroup/Vulkan-Hpp

• License: Apache

• Contact: <mtavenrath@nvidia.com> (Markus Tavenrath)

• Compiler requirements: MSVC 2013+ / gcc 4.8.2+ / clang 3.3+

Khronos/SPIRV-Cross

SPIRV-Cross is a practical tool and library for performing reflection on SPIR-V and disassembling SPIR-V back to high level languages.

• Repository: https://github.com/KhronosGroup/SPIRV-Cross

• License: Apache

• Contacts:

  • <hans-kristian.arntzen@arm.com> (@HansKristian-ARM)

• Compiler requirements: MSVC 2013 / gcc 4.8/4.9+ / clang 3.x+

DirectX Shader Compiler (DXC)

DirectX Shader Compiler (DXC) is Microsoft’s next-gen official HLSL compiler, based on LLVM/Clang. Apart from compiling HLSL into DXIL, it can also compile HLSL into SPIR-V, thanks to contributions from Google.

• Landing page: DXC Wiki

• Repository: DirectXShaderCompiler

• License: University of Illinois Open Source License

• Contacts:

  • <antiagainst@google.com> (Lei Zhang) (for SPIR-V CodeGen)

  • <opencode@microsoft.com> (for other issues)

• Platform: Windows, Linux, macOS

• Compiler requirements: MSVC 2017 / GCC 5.5+ / Clang 3.8+

• Download: Rolling release for Windows

RenderDoc

RenderDoc - a graphics debugger, currently available for Vulkan, D3D11, D3D12, and OpenGL development on Windows 7 - 10 and Linux.

• Website: https://renderdoc.org/

• Repository: https://github.com/baldurk/renderdoc

• License: MIT

• Contacts:

  • <baldurk@baldurk.org> (Baldur Karlsson)

  • #renderdoc on freenode IRC

• Contributor Covenant (Code of Conduct)

• Compiler requirements: MSVC 2015 / gcc 5 / clang 3.4

LunarG/VulkanTools

Source code for various Vulkan Tools: vktrace/vkreplay, device simulation layer, API dump layer, fps monitor layer, screenshot layer, assistant layer, layer factory framework, and Vulkan installation analyzer.

• Repository: https://github.com/LunarG/VulkanTools

• License: Apache

• Contact: <david@lunarg.com> (David Pinedo)

• Code of Conduct

• Compiler requirements: MSVC 2013+ / gcc 4.8.2+ / clang 3.4+

Vulkano

Vulkano is a type-safe wrapper around Vulkan API in Rust.

• Website: http://vulkano.rs/

• Repository: https://github.com/vulkano-rs/vulkano

• License: Apache or MIT

• Contacts:

  • Vulkano on Gitter

• Compiler requirements: Rust 1.22, gcc-4.8