Repository files navigation

Proud to be an official project under the benevolent.NET Foundation umbrella.

Having poured lots of hours into examining generated C# code and its JIT assembly, you can count on us to deliver blazing fast bindings with negligible overhead induced by Silk.NET!

With an efficient bindings regeneration mechanism, we are committed to ensuring our bindings reflect the latest specifications with frequent updates generated straight from the upstream sources.

In addition to providing high-speed, direct, and transparent bindings, we provide high-level utilities and wrappers to maximise productivity in common workloads such as platform-agnostic abstractions around Windowing and Input, bringing your apps to a vast number of platforms without changing a single line!

Silk.NET caters for anything you could need in swift development of multimedia, graphics, compute applications. Silk.NET is an all-in-one solution, complete with Graphics, Compute, Audio, Input, and Windowing.

We currently have the following maintainers:

• Kai Jellinghaus
• Thomas Mizrahi
• Beyley Thomas

In addition, the Silk.NET working group help drive larger user-facing changes providing key consultation from the perspective of dedicated users and professionals.

Prerequisites

• Must: .NET 6 SDK
• Should:NUKE (build system). Install usingdotnet tool install Nuke.GlobalTool --global
• Should: Android, iOS, and MAUI .NET 6 workloads (usedotnet workload install android ios maccatalyst maui to install them)
• Should: Android SDK version 30 with NDK tools installed. On Windows, for best results this should be installed intoC:\ProgramData\Android\android-sdk.
• Could: Java JDK (for gradle)
• Could: Visual Studio 2022 Community version 17.0 or later

Instructions

• Clone the repository (recursively)
• Run build.sh, build.cmd, build.ps1, ornuke compile.
• Use the DLLs. To get nupkgs you can use with NuGet instead, usenuke pack.

There are more advanced build actions you can do too, such as FullBuild, Pack, FullPack, among others which you can view by doingnuke --plan.

Note: Some .NET 6 workloads are only supported on Windows and macOS today.

Silk.NET uses and encouragesEarly Pull Requests. Please don't wait until you're done to open a PR!

1. Fork Silk.NET
2. Add an empty commit to a new branch to start your work off:git commit --allow-empty -m "start of [thing you're working on]"
3. Once you've pushed a commit, open adraft pull request. Do thisbefore you actually start working.
4. Make your commits in small, incremental steps with clear descriptions.
5. Tag a maintainer when you're done and ask for a review!

The Silk.NET solution isvery large. Learn about how you can combat this using our build process inCONTRIBUTING.md.

This helps ensure Silk.NET's long term viability, and to help support the developers who maintain Silk.NET in their free time.Kai is accepting GitHub Sponsorships.

• Several examples can be found in theexamples folder
• Come chat with us onDiscord!

Silk.NET is distributed under the very permissive MIT/X11 license and all dependencies are distributed under MIT-compatible licenses.

Silk.NET is a.NET Foundation project, and has adopted the code of conduct defined by theContributor Covenant to clarify expected behavior in our community. For more information, see the.NET Foundation Code of Conduct.

Special thanks toJetBrains for supporting us with open-source licenses for their IDEs.