Skip to content

Commit

Permalink
README.
Browse files Browse the repository at this point in the history
  • Loading branch information
virtualritz committed May 1, 2023
1 parent 10710a0 commit 4a09601
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions crates/nsi-core/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# `nsi-core`

This crate implements the high level wrapper around the NSI API and
links against the commercial 3Delight renderer.

The low level wrapper around the C FFI is in the nsi-sys crate.

This crate will likely be deprecated and split into `nsi-traits`
(describing the high level API) and `nsi-3delight` (the actual
implementation linking agains 3Delight).

This will allow different implementations to depend on `nsi-traits`.
For example, there could be an [`nsi-moonray`](https://github.com/dreamworksanimation/openmoonray)
or [`nsi-kajira`](https://github.com/EmbarkStudios/kajiya)
crate.
links against the commercial [3Delight](https://www.3delight.com/) renderer.

The low level wrapper around the C FFI is in the `nsi-sys` crate.

> **Note:** This crate will likely be deprecated and split into `nsi-traits` (describing
the high level API) and `nsi-3delight` (the actual implementation linking
against 3Delight).
>
> This will allow different implementations to depend on `nsi-traits`.
For example, there could be an [`nsi-moonray`](https://github.com/dreamworksanimation/openmoonray)
or [`nsi-kajira`](https://github.com/EmbarkStudios/kajiya)
crate.

0 comments on commit 4a09601

Please sign in to comment.