EmbreeSharp 0.3.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package EmbreeSharp --version 0.3.0                
NuGet\Install-Package EmbreeSharp -Version 0.3.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EmbreeSharp" Version="0.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EmbreeSharp --version 0.3.0                
#r "nuget: EmbreeSharp, 0.3.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install EmbreeSharp as a Cake Addin
#addin nuget:?package=EmbreeSharp&version=0.3.0

// Install EmbreeSharp as a Cake Tool
#tool nuget:?package=EmbreeSharp&version=0.3.0                

EmbreeSharp

alternate text is missing from this package README image NuGet

EmbreeSharp is a C# Low-level binding for embree

Target framework is .NET 7

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

Build

Clone this project.

Put the native libraries into the folder. For example, your OS is win11 x64. You should put embree4.dll, tbb12.dll and tbbmalloc.dll into EmbreeSharp\runtimes\win-x64\native

Build command: dotnet build --configuration Release

This project use Github Action. You can check out the build script in .github\workflows\publish.yml for more help

Details

This project use ClangSharp to generate binding code with some tweaks.

Currently clangsharp cannot generate bindings for opaque struct. Like RTCDevice, it's actually struct RTCDeviceTy*. That's ok to use System.IntPtr to to pass parameters. But for type safety, create a C# struct contains a System.IntPtr is the best way.

Loading 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 use System.Runtime.InteropServices.NativeLibrary.SetDllImportResolver to custom loading logic. Now it's only support win, linux and osx.

Known issues

Cannot use rtcBuildBVH on macos

Unit test in EmbreeSharp.Test/TestBvh.cs

Call rtcBuildBVH function on macos will crash if filled RTCBuildArguments correctly. That's OK on win and linux. I don't have a mac so can't debug this issue...

License

MIT

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net7.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.6.5 152 8/4/2024
0.6.4 106 6/15/2024
0.6.3 115 4/25/2024
0.6.2 122 3/13/2024
0.6.1 127 3/12/2024
0.6.0 110 3/12/2024
0.5.0 127 3/9/2024
0.4.1 125 2/19/2024
0.4.0 225 11/29/2023
0.3.0 1,494 4/11/2023
0.2.0 368 4/8/2023
0.2.0-alpha 326 4/7/2023

Safe oop wrappers for subset of embree