Skip to content

Commit

Permalink
regenerated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
svenwoop committed Oct 5, 2018
1 parent 140c5c5 commit dac0fa9
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 28 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Version History
---------------

### New Features in Embree 3.2.2
- Fixed intersection distance for unnormalized rays with line segments.
- Removed libmmd.dll depdendency
- Fixed detection of AppleClang compiler under MacOSX.

### New Features in Embree 3.2.1
- Bugfix in flat mode for hermite curves.
- Added EMBREE_CURVE_SELF_INTERSECTION_AVOIDANCE_FACTOR cmake option to
Expand Down
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Embree: High Performance Ray Tracing Kernels 3.2.1
% Embree: High Performance Ray Tracing Kernels 3.2.2
% Intel Corporation

Embree Overview
Expand Down Expand Up @@ -85,28 +85,28 @@ Windows MSI Installer
---------------------

You can install the Embree library using the Windows MSI installer
[embree-3.2.1-x64.msi](https://github.com/embree/embree/releases/download/v3.2.1/embree-3.2.1.x64.msi). This
[embree-3.2.2-x64.msi](https://github.com/embree/embree/releases/download/v3.2.2/embree-3.2.2.x64.msi). This
will install the 64-bit Embree version by default in `Program
Files\Intel\Embree v3.2.1 x64`.
Files\Intel\Embree v3.2.2 x64`.

You have to set the path to the `bin` folders manually to your `PATH`
environment variable for applications to find Embree.

To compile applications with Embree using CMake, please have a look at
the `find_embree` tutorial. To compile this tutorial, you need to set
the `embree_DIR` CMake variable of this tutorial to `Program
Files\Intel\Embree v3.2.1 x64`.
Files\Intel\Embree v3.2.2 x64`.

To uninstall Embree, open `Programs and Features` by clicking the
`Start button`, clicking `Control Panel`, clicking `Programs`, and
then clicking `Programs and Features`. Select `Embree
3.2.1 x64` and uninstall it.
3.2.2 x64` and uninstall it.

Windows ZIP File
-----------------

Embree is also delivered as a ZIP file
[embree-3.2.1.x64.windows.zip](https://github.com/embree/embree/releases/download/v3.2.1/embree-3.2.1.x64.windows.zip). After
[embree-3.2.2.x64.windows.zip](https://github.com/embree/embree/releases/download/v3.2.2/embree-3.2.2.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. To compile applications with Embree, you also have to set the
Expand All @@ -120,17 +120,17 @@ Linux RPMs
----------

Uncompress the `tar.gz` file
[embree-3.2.1.x86_64.rpm.tar.gz](https://github.com/embree/embree/releases/download/v3.2.1/embree-3.2.1.x86_64.rpm.tar.gz)
[embree-3.2.2.x86_64.rpm.tar.gz](https://github.com/embree/embree/releases/download/v3.2.2/embree-3.2.2.x86_64.rpm.tar.gz)
to obtain the individual RPM files:

tar xzf embree-3.2.1.x86_64.rpm.tar.gz
tar xzf embree-3.2.2.x86_64.rpm.tar.gz

To install Embree using the RPM packages on your Linux system, type
the following:

sudo rpm --install embree3-lib-3.2.1-1.x86_64.rpm
sudo rpm --install embree3-devel-3.2.1-1.noarch.rpm
sudo rpm --install embree3-examples-3.2.1-1.x86_64.rpm
sudo rpm --install embree3-lib-3.2.2-1.x86_64.rpm
sudo rpm --install embree3-devel-3.2.2-1.noarch.rpm
sudo rpm --install embree3-examples-3.2.2-1.x86_64.rpm

You also have to install the Intel® Threading Building Blocks (TBB)
using `yum`:
Expand All @@ -142,13 +142,13 @@ filed into DEB files using the `alien` tool:

sudo apt-get install alien dpkg-dev debhelper build-essential

sudo alien embree3-lib-3.2.1-1.x86_64.rpm
sudo alien embree3-devel-3.2.1-1.noarch.rpm
sudo alien embree3-examples-3.2.1-1.x86_64.rpm
sudo alien embree3-lib-3.2.2-1.x86_64.rpm
sudo alien embree3-devel-3.2.2-1.noarch.rpm
sudo alien embree3-examples-3.2.2-1.x86_64.rpm

sudo dpkg -i embree3-lib_3.2.1-2_amd64.deb
sudo dpkg -i embree3-devel_3.2.1-2_all.deb
sudo dpkg -i embree3-examples_3.2.1-2_amd64.deb
sudo dpkg -i embree3-lib_3.2.2-2_amd64.deb
sudo dpkg -i embree3-devel_3.2.2-2_all.deb
sudo dpkg -i embree3-examples_3.2.2-2_amd64.deb

Also install the Intel® Threading Building Blocks (TBB) using `apt-get`:

Expand All @@ -174,20 +174,20 @@ the tutorials to start them.

To uninstall Embree, just execute the following:

sudo rpm --erase embree3-lib-3.2.1-1.x86_64
sudo rpm --erase embree3-devel-3.2.1-1.noarch
sudo rpm --erase embree3-examples-3.2.1-1.x86_64
sudo rpm --erase embree3-lib-3.2.2-1.x86_64
sudo rpm --erase embree3-devel-3.2.2-1.noarch
sudo rpm --erase embree3-examples-3.2.2-1.x86_64

Linux tar.gz Files
------------------

The Linux version of Embree is also delivered as a `tar.gz` file:
[embree-3.2.1.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v3.2.1/embree-3.2.1.x86_64.linux.tar.gz). Unpack this file using `tar` and source the provided `embree-vars.sh` (if you
[embree-3.2.2.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v3.2.2/embree-3.2.2.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-3.2.1.x86_64.linux.tar.gz
source embree-3.2.1.x86_64.linux/embree-vars.sh
tar xzf embree-3.2.2.x86_64.linux.tar.gz
source embree-3.2.2.x86_64.linux/embree-vars.sh

If you want to ship Embree with your application, best use the Embree
version provided in the `tar.gz` file.
Expand All @@ -200,7 +200,7 @@ macOS PKG Installer

To install the Embree library on your macOS system use the
provided package installer inside
[embree-3.2.1.x86_64.dmg](https://github.com/embree/embree/releases/download/v3.2.1/embree-3.2.1.x86_64.dmg). This
[embree-3.2.2.x86_64.dmg](https://github.com/embree/embree/releases/download/v3.2.2/embree-3.2.2.x86_64.dmg). This
will install Embree by default into `/opt/local/lib` and
`/opt/local/include` directories. The Embree tutorials are installed
into the `/Applications/Embree3` directory.
Expand All @@ -222,12 +222,12 @@ macOS tar.gz file
-----------------

The macOS version of Embree is also delivered as a `tar.gz` file:
[embree-3.2.1.x86_64.macosx.tar.gz](https://github.com/embree/embree/releases/download/v3.2.1/embree-3.2.1.x86_64.macosx.tar.gz). Unpack this file using `tar` and source the provided `embree-vars.sh` (if you
[embree-3.2.2.x86_64.macosx.tar.gz](https://github.com/embree/embree/releases/download/v3.2.2/embree-3.2.2.x86_64.macosx.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-3.2.1.x64.macosx.tar.gz
source embree-3.2.1.x64.macosx/embree-vars.sh
tar xzf embree-3.2.2.x64.macosx.tar.gz
source embree-3.2.2.x64.macosx/embree-vars.sh

If you want to ship Embree with your application, please use the Embree
library of the provided `tar.gz` file. The library name of that Embree
Expand Down Expand Up @@ -1717,7 +1717,7 @@ The initialization string for the Embree device (`rtcNewDevice` call)
can be passed to the ray tracing core through the `--rtcore` command
line parameter, e.g.:

./triangle_geometry --rtcore verbose=2,threads=1,accel=bvh4.triangle1
./triangle_geometry --rtcore verbose=2,threads=1

The navigation in the interactive display mode follows the camera orbit
model, where the camera revolves around the current center of interest.
Expand Down
Binary file modified readme.pdf
Binary file not shown.

0 comments on commit dac0fa9

Please sign in to comment.