ComputeSharp 2.0.0-alpha.23 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved

.NET 6.0 .NET Standard 2.0
This is a prerelease version of ComputeSharp.
This package has a SemVer 2.0.0 package version: 2.0.0-alpha.23+294709575f200fb8e0f1b7666d6fb9009710f591.
Install-Package ComputeSharp -Version 2.0.0-alpha.23
dotnet add package ComputeSharp --version 2.0.0-alpha.23
<PackageReference Include="ComputeSharp" Version="2.0.0-alpha.23" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ComputeSharp --version 2.0.0-alpha.23
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ComputeSharp, 2.0.0-alpha.23"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ComputeSharp as a Cake Addin
#addin nuget:?package=ComputeSharp&version=2.0.0-alpha.23&prerelease

// Install ComputeSharp as a Cake Tool
#tool nuget:?package=ComputeSharp&version=2.0.0-alpha.23&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

What is it?

ComputeSharp is a .NET library to run C# code in parallel on the GPU through DX12 and dynamically generated HLSL compute shaders. The available APIs let you access GPU devices, allocate GPU buffers and textures, move data between them and the RAM, write compute shaders entirely in C# and have them run on the GPU. The goal of this project is to make GPU computing easy to use for all .NET developers! 🚀

Quick start

ComputeSharp exposes a GraphicsDevice class that acts as entry point for all public APIs. The available GraphicsDevice.Default property that lets you access the main GPU device on the current machine, which can be used to allocate buffers and perform operations. If your machine doesn't have a supported GPU (or if it doesn't have a GPU at all), ComputeSharp will automatically create a WARP device instead, which will still let you use the library normally, with shaders running on the CPU instead through an emulation layer. This means that you don't need to manually write a fallback path in case no GPU is available - ComputeSharp will automatically handle this for you.

Let's suppose we want to run a simple compute shader that multiplies all items in a target buffer by two. The first step is to create the GPU buffer and copy our data to it:

// Get some sample data
int[] array = Enumerable.Range(1, 100).ToArray();

// Allocate a GPU buffer and copy the data to it.
// We want the shader to modify the items in-place, so we
// can allocate a single read-write buffer to work on.
using ReadWriteBuffer<int> buffer = GraphicsDevice.Default.AllocateReadWriteBuffer(array);

The AllocateReadWriteBuffer extension takes care of creating a ReadWriteBuffer<T> instance with the same size as the input array and copying its contents to the allocated GPU buffer. There are a number of overloads available as well, to create buffers of different types and with custom length.

Next, we need to define the GPU shader to run. To do this, we'll need to define a partial struct type implementing the IComputeShader interface (note that the partial modifier is necessary for ComputeSharp to generate additional code to run the shader). This type will contain the code we want to run on the GPU, as well as fields representing the values we want to capture and pass to the GPU (such as GPU resources, or arbitrary values we need). In this case, we only need to capture the buffer to work on, so the shader type will look like this:

[AutoConstructor]
public readonly partial struct MultiplyByTwo : IComputeShader
{
    public readonly ReadWriteBuffer<int> buffer;

    public void Execute()
    {
        buffer[ThreadIds.X] *= 2;
    }
}

We're using the [AutoConstructor] attribute included in ComputeSharp, which creates a constructor for our type automatically. The shader body is also using a special ThreadIds class, which is one of the available special classes to access dispatch parameters from within a shader body. In this case, ThreadIds lets us access the current invocation index for the shader, just like if we were accessing the classic i variable from within a for loop.

We can now finally run the GPU shader and copy the data back to our array:

// Launch the shader
GraphicsDevice.Default.For(buffer.Length, new MultiplyByTwo(buffer));

// Get the data back
buffer.CopyTo(array);

NOTE: this sample assumes that ComputeSharp.Dynamic is also installed. For info on how to only use precompiled shaders with the base ComputeSharp package, see the complete readme on GitHub.

There's more!

For a complete list of all features available in ComputeSharp, check the documentation in the GitHub repo.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on ComputeSharp:

Package Downloads
ComputeSharp.WinUI The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

A WinUI 3 library with controls to render DX12 shaders powered by ComputeSharp

ComputeSharp.Dynamic The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

An extension library for ComputeSharp to enable dynamic compilation of shaders at runtime

ComputeSharp.Uwp The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

A UWP library with controls to render DX12 shaders powered by ComputeSharp

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on ComputeSharp:

Repository Stars
Sergio0694/ComputeSharp
A .NET library to run C# code in parallel on the GPU through DX12, D2D1 and dynamically generated HLSL compute shaders, with the goal of making GPU computing easy to use for all .NET developers! 🚀
jenius-apps/ambie
The best white noise app on Windows
Version Downloads Last updated
2.0.0-alpha.23 68 5/12/2022
2.0.0-alpha.22 106 4/24/2022
2.0.0-alpha.21 77 4/21/2022
2.0.0-alpha.20 85 4/10/2022
2.0.0-alpha.19 226 3/5/2022
2.0.0-alpha.18 124 2/2/2022
2.0.0-alpha.17 60 1/31/2022
2.0.0-alpha.16 51 1/30/2022
2.0.0-alpha.15 69 1/27/2022
2.0.0-alpha.14 62 1/23/2022
2.0.0-alpha.13 56 1/18/2022
2.0.0-alpha.12 70 1/9/2022
2.0.0-alpha.11 59 1/6/2022
2.0.0-alpha.10 59 1/6/2022
2.0.0-alpha.9 98 12/19/2021
2.0.0-alpha.8 98 11/27/2021
2.0.0-alpha.7 120 10/31/2021
2.0.0-alpha.6 283 7/18/2021
2.0.0-alpha.5 108 7/15/2021
2.0.0-alpha.4 111 7/1/2021
2.0.0-alpha.3 135 5/13/2021
2.0.0-alpha.2 145 4/5/2021
2.0.0-alpha.1 144 3/7/2021