XenoAtom.ShaderCompiler 1.0.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package XenoAtom.ShaderCompiler --version 1.0.0                

                    
                

            
NuGet\Install-Package XenoAtom.ShaderCompiler -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="XenoAtom.ShaderCompiler" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add XenoAtom.ShaderCompiler --version 1.0.0                

                    
                

            
#r "nuget: XenoAtom.ShaderCompiler, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install XenoAtom.ShaderCompiler as a Cake Addin
#addin nuget:?package=XenoAtom.ShaderCompiler&version=1.0.0

// Install XenoAtom.ShaderCompiler as a Cake Tool
#tool nuget:?package=XenoAtom.ShaderCompiler&version=1.0.0

XenoAtom.ShaderCompiler ci

<img align="right" width="160px" height="160px" src="https://raw.githubusercontent.com/XenoAtom/XenoAtom.ShaderCompiler/main/img/XenoAtom.ShaderCompiler.png">

This project provides:

  • A library XenoAtom.ShaderCompiler that exposes higher-level integration of shaderc to compile HLSL/GLSL shaders. NuGet
  • A tool dotnet-shaderc the equivalent of glslc that can be installed on any machine that has the .NET 8 SDK NuGet
  • A MSBuild integration via XenoAtom.ShaderCompiler.Build that allows to compile shaders to SPIR-V binary files, embed them directly in C# (via a built-in Source Generator) or generates tar/tar.gz files. NuGet

✨ Features

  • Supports most features of shaderc.
    • Support for include directories.
  • Multithreaded shader compiler.
  • dotnet-shaderc is a .NET Tool equivalent of glslc that can be installed on any machine that has the .NET 8 SDK
  • The package XenoAtom.ShaderCompiler.Build allows to integrate in your C# or any MSBuild projects the compilation of HLSL/GLSL shaders.
    • C# source generator supports embedding SPIR-V binary returned as ReadOnlySpan<byte> (Default mode for C# projects).
    • Can generate tar / tar.gz files to collect all compiled shaders.
    • Can copy SPIR-V files as-is to the output folder shipped with your library/app.
    • Incremental compiler that detects includes and dependencies to only compile relevant changes.

📖 User Guide

For more details on how to use XenoAtom.ShaderCompiler, please visit the user guide.

🪪 License

This software is released under the BSD-2-Clause license.

🤗 Author

Alexandre Mutel aka xoofx.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 68 6/21/2024
1.0.0 63 6/20/2024

https://github.com/XenoAtom/XenoAtom.ShaderCompiler/releases/tag/1.0.0