DanM.GlslOptimizer 1.1.0

DanM.GlslOptimizer

.NET bindings for glsl-optimizer, the GLSL optimizing compiler originally from Mesa and maintained by Unity. Native binaries for Windows, Linux and macOS ship inside the package, so there is nothing to build or install separately.

Install

dotnet add package DanM.GlslOptimizer

Usage

Wrappers are exposed in static class GlslShader. These wrappers throw GlslOptimizerException (with glsl-optimizer error details) in case of failure:

using DanM.GlslOptimizer;

_ = GlslShader.Optimize(GlslTarget.OpenGL, GlslShaderType.Vertex, shaderSource, GlslOptimizeOptions.None);
_ = GlslShader.OptimizeOpenGL(GlslShaderType.Fragment, shaderSource, GlslOptimizeOptions.SkipPreprocessor);
_ = GlslShader.OptimizeOpenGLFragment(shaderSource, GlslOptimizeOptions.NotFullShader);
_ = GlslShader.OptimizeOpenGLVertex(shaderSource);

// More wrappers for GLES20, GLES30, Metal.

Or, more explicit:

using DanM.GlslOptimizer;

using var ctx = new GlslOptimizerContext(GlslTarget.OpenGL);
using var shader = ctx.Optimize(
    GlslShaderType.Fragment,
    "void main() { float x = 1.0 + 2.0; gl_FragColor = vec4(x, 0.0, 0.0, 1.0); }");

if (shader.Status) // success?
    Console.WriteLine(shader.Output); // optimized output
else
    Console.WriteLine(shader.Log); // error details

Output:

void main ()
{
  vec4 tmpvar_1;
  tmpvar_1.yzw = vec3(0.0, 0.0, 1.0);
  tmpvar_1.x = 3.0;
  gl_FragColor = tmpvar_1;
}

GlslOptimizerContext and OptimizedShader both own native handles, so dispose them (using) rather than leaving them to the finalizer.

How it works

aras-p/glsl-optimizer was taken and its CMakeLists.txt stripped to only build the static library. glsl_optimizer is linked to glslopt_dll, the dynamic library shipped with this project. The .NET library P/Invokes into that.

The dynamic library's code is in src/. The stripped CMakeLists.txt is in the root of the repo.

Supported platforms

As of now, I compiled these binaries manually in Release for all platforms on Windows, Ubuntu, and a Mac. There are no automated build scripts, contributions welcome.

There is currently no win-arm64 or linux-musl-x64/arm64 (Alpine) binary. If you make an issue specifically for those I might find time to compile them. I will not merge PRs containing binaries. If you want to contribute to the binaries, make an automated build step for them.

You are of course free to clone and build them yourself for your own use. Use the CMakeLists.txt in this repository or the one from glsl-optimizer and then link glsl_optimizer to a shared library that compiles src/interface.cpp to create the dynamic lib. See Native.cs for calling the DLL from managed code.

AI disclosure

AI (Opus 5) was used write the NuGet publishing pipeline (GitHub Actions and some .csproj editing), parts of this README, and the interface.h DLL_EXPORT define (the boring stuff).

License

MIT. The bundled native binaries are built from glsl-optimizer, which is also MIT licensed (Brian Paul; Unity Technologies) — see LICENSE.