EmbreeSharp 0.6.3

EmbreeSharp

EmbreeSharp is an unofficial C# low-level binding for embree

Provide a tiny safe wrapper in C#

Target framework is net8.0

This project is still under development. API are not stable.

Use

Now target embree version is v4.3.1

Install this package from nuget.

Install the native library package for your platform from nuget. Or, compile embree by yourself and put native library into runtimes/${rid}/native

OS	x64
win
linux
osx

If you are using version 4.3.0. osx-x64 should first install tbb in system.

Directory structure

• EmbreeSharp: source code, tiny safe wrapper also in this dir
  • Native: low-level bindings
• EmbreeSharp.Test: some tests
• Samples: some simple examples
• Script: some scripts to package the official native libraries

Details

About native library

The official only provides binary files for win-x64, linux-x64 and osx-x64. If you want to run on other platforms, you should compile embree by yourself.

Because native libraries uploaded to nuget are separate, everyone can upload their compiled native libraries for others to use.

If you upload your compiled library, you can tell me the package name. I will display it in readme.

The Script folder contains some help scripts to package the official compiled native libraries into the nuget package.

About load native library in C#

Loading native dynamic library of embree is complicated. Because official release depends on TBB. P/Invoke cannot find its path automatically. There is no way to set library search path (as far as I know). So I use System.Runtime.InteropServices.NativeLibrary.SetDllImportResolver to custom loading logic.

Shared Buffer

The memory for shared buffer is managed by user.

Accouding to the API reference: rtcSetSharedGeometryBuffer

The buffer data must remain valid for as long as the buffer may be used, and the user is responsible for freeing the buffer data when no longer required.

This is a lifecycle problem.

Currently, I provide EmbreeSharp.ISharedBufferAllocation as buffer allocator. It ensures that the allocated buffer address is available until it is released. EmbreeSharp.ISharedBufferAllocation as allocate result. It provides the buffer address and length.

The most crucial part is EmbreeSharp.SharedBufferHandle. It inherits from System.Runtime.InteropServices.SafeHandle. The original purpose of SafeHandle was serve as a secure native handle when interop with C API. It has built-in reference counting function. Therefore, here we borrow its reference count function.

SharedBufferHandle is used to manage the lifecycle of ISharedBufferAllocation. For example, pass it to construct EmbreeSharp.EmbreeSharedBuffer. It will increase the reference count. Due to EmbreeSharedBuffer implements the dispose pattern, GC will use finalizer when the user forgets to release it. At the same time decrease the reference count. When the reference count returns to zero, it will free shared buffer

Ideally, it can avoid memory leaks caused by users forgetting to free. But it has not been tested

Limitation

Cannot use all APIs related to SYCL.

TODO

I will provide more safe functions for C# wrapper. But limited by language difference, It is almost impossible to have both performance and safety.

If you have any idea, welcome issues and pull requests

SetGeometry[Intersect/Occluded/Bounds]Function

Just provide safe API

MXCSR control and status register

link

This is x86-64 instruction. C# API does not provide them.

Make a native library and use P/Invoke?

Hmm...maybe we can use OS api. Write binary code to memory and call OS api to set memory as executable such as VirtualProtectEx on win32.

Add more samples

same as title. like path tracer?

License

The copyright of Embree belongs to the Embree development team

This project is under MIT