Metal.NET 1.0.8

Metal.NET

C# bindings for Apple's Metal graphics API, auto-generated from metal-cpp headers.

Project Structure

Metal.NET.slnx
├── Metal.NET/                            ← Binding library (targets .NET 10, macOS 15+)
│   ├── Common/
│   │   ├── NativeObject.cs               ← INativeObject<TSelf> interface + abstract base wrapper
│   │   ├── ObjectiveCRuntime.cs          ← P/Invoke to libobjc.dylib (objc_msgSend)
│   │   ├── Selector.cs                   ← ObjC selector with implicit string conversion
│   │   ├── Bool8.cs                      ← ObjC BOOL mapped to a single byte
│   │   └── MTLStructs.cs                ← Blittable structs (MTLOrigin, MTLSize, etc.)
│   ├── Foundation/                       ← Hand-written Foundation types
│   │   ├── NSString.cs                   ← Bidirectional string conversion
│   │   ├── NSError.cs                    ← Error wrapper with LocalizedDescription
│   │   ├── NSArray.cs                    ← NSArray ↔ T[] conversion utilities
│   │   ├── NSURL.cs                      ← File URL creation
│   │   └── NSAutoreleasePool.cs          ← Autorelease pool management
│   ├── Metal/                            ← Auto-generated Metal API (352 files)
│   ├── MetalFX/                          ← Auto-generated MetalFX (18 files)
│   └── QuartzCore/                       ← Auto-generated QuartzCore (2 files)
│
└── Metal.NET.Generator/                  ← Offline code generator
    ├── Program.cs                        ← Entry point
    ├── Generator.cs                      ← Orchestrator (parser → emitter pipeline)
    ├── CppParser.cs                      ← Regex-based metal-cpp header parser
    ├── CSharpEmitter.cs                  ← C# source code emitter
    ├── TypeMapper.cs                     ← C++ → C# type mapping and naming
    ├── GeneratorContext.cs               ← Shared state between parser and emitter
    ├── Models.cs                         ← Data models (EnumDef, ClassDef, MethodInfo, etc.)
    └── metal-cpp/                        ← metal-cpp headers (generation source)

Memory Management

Owned vs Borrowed References

Every NativeObject wrapper tracks whether it owns its native reference via bool ownsReference:

• Owned (true) — the wrapper sends release on Dispose() or GC finalization. Used for objects returned by alloc, new, copy, or mutableCopy selectors.
• Borrowed (false) — the wrapper never sends release. Used for property getters, objectAtIndex:, and out NSError parameters.

// Owned — selector begins with "new", caller must release
using MTLLibrary library = device.NewDefaultLibrary();

// Borrowed — property getter, retained by the parent object
MTLDevice device = commandQueue.Device;

GC-Safe Dispose

NativeObject implements the full dispose pattern with a finalizer. Release() uses Interlocked.Exchange to guarantee exactly-once semantics, making double-Dispose() and GC finalization safe:

public abstract class NativeObject(nint nativePtr, bool ownsReference) : IDisposable
{
    ~NativeObject() => Release();

    public void Dispose() { Release(); GC.SuppressFinalize(this); }

    private void Release()
    {
        if (Interlocked.Exchange(ref disposed, 1) is not 0) return;
        if (OwnsReference) ObjectiveCRuntime.Release(NativePtr);
    }
}

Updating Bindings

1. Download the latest metal-cpp archive
2. Replace Metal.NET.Generator/metal-cpp/ contents
3. Run the generator:

dotnet run --project Metal.NET.Generator

4. Build:

dotnet build Metal.NET

Disclaimer

This library was built with AI assistance. It has undergone preliminary testing to verify basic usability, but has not been exhaustively validated in production scenarios. If you plan to use it in a real project, please ensure it meets your requirements through thorough testing.

Alternatives

If you are looking for more mature or alternative Metal bindings for .NET, consider:

• SharpMetal — A community-maintained C# Metal binding library.
• .NET net-macos / net-ios TFM — Apple platform targets shipped with .NET that include official Metal API bindings via dotnet/macios.

Trademarks

"Metal" is a trademark of Apple Inc. This project is not affiliated with or endorsed by Apple Inc.

Third-Party Notices

See THIRD-PARTY-NOTICES.md for details on third-party components used in this project.