SDL3-CS 3.4.14

About

SDL3-CS is a C# wrapper for SDL3. The managed SDL3-CS package contains the C# wrapper, while native binaries are published as platform-specific package families.

Package Versions

This package set uses managed version SDL3-CS 3.4.14.0.

Documentation

• SDL3-CS Wiki
• SDL3-CS API Reference
• SDL3 upstream wiki
• GitHub Releases

Supported Platforms

The managed wrapper targets .NET 7, .NET 8, .NET 9, and .NET 10.

Installation

Install the managed wrapper:

dotnet add package SDL3-CS

Add the native package family that matches your target platform. For a Windows desktop app:

dotnet add package SDL3-CS.Windows
dotnet add package SDL3-CS.Windows.Image
dotnet add package SDL3-CS.Windows.TTF
dotnet add package SDL3-CS.Windows.Mixer
dotnet add package SDL3-CS.Windows.Shadercross

Replace Windows with Linux, MacOS, Android, iOS, or tvOS.

Android applications use MainActivity : Org.Libsdl.App.SDLActivity, override GetLibraries(), and run SDL from the managed Main() override.

Managed Main Callbacks

For SDL's callback-based application lifecycle, implement SDL.IMainCallbacks<TSelf> and apply [SDL.GenerateMain] to the partial application class:

using SDL3;

[SDL.GenerateMain]
internal sealed partial class Game : SDL.IMainCallbacks<Game>
{
    public static SDL.AppResult AppInit(out Game? appState, string[] args)
    {
        appState = new Game();
        return SDL.AppResult.Continue;
    }

    public SDL.AppResult AppIterate() => SDL.AppResult.Continue;

    public SDL.AppResult AppEvent(ref SDL.Event @event) =>
        (SDL.EventType)@event.Type == SDL.EventType.Quit
            ? SDL.AppResult.Success
            : SDL.AppResult.Continue;

    public void AppQuit(SDL.AppResult result)
    {
    }
}

SDL3-CS supplies the source generator through the package's analyzer assets. It creates the entry point and delegates to SDL.RunMainCallbacks<TApp>, which owns the managed/native state lifetime and contains managed exceptions until SDL returns control to the caller.

Example

using SDL3;

namespace CreateWindow;

internal static class Program
{
    [STAThread]
    private static void Main()
    {
        if (!SDL.Init(SDL.InitFlags.Video))
        {
            SDL.LogError(SDL.LogCategory.System, $"SDL could not initialize: {SDL.GetError()}");
            return;
        }

        if (!SDL.CreateWindowAndRenderer("SDL3 Create Window", 800, 600, 0, out var window, out var renderer))
        {
            SDL.LogError(SDL.LogCategory.Application, $"Error creating window and renderer: {SDL.GetError()}");
            return;
        }

        SDL.SetRenderDrawColor(renderer, 100, 149, 237, 255);
        SDL.RenderClear(renderer);
        SDL.RenderPresent(renderer);

        SDL.DestroyRenderer(renderer);
        SDL.DestroyWindow(window);
        SDL.Quit();
    }
}

Feedback and Contributions

Open an issue or start a discussion for bugs, ideas, and questions.

See the repository README for the full project overview.