Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
freibold committed Jul 22, 2024
1 parent 1ad1d3c commit 5730b15
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
Version History
---------------

### Embree 4.x.y
### Embree 4.3.3
- Added RTCError RTC_ERROR_LEVEL_ZERO_RAYTRACING_SUPPORT_MISSING which can indicate a GPU driver that is too old or not installed properly.
- Added the API function rtcGetDeviceLastErrorMessage to query additional information about the last RTCError returned by rtcGetDeviceError. This can be used in case device creation failed and a rtcErrorFunction could not be set up for this purpose.
- Added the API function rtcGetErrorString which returns a string representation of a given RTCError error code. This is purely meant for convenient error information reporting on the user application side.
- Performance improvements on GPU for the one level instancing case (RTC_MAX_INSTANCE_LEVEL_COUNT 1).
- Reduced the number of unneccessary GPU-CPU USM back-migrations which can increase build performance for scene with many instances on GPU.
- Started adding public CI tests for streamlining integration of external pull requests.
- Work-around for problem with unsigned Windows binaries.

### Embree 4.3.2
- Embree now uses level zero raytracing extension to build BVH which enables forward-compatibility. On Linux, the package intel-level-zero-gpu-raytracing has to be installed in addition to the other packages listed here [https://dgpu-docs.intel.com/](https://dgpu-docs.intel.com/).
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Embree: High Performance Ray Tracing Kernels 4.3.2
% Embree: High Performance Ray Tracing Kernels 4.3.3
% Intel Corporation

Intel® Embree Overview
Expand Down Expand Up @@ -100,7 +100,7 @@ Windows Installation
--------------------

A pre-built version of Embree for Windows is provided as a ZIP archive
[embree-4.3.2.x64.windows.zip](https://github.com/embree/embree/releases/download/v4.3.2/embree-4.3.2.x64.windows.zip). After
[embree-4.3.3.x64.windows.zip](https://github.com/embree/embree/releases/download/v4.3.3/embree-4.3.3.x64.windows.zip). After
unpacking this ZIP file, you should set the path to the `lib` folder
manually to your `PATH` environment variable for applications to find
Embree.
Expand All @@ -110,13 +110,13 @@ Linux Installation
------------------

A pre-built version of Embree for Linux is provided as a `tar.gz` archive:
[embree-4.3.2.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v4.3.2/embree-4.3.2.x86_64.linux.tar.gz). Unpack
[embree-4.3.3.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v4.3.3/embree-4.3.3.x86_64.linux.tar.gz). Unpack
this file using `tar` and source the provided `embree-vars.sh` (if you
are using the bash shell) or `embree-vars.csh` (if you are using the C
shell) to set up the environment properly:

tar xzf embree-4.3.2.x86_64.linux.tar.gz
source embree-4.3.2.x86_64.linux/embree-vars.sh
tar xzf embree-4.3.3.x86_64.linux.tar.gz
source embree-4.3.3.x86_64.linux/embree-vars.sh

We recommend adding a relative `RPATH` to your application that points
to the location where Embree (and TBB) can be found, e.g. `$ORIGIN/../lib`.
Expand All @@ -126,12 +126,12 @@ macOS Installation
------------------

The macOS version of Embree is also delivered as a ZIP file:
[embree-4.3.2.x86_64.macosx.zip](https://github.com/embree/embree/releases/download/v4.3.2/embree-4.3.2.x86_64.macosx.zip). Unpack
[embree-4.3.3.x86_64.macosx.zip](https://github.com/embree/embree/releases/download/v4.3.3/embree-4.3.3.x86_64.macosx.zip). Unpack
this file using `tar` and source the provided `embree-vars.sh` (if you
are using the bash shell) or `embree-vars.csh` (if you are using the C
shell) to set up the environment properly:

unzip embree-4.3.2.x64.macosx.zip source embree-4.3.2.x64.macosx/embree-vars.sh
unzip embree-4.3.3.x64.macosx.zip source embree-4.3.3.x64.macosx/embree-vars.sh

If you want to ship Embree with your application, please use the Embree
library of the provided ZIP file. The library name of that Embree
Expand All @@ -156,7 +156,7 @@ set the `TBB_DIR` variable to the path containing `TBB-config.cmake` of a local
TBB install, in case you do not have TBB installed globally on your system,
e.g:

cmake -D embree_DIR=path_to_embree_package/lib/cmake/embree-4.3.2/ \
cmake -D embree_DIR=path_to_embree_package/lib/cmake/embree-4.3.3/ \
-D TBB_DIR=path_to_tbb_package/lib/cmake/tbb/ \
..

Expand Down Expand Up @@ -257,7 +257,7 @@ Embree is released with a bundle of tests in an optional testing package.
To run these tests extract the testing package in the same folder as your embree installation.
e.g.:

tar -xzf embree-4.3.2-testing.zip -C /path/to/installed/embree
tar -xzf embree-4.3.3-testing.zip -C /path/to/installed/embree

The tests are extracted into a new folder inside you embree installation and can be run with:

Expand Down
Binary file modified readme.pdf
Binary file not shown.
4 changes: 2 additions & 2 deletions tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ the Embree and TBB installation on your system.
-D CMAKE_CXX_COMPILER=clang++
-D CMAKE_C_COMPILER=clang
-D CMAKE_BUILD_TYPE=Release
-D embree_DIR=%cd%\..\..\..\lib\cmake\embree-4.3.2\
-D embree_DIR=%cd%\..\..\..\lib\cmake\embree-4.3.3\
-D TBB_DIR=path_to_tbb\oneapi-tbb-2021.2.0\lib\cmake\tbb ..

Now you can build the tutorial:
Expand Down Expand Up @@ -91,7 +91,7 @@ the Embree and TBB installation on your system.
cmake -D CMAKE_BUILD_TYPE=Release \
-D CMAKE_CXX_COMPILER=clang++ \
-D CMAKE_C_COMPILER=clang \
-D embree_DIR=`pwd`/../../../lib/cmake/embree-4.3.2/ \
-D embree_DIR=`pwd`/../../../lib/cmake/embree-4.3.3/ \
-D TBB_DIR=path_to_tbb/oneapi-tbb-2021.2.0/lib/cmake/tbb/ ..

Now you can build the tutorial:
Expand Down

0 comments on commit 5730b15

Please sign in to comment.