This repository contains the source for the ANARI API SDK. This includes:
- Front-end library + implementation guide
- Device implementation utilties for implementations
- Example device implementation (not intended for production use)
- Example applications
- Interactive sample viewer
- Render tests
The 1.0 ANARI specification can be found on the Khronos website here.
The SDK is tested on Linux, but is also intended to be usable on other operating systems such as macOS and Windows.
If you find any problems with the SDK, please do not hesitate to open an issue on this project!
The ANARI-SDK is available as the anari package in
vcpkg. Simply follow these
instructions for setting up your
environment to use vcpkg, then run the following to get ANARI:
% vcpkg install anariThe repository uses CMake 3.11+ to build the library, example implementation, sample apps, and tests. For example, to build (must be in a separate directory from the source directory), you can do:
% cd /path/to/anari
% mkdir build
% cd build
% cmake ..Using a tool like ccmake or cmake-gui will let you see which options are
available to enable. The following CMake options are offered:
BUILD_SHARED_LIBS: build everything as shared libraries or static librariesBUILD_CTS: build the conformance test suiteBUILD_TESTING: build unit and regression test binariesBUILD_HELIDE_DEVICE: build the provided examplehelidedevice implementationBUILD_REMOTE_DEVICE: build the provided experimentalremotedevice implementationBUILD_EXAMPLES: build example applicationsBUILD_VIEWER: build viewer too (needs glfw3) if building examples
Once built, the library can be installed via the install target created by
CMake. This can be invoked from your build directory with (on any platform):
% cmake --build . -t installThe ANARI SDK exports CMake targets for the main front-end library and utilities helper library. The targets which are exported are as follows:
anari::anari: main library target to link withlibanarianari::helium: (static) library target containing base device implementation abstractions
These targets can be found with CMake via find_package(anari). The examples
are written such that they can be built stand alone from the SDK source tree.
The simplest usage can be found here.
The follwoing additional helper library components can be requested by listing
them under find_pacakge(anari):
viewer: Source library targetanari::anari_viewerfor building small viewer appscode_gen: Enable the use of code generation CMake functions downstream
Both of these libraries are both optionally installed and are not available
to downstream projects unless they are explicitly requested. To request one of
these components, simply add them to the COMPONENTS portion of find_package:
find_package(anari COMPONENTS viewer code_gen)The basic tutorial app (built by default) uses the helide device as an
example, which can be run with:
% ./anariTutorialNote that running the tutorial will require that the helide device is enabled
in your build with the CMake option BUILD_HELIDE_DEVICE=ON.
The viewer application (enabled with BUILD_VIEWER=ON) by default uses the
environment library, which reads ANARI_LIBRARY as an environment variable to
get the library to load. For example it can be run with:
% export ANARI_LIBRARY=helide
% ./anariViewerAlternatively, either --library or -l can be used on the viewer's command
line to override the ANARI library to be loaded.
The regression test binary (anariRenderTests) used to render the test scenes
without a window (results saved out as PNG images) uses the same mechanisms as
the viewer to select/override which library is loaded at runtime.
An example device implementation helide is provided as a starting point for users exploring the SDK and for implementors to see how the API might be implemented. It implements a very simple, geometry-only ray tracing implementation using Embree for intersection. Users should look to use vendor provided, hardware-optimized ANARI implementations which are shipped independently from the SDK. (see below)
Below is a list of available ANARI implemenations compatible with this SDK:
- AMD RadeonProRender
- Barney (experimental MPI distributed renderer)
- Intel OSPRay
- NVIDIA USD
- NVIDIA VisRTX + VisGL
- Visionaray
If you implement a backend to the ANARI SDK, please open a PR to add it to this list!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent