Home

Awesome

VulkanCore

NuGet Pre Release Vulkan .NET Standard AppVeyor Build Status Travis Build Status

:warning: This project is no longer in active development. It fully implements the latest 1.0 version of Vulkan. Bugs in the core project will still be fixed and contributions for versions 1.1 and 1.2+ are welcome. Please see the "Related Work" list below for alternatives.

Introduction

VulkanCore is a thin cross-platform object-oriented wrapper around the Vulkan C API. It supports .NET Core, .NET Framework and Mono.

Why yet another set of bindings? While most of the alternatives use a generator-based approach, these bindings do not. This means:

Pros:

Cons:

Building

Visual Studio 2017 or equivalent tooling is required to successfully compile the source. The tooling must support the new .csproj format and C# 7 language features. Latest Rider, Visual Studio Code or MonoDevelop should all work but have not been tested.

Samples <img height="24" src="Assets/Windows64.png"> <img height="24" src="Assets/Android64.png"> <img height="24" src="Assets/MacOS64.png">

Vulkan-capable graphics hardware and drivers are required to run the samples. Win32 samples are based on WinForms (.NET Framework) and Android ones on Xamarin (Mono).

<table> <tr> <td><img src="Assets/ClearScreen.jpg" alt="ClearScreen"></td> <td> <a href="Samples/Shared/01-ClearScreen">ClearScreen</a> <p>Sets up a window and clears it to a solid color</p> </td> </tr> <tr> <td><img src="Assets/ColoredTriangle.jpg" alt="ColoredTriangle"></td> <td> <a href="Samples/Shared/02-ColoredTriangle">ColoredTriangle</a> <p>Renders a colored triangle defined in a vertex shader</p> </td> </tr> <tr> <td><img src="Assets/TexturedCube.jpg" alt="TexturedCube"></td> <td> <a href="Samples/Shared/03-TexturedCube">TexturedCube</a> <p>Creates a rotating textured cube mesh</p> </td> </tr> <tr> <td><img src="Assets/ComputeParticles.jpg" alt="ComputeParticles"></td> <td> <a href="Samples/Shared/04-ComputeParticles">ComputeParticles</a> <p>Simulates 2D particles using a compute shader</p> </td> </tr> </table>

Tests <img height="24" src="Assets/Windows64.png"> <img height="24" src="Assets/Ubuntu64.png">

In order to provide a certain level of functional correctness, the project aims to achieve full statement coverage for the core API. Tests are built using xUnit and .NET Core and have been tested on Ubuntu and Windows platforms.

Note that it's difficult to test vendor specific extensions due to requirements for specialized hardware/drivers - therefore, covering them at this point is not planned.

Related Work