Zireael.Net 0.1.0-alpha.6

This is a prerelease version of Zireael.Net.
dotnet add package Zireael.Net --version 0.1.0-alpha.6
                    
NuGet\Install-Package Zireael.Net -Version 0.1.0-alpha.6
                    
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="Zireael.Net" Version="0.1.0-alpha.6" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Zireael.Net" Version="0.1.0-alpha.6" />
                    
Directory.Packages.props
<PackageReference Include="Zireael.Net" />
                    
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 Zireael.Net --version 0.1.0-alpha.6
                    
#r "nuget: Zireael.Net, 0.1.0-alpha.6"
                    
#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 Zireael.Net@0.1.0-alpha.6
                    
#: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=Zireael.Net&version=0.1.0-alpha.6&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Zireael.Net&version=0.1.0-alpha.6&prerelease
                    
Install as a Cake Tool

Zireael.Net

Zireael.Net is a .NET binding for the Zireael C engine.

Includes

  • ABI-accurate C# enums and structs for include/zr/*.h
  • P/Invoke bindings for engine/config/metrics/caps/debug APIs
  • Managed ZireaelEngine wrapper with SafeHandle
  • ZrDrawlistBuilder for safe drawlist byte construction (v1)
  • ZrEventBatchReader for safe packed event-batch parsing (v1)

Ergonomic APIs

Build drawlists without manual offsets

var style = new ZrDlStyle
{
    Fg = 0x00FFFFFF,
    Bg = 0x00000000,
    Attrs = 0,
    Reserved0 = 0
};

var builder = new ZrDrawlistBuilder();
builder.Clear();
builder.DrawText(2, 2, "Hello", in style);
var drawlist = builder.Build();

engine.SubmitDrawlist(drawlist);
engine.Present();

Parse event batches safely

var written = engine.PollEvents(timeoutMs, buffer);
if (written > 0)
{
    var batch = new byte[written];
    Buffer.BlockCopy(buffer, 0, batch, 0, written);

    if (ZrEventBatchReader.TryCreate(batch, out var reader))
    {
        foreach (var record in reader!.EnumerateRecords())
        {
            if (record.TryGetKey(out var key))
            {
                // Handle key event
            }
        }
    }
}

Native Dependency

The package requires the native zireael shared library.

  • macOS: libzireael.dylib
  • Linux: libzireael.so
  • Windows: zireael.dll

If runtime assets are not bundled in the package used by your app, provide the library via standard loader paths (PATH, LD_LIBRARY_PATH, DYLD_LIBRARY_PATH) or next to the app executable.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in 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.1.0-alpha.6 98 2/26/2026
0.1.0-alpha.5 74 2/25/2026
0.1.0-alpha.4 76 2/25/2026
0.1.0-alpha.3 70 2/25/2026

Add ergonomic APIs: ZrDrawlistBuilder and ZrEventBatchReader. Improve sample run workflow with one-command setup.