Isojk.Csglfw 1.0.0-x64

Low-level C# bindings for the GLFW library, version 3.4.

This library utilizes modern language and compiler features (like Function Pointers or P/Invoke source generator) and therefore requires .NET 8 as the minimum target framework version.

All types, constants and methods have exactly the same name as their native counterparts.

Static Linking

This library supports linking native dependencies statically into the target application, enabling to deploy single self-contained native executable.

This feature is available only when the target application is published using Native AOT deployment model in Release configuration.

To enable this feature for a project referencing this library as a PackageReference (e.g. installed with NuGet package manager), a property GLFWEnableStaticBuild with a value set to true must be defined in the project configuration of the target application:

<PropertyGroup>
    <GLFWEnableStaticBuild>true</GLFWEnableStaticBuild>
</PropertyGroup>

Everything else should be managed by the package automagically.

If this library is instead referenced as a ProjectReference (as a local project in Visual Studio) two additional steps must be taken:

1. An AdditionalProperties attribute must be defined in the ProjectReference in order to propagate the GLFWEnableStaticBuild property, like this:

   <ProjectReference Include="..\..\csglfw\Isojk.Csglfw.csproj" AdditionalProperties="GLFWEnableStaticBuild=$(GLFWEnableStaticBuild)" />
   

2. All required properties and targets from the buildTransitive directory must be imported at the end of the project configuration, like this:

   <Import Project="..\..\csglfw\buildTransitive\Isojk.Csglfw.props" />
   <Import Project="..\..\csglfw\buildTransitive\Isojk.Csglfw.targets" />
   

Supported Platforms

WSL

If you encounter issues on Windows Subsystem for Linux, try to set the platform to X11 manually as a quick fix, like so:

glfwInitHint(GLFW_PLATFORM, GLFW_PLATFORM_X11);

if (!glfwInit()) {
    return;
}

// ...

Basic Example

using static Isojk.Csglfw.API;

GLFWwindow window = default;

if (!glfwInit()) {
    return;
}

try {
    window = glfwCreateWindow(1280, 800, "Hello world");
    if (!window) {
        glfwTerminate();
        return;
    }

    glfwSetKeyCallback(window, (window, key, scancode, action, mods) => {
        if (key == GLFW_KEY_ESCAPE && action == GLFW_PRESS) {
            glfwSetWindowShouldClose(window, true);
        }
    });

    while (!glfwWindowShouldClose(window)) {
        glfwWaitEvents();
    }
}
finally {
    if (window) {
        glfwDestroyWindow(window);
    }

    glfwTerminate();
}

An Example with Function Pointers

using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

using static Isojk.Csglfw.API;

GLFWwindow window = default;

if (!glfwInit()) {
    return;
}

try {
    window = glfwCreateWindow(1280, 800, "Hello world");
    if (!window) {
        glfwTerminate();
        return;
    }

    unsafe {
        Isojk.Csglfw.API.Unsafe.glfwSetKeyCallback(window, &KeyCallback);
    }

    while (!glfwWindowShouldClose(window)) {
        glfwWaitEvents();
    }
}
finally {
    if (window) {
        glfwDestroyWindow(window);
    }

    glfwTerminate();
}

[UnmanagedCallersOnly(CallConvs = new System.Type[] {typeof(CallConvCdecl)})]
static unsafe void KeyCallback(GLFWwindow window, int key, int scancode, int action, int mods) {
    if (key == GLFW_KEY_ESCAPE && action == GLFW_PRESS) {
        glfwSetWindowShouldClose(window, true);
    }
}