TinyEXR.NET 0.1.0

TinyEXR.NET

TinyEXR.NET is a C# wrapper of single header-only C++ library tinyexr

tinyexr is a portable single header-only C++ library to load and save OpenEXR (.exr) images

The target framework of TinyEXR.NET is .NET Standard 2.1

The goal of this library is easy to use. Therefore, API is very simple (not flexible).

Download

TinyEXR.NET can be found on NuGet (← click it !)

Supported Platforms

Key:

• ✅: completed
• 🚧: work in progress
• ⌛: planned, not yet started
• ❌: no plan

Unlisted platforms are also unplanned.

But you can contribute to support any other platform! 😃

Usage

Load from file

ResultType loadResult = OpenExr.Load(@"D:\hello.exr", out float[] rgba, out var w, out var h);

rgba format is: float x RGBA x width x hight

Save to file

float[] rgb = new float[w * h * 3];
ResultType saveResult = OpenExr.Save(rgb, w, h, 3, false, @"D:\hello.exr");

image image format is: float x width x height, or float x RGB(A) x width x hight

components must be 1(Grayscale), 3(RGB) or 4(RGBA).

Development build

Windows

0. Requirements

• MSVC that supported C++11 (recommend VS2019 or higher)
• Powershell (>= 3.0)
• CMake (>= 3.0.0)
• .NET SDK x64 (>= .NET Core 3.0)

1. Download the code

First, clone this project or download the latest release and unzip.

2. Build native library

Run build_win-x64.ps1

3. Finish

Finally, we can find NuGet package in TinyEXR.NET\bin\Release. You can use it anywhere

Details

Although tinyexr provides C interface, the MSVC compiler does not export any symbols by default.

So we have to create a C++ project in the folder native to wrap tinyexr API.

I don't know if there is any better way. But it works. 😃

The reason why we only support x64 platform is that I don't know whether the existing code will work properly if we support x86 or other platforms. Specifically, Is the struct layout at C++ side consistent with C# side? I don't have time to solve this problem at present. So I just give up these platform.

Contribution is welcome!

License

TinyEXR.NET is under MIT license

and wrapped C++ lib tinyexr is under 3-clause BSD