SharpAssimp 6.0.6

SharpAssimp

SharpAssimp is a maintained, modern fork of AssimpNet and AssimpNetter, the cross-platform .NET wrapper for the Open Asset Import Library (otherwise known as Assimp), which is a 3D model import-export library.

Introduction

The primary motivation is for this library to power (offline) content pipelines to import and process 3D models into your game engine's internal format, although the wrapper can be used at runtime to enable your users to import custom content. Please see the Assimp website for a full list of supported formats and features. Each version of the managed wrapper tries to maintain parity with the features of the native version.

P/Invoke is used to communicate with the C-API of the native library. The managed assembly is compiled as AnyCpu and the native binaries are loaded dynamically for either 32 or 64 bit x86, as well as ARM64 applications.

The library is split between two parts, a low level and a high level. The intent is to give as much freedom as possible to the developer to work with the native library from managed code.

Low level

• Native methods are exposed via the AssimpLibrary singleton.
• Structures corresponding to unmanaged structures are prefixed with the name Ai and generally contain IntPtrs to the unmanaged data.
• Located in the SharpAssimp.Unmanaged namespace.

High level

• Replicates the native library's C++ API, but in a way that is more familiar to C# developers.
• Marshaling to and from managed memory handled automatically, all you need to worry about is processing your data.
• Located in the SharpAssimp namespace.

Supported Frameworks

The library runs on .NET 9, .NET 8, .NET 6, .NET 4.8.

Supported Platforms

The NuGet package supports the following Operating Systems and Architectures out of the box (located in the runtimes folder, under RID-specific folders):

• Windows
  • x86, x64 (Tested on Windows 10)
• Linux
  • x64, ARM64 (Tested on Ubuntu 24.04 Noble Numbat)
• MacOS
  • x64 (Tested on MacOS 13.7 Ventura), ARM64 (Tested on MacOS 14.7 Sonoma)

You may have to build and provide your own native binaries for a target platform that is not listed. If the library does not support a platform you are targeting, please let us know or contribute an implementation! The logic to dynamically load the native library is abstracted, so new platform implementations can easily be added.

All included binaries are built transparently using GitHub Actions on this fork.

Questions & Contributing

All contributions are welcome! Simply raise an issue or open a pull request with your issue/question or contribution!

Licensing

The library is licensed under the MIT license. This means you're free to modify the source and use the library in whatever way you want, as long as you attribute the original authors. The native library is licensed under the 3-Clause BSD license. Please be kind enough to include the licensing text file (it contains both licenses).