Ryubing/SharpMetal
1
0
Fork 0
mirror of https://github.com/Ryubing/SharpMetal.git synced 2025-05-13 03:00:37 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Readme Updates

Browse source
This commit is contained in:
Isaac Marovitz 2023-07-26 12:21:09 -04:00 committed by GitHub
parent 7a3b84c222
commit fdb77a9172
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,12 +1,21 @@
<div align="center">
# SharpMetal
*Metal bindings for C#.*
Metal bindings for C#.
![](https://img.shields.io/github/actions/workflow/status/IsaacMarovitz/SharpMetal/dotnet.yml?style=for-the-badge)
<!-- ![](https://img.shields.io/github/actions/workflow/status/IsaacMarovitz/SharpMetal/dotnet.yml?style=for-the-badge) -->
<img width="1552" alt="Screenshot 2023-07-25 at 07 30 19" src="https://github.com/IsaacMarovitz/SharpMetal/assets/42140194/558e95e2-e91f-454c-9ac6-6917692112bf">
<img width="624" alt="primitive" src="https://github.com/IsaacMarovitz/SharpMetal/assets/42140194/478e2341-7c5d-47ad-9638-615b3091cef1">
</div>
## Why?
The .NET ecosystem is very much lacking a good Metal binding package. Existing options are out of date, or don't integrate well into cross-platform projects. This project aims to be a complete, up to date, package that stays true to the original API, while making the API easy to use and integrate into C#.
The .NET ecosystem is very much lacking a good Metal binding package. Existing options are outdated or don't integrate well into cross-platform projects. This project aims to be a complete, up-to-date package that stays true to the original API while making the API easy to use and integrate into C#.
## What can you make with it?
Progress is underway to build a full set of working reimplementations of the metal-cpp samples. Thanks to the generator, the entire Metal API, from compute shaders to raytracing, should be available, although specific things may take further tweaking.
## I want to contribute!
@ -18,4 +27,4 @@ Wonderful! SharpMetal is built with .NET 7.0, and follows a couple of specific g
- `NSInteger` -> `long`
- `NSUInteger` -> `ulong`
- Mark structs and classes with `SupportedOSPlatform` attribute
- SharpMetal is built for macOS primarily so when there are platform specific differences, use the macOS option
- SharpMetal is built for macOS primarily, so when there are platform-specific differences, use the macOS option