Bgfx.Net.Tools 0.2.0 

dotnet add package Bgfx.Net.Tools --version 0.2.0
                    


                    

                
NuGet\Install-Package Bgfx.Net.Tools -Version 0.2.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="Bgfx.Net.Tools" Version="0.2.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Bgfx.Net.Tools" Version="0.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Bgfx.Net.Tools">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Bgfx.Net.Tools --version 0.2.0
                    


                    

                
#r "nuget: Bgfx.Net.Tools, 0.2.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. 
#:package Bgfx.Net.Tools@0.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Bgfx.Net.Tools&version=0.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Bgfx.Net.Tools&version=0.2.0
                    


                            Install as a Cake Tool

Bgfx.Net

Cross-platform .NET bindings for bgfx, a graphics rendering library that runs on Windows, Linux, and macOS with Direct3D, Vulkan, OpenGL, and Metal backends.

Packages

Package Purpose
Bgfx.Net Managed bindings + native bgfx shared library for all supported RIDs
Bgfx.Net.Tools MSBuild integration that runs shaderc / texturec / geometryc at build time. Marked developmentDependency, so it doesn't propagate into consumer output.

Supported RIDs in v1: win-x64, linux-x64, osx-x64, osx-arm64. (linux-arm64 is planned — blocked on upstream bx adding a native linux-arm64-gcc action.)

Quick start

using Bgfx.Net;

var init = new InitDescription { Type = RendererType.Vulkan };
Bgfx.Init(in init);

while (running)
{
    Bgfx.Frame();
}

Bgfx.Shutdown();

Cloning

This repository uses git submodules for bgfx, bx, and bimg:

git clone --recurse-submodules https://github.com/$USER/Bgfx.Net.git
# or, after a normal clone:
git submodule update --init --recursive
# or use the helper:
./build/bootstrap.ps1

Building locally

Prerequisites: .NET SDK 10, PowerShell 7, plus a C++ toolchain for your platform (MSVC on Windows, gcc/clang on Linux, Xcode CLT on macOS).

./build/bootstrap.ps1            # init submodules, fetch genie
./build/build-native-win.ps1     # or build-native-unix.sh on Linux/macOS
./build/sync-bindings.ps1        # copies bgfx.cs into src/Bgfx.Net/Generated/
./build/run-generator.ps1        # produces bgfx.g.cs
dotnet build Bgfx.Net.sln

Caveats

  • Shaders on Linux/macOS: shaderc can produce GLSL/ESSL/Metal/SPIR-V on all platforms, but Direct3D shader compilation (DXBC via fxc, DXIL via dxc) needs additional Windows-side tooling.
  • Threading: bgfx uses an API thread + render thread model selected at Init. See bgfx's docs for the threading contract.
  • Pinned to a specific bgfx revision: The Bgfx.Net assembly is built against exactly one bgfx commit. Read the pin at runtime via Bgfx.Net.BgfxBuildInfo.ApiVersion and .Revision (also embedded as BgfxApiVersion / BgfxRevision assembly metadata). The package version itself is independent wrapper SemVer, not the bgfx revision — see RELEASING.md. Mixing the assembly with a different bgfx.dll at runtime is unsupported.

License

BSD-2-Clause. See LICENSE for our code and THIRD-PARTY-NOTICES.md for upstream and 3rdparty attributions.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.0

    • No dependencies.

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
0.2.0 98 6/11/2026
0.1.0 151 5/18/2026

Bundles bgfx API v145. Exact upstream commit recorded in assembly metadata (BgfxRevision).