Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discosultan/VulkanCore
Vulkan 1.0 graphics and compute API bindings for .NET Standard
https://github.com/discosultan/VulkanCore
c-sharp dotnet-standard gpgpu gpu graphics netstandard vulkan
Last synced: 3 months ago
JSON representation
Vulkan 1.0 graphics and compute API bindings for .NET Standard
- Host: GitHub
- URL: https://github.com/discosultan/VulkanCore
- Owner: discosultan
- License: mit
- Created: 2017-01-28T20:53:44.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-12-02T21:04:13.000Z (about 4 years ago)
- Last Synced: 2024-11-08T06:13:20.768Z (4 months ago)
- Topics: c-sharp, dotnet-standard, gpgpu, gpu, graphics, netstandard, vulkan
- Language: C#
- Homepage:
- Size: 1.32 MB
- Stars: 168
- Watchers: 19
- Forks: 27
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dotnet-machine-learning - VulkanCore
README
# VulkanCore
[](https://www.nuget.org/packages/VulkanCore)
[](https://www.khronos.org/vulkan/)
[](https://github.com/dotnet/standard/blob/master/docs/versions.md)
[](https://ci.appveyor.com/project/discosultan/vulkancore)
[](https://travis-ci.org/discosultan/VulkanCore)
> :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](#introduction)
- [Building](#building)
- [Samples](#samples---)
- [Tests](#tests--)
- [Related Work](#related-work)
## 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:
- Full control over the API including high quality code documentation
- Easier to contribute - no need to understand a generator
Cons:
- Requires manual work to keep up to date with the Vulkan API registry
- Cumbersome to modify the fundamentals - impossible to simply regenerate everything
## Building
[Visual Studio 2017](https://www.visualstudio.com/vs/whatsnew/) 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](https://www.jetbrains.com/rider/), [Visual Studio Code](https://code.visualstudio.com/) or [MonoDevelop](http://www.monodevelop.com/) should all work but have not been tested.
## Samples 
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).
Sets up a window and clears it to a solid color
ColoredTriangle
Renders a colored triangle defined in a vertex shader
TexturedCube
Creates a rotating textured cube mesh
ComputeParticles
Simulates 2D particles using a compute shader
## Tests 
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](https://xunit.github.io/) 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
- [VulkanSharp](https://github.com/mono/VulkanSharp)
- [SharpVulkan](https://github.com/jwollen/SharpVulkan)
- [SharpVk](https://github.com/FacticiusVir/SharpVk)
- [vk](https://github.com/mellinoe/vk)
- [Vortice.Vulkan](https://github.com/amerkoleci/Vortice.Vulkan)
