Skip to content

Commit 7662e7b

Browse files
svenwoopsvenwoop
committed
regenerated documentation
1 parent 4a12bfe commit 7662e7b

28 files changed

Lines changed: 626 additions & 160 deletions

‎CHANGELOG.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
Version History
22
---------------
33

4+
### New Features in Embree 3.2.4
5+
- Fixed compile issues with ICC 2019.
6+
- Released ZIP files for Windows are now provided in a
7+
version linked against Visual Studio 2013 and Visual Studio 2015.
8+
49
### New Features in Embree 3.2.3
5-
- Fixed crash when using curves with RTC_SCENE_FLAG_DYNAMIC
10+
- Fixed crash when using curves with RTC_SCENE_FLAG_DYNAMIC
611
combined with RTC_BUILD_QUALITY_MEDIUM.
712

813
### New Features in Embree 3.2.2

‎README.md‎

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Embree: High Performance Ray Tracing Kernels 3.2.3
1+
% Embree: High Performance Ray Tracing Kernels 3.2.4
22
% Intel Corporation
33

44
Embree Overview
@@ -85,33 +85,35 @@ Windows MSI Installer
8585
---------------------
8686

8787
You can install the Embree library using the Windows MSI installer
88-
[embree-3.2.3-x64.msi](https://github.com/embree/embree/releases/download/v3.2.3/embree-3.2.3.x64.msi). This
88+
[embree-3.2.4-x64.vs12.msi](https://github.com/embree/embree/releases/download/v3.2.4/embree-3.2.4.x64.vs12.msi). This
8989
will install the 64-bit Embree version by default in `Program
90-
Files\Intel\Embree v3.2.3 x64`.
90+
Files\Intel\Embree v3.2.4 x64`.
9191

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

9595
To compile applications with Embree using CMake, please have a look at
9696
the `find_embree` tutorial. To compile this tutorial, you need to set
9797
the `embree_DIR` CMake variable of this tutorial to `Program
98-
Files\Intel\Embree v3.2.3 x64`.
98+
Files\Intel\Embree v3.2.4 x64`.
9999

100100
To uninstall Embree, open `Programs and Features` by clicking the
101101
`Start button`, clicking `Control Panel`, clicking `Programs`, and
102102
then clicking `Programs and Features`. Select `Embree
103-
3.2.3 x64` and uninstall it.
103+
3.2.4 x64` and uninstall it.
104104

105105
Windows ZIP File
106106
-----------------
107107

108-
Embree is also delivered as a ZIP file
109-
[embree-3.2.3.x64.windows.zip](https://github.com/embree/embree/releases/download/v3.2.3/embree-3.2.3.x64.windows.zip). After
110-
unpacking this ZIP file, you should set the path to the `lib` folder
111-
manually to your `PATH` environment variable for applications to find
112-
Embree. To compile applications with Embree, you also have to set the
113-
`Include Directories` path in Visual Studio to the `include` folder of
114-
the Embree installation.
108+
Embree linked against Visual Studio 2013
109+
[embree-3.2.4.x64.vs12.windows.zip](https://github.com/embree/embree/releases/download/v3.2.4/embree-3.2.4.x64.vs12.windows.zip)
110+
and Visual Studio 2015
111+
[embree-3.2.4.x64.vs14.windows.zip](https://github.com/embree/embree/releases/download/v3.2.4/embree-3.2.4.x64.vs14.windows.zip)
112+
are provided as a ZIP file. After unpacking this ZIP file, you should
113+
set the path to the `lib` folder manually to your `PATH` environment
114+
variable for applications to find Embree. To compile applications with
115+
Embree, you also have to set the `Include Directories` path in Visual
116+
Studio to the `include` folder of the Embree installation.
115117

116118
If you plan to ship Embree with your application, best use the Embree
117119
version from this ZIP file.
@@ -120,17 +122,17 @@ Linux RPMs
120122
----------
121123

122124
Uncompress the `tar.gz` file
123-
[embree-3.2.3.x86_64.rpm.tar.gz](https://github.com/embree/embree/releases/download/v3.2.3/embree-3.2.3.x86_64.rpm.tar.gz)
125+
[embree-3.2.4.x86_64.rpm.tar.gz](https://github.com/embree/embree/releases/download/v3.2.4/embree-3.2.4.x86_64.rpm.tar.gz)
124126
to obtain the individual RPM files:
125127

126-
tar xzf embree-3.2.3.x86_64.rpm.tar.gz
128+
tar xzf embree-3.2.4.x86_64.rpm.tar.gz
127129

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

131-
sudo rpm --install embree3-lib-3.2.3-1.x86_64.rpm
132-
sudo rpm --install embree3-devel-3.2.3-1.noarch.rpm
133-
sudo rpm --install embree3-examples-3.2.3-1.x86_64.rpm
133+
sudo rpm --install embree3-lib-3.2.4-1.x86_64.rpm
134+
sudo rpm --install embree3-devel-3.2.4-1.noarch.rpm
135+
sudo rpm --install embree3-examples-3.2.4-1.x86_64.rpm
134136

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

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

145-
sudo alien embree3-lib-3.2.3-1.x86_64.rpm
146-
sudo alien embree3-devel-3.2.3-1.noarch.rpm
147-
sudo alien embree3-examples-3.2.3-1.x86_64.rpm
147+
sudo alien embree3-lib-3.2.4-1.x86_64.rpm
148+
sudo alien embree3-devel-3.2.4-1.noarch.rpm
149+
sudo alien embree3-examples-3.2.4-1.x86_64.rpm
148150

149-
sudo dpkg -i embree3-lib_3.2.3-2_amd64.deb
150-
sudo dpkg -i embree3-devel_3.2.3-2_all.deb
151-
sudo dpkg -i embree3-examples_3.2.3-2_amd64.deb
151+
sudo dpkg -i embree3-lib_3.2.4-2_amd64.deb
152+
sudo dpkg -i embree3-devel_3.2.4-2_all.deb
153+
sudo dpkg -i embree3-examples_3.2.4-2_amd64.deb
152154

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

@@ -174,20 +176,20 @@ the tutorials to start them.
174176

175177
To uninstall Embree, just execute the following:
176178

177-
sudo rpm --erase embree3-lib-3.2.3-1.x86_64
178-
sudo rpm --erase embree3-devel-3.2.3-1.noarch
179-
sudo rpm --erase embree3-examples-3.2.3-1.x86_64
179+
sudo rpm --erase embree3-lib-3.2.4-1.x86_64
180+
sudo rpm --erase embree3-devel-3.2.4-1.noarch
181+
sudo rpm --erase embree3-examples-3.2.4-1.x86_64
180182

181183
Linux tar.gz Files
182184
------------------
183185

184186
The Linux version of Embree is also delivered as a `tar.gz` file:
185-
[embree-3.2.3.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v3.2.3/embree-3.2.3.x86_64.linux.tar.gz). Unpack this file using `tar` and source the provided `embree-vars.sh` (if you
187+
[embree-3.2.4.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v3.2.4/embree-3.2.4.x86_64.linux.tar.gz). Unpack this file using `tar` and source the provided `embree-vars.sh` (if you
186188
are using the bash shell) or `embree-vars.csh` (if you are using the
187189
C shell) to set up the environment properly:
188190

189-
tar xzf embree-3.2.3.x86_64.linux.tar.gz
190-
source embree-3.2.3.x86_64.linux/embree-vars.sh
191+
tar xzf embree-3.2.4.x86_64.linux.tar.gz
192+
source embree-3.2.4.x86_64.linux/embree-vars.sh
191193

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

201203
To install the Embree library on your macOS system use the
202204
provided package installer inside
203-
[embree-3.2.3.x86_64.dmg](https://github.com/embree/embree/releases/download/v3.2.3/embree-3.2.3.x86_64.dmg). This
205+
[embree-3.2.4.x86_64.dmg](https://github.com/embree/embree/releases/download/v3.2.4/embree-3.2.4.x86_64.dmg). This
204206
will install Embree by default into `/opt/local/lib` and
205207
`/opt/local/include` directories. The Embree tutorials are installed
206208
into the `/Applications/Embree3` directory.
@@ -222,12 +224,12 @@ macOS tar.gz file
222224
-----------------
223225

224226
The macOS version of Embree is also delivered as a `tar.gz` file:
225-
[embree-3.2.3.x86_64.macosx.tar.gz](https://github.com/embree/embree/releases/download/v3.2.3/embree-3.2.3.x86_64.macosx.tar.gz). Unpack this file using `tar` and source the provided `embree-vars.sh` (if you
227+
[embree-3.2.4.x86_64.macosx.tar.gz](https://github.com/embree/embree/releases/download/v3.2.4/embree-3.2.4.x86_64.macosx.tar.gz). Unpack this file using `tar` and source the provided `embree-vars.sh` (if you
226228
are using the bash shell) or `embree-vars.csh` (if you are using the
227229
C shell) to set up the environment properly:
228230

229-
tar xzf embree-3.2.3.x64.macosx.tar.gz
230-
source embree-3.2.3.x64.macosx/embree-vars.sh
231+
tar xzf embree-3.2.4.x64.macosx.tar.gz
232+
source embree-3.2.4.x64.macosx/embree-vars.sh
231233

232234
If you want to ship Embree with your application, please use the Embree
233235
library of the provided `tar.gz` file. The library name of that Embree

‎doc/src/install.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Windows MSI Installer
55
---------------------
66

77
You can install the Embree library using the Windows MSI installer
8-
[embree-<EMBREE_VERSION>-x64.msi](https://github.com/embree/embree/releases/download/v<EMBREE_VERSION>/embree-<EMBREE_VERSION>.x64.msi). This
8+
[embree-<EMBREE_VERSION>-x64.vs12.msi](https://github.com/embree/embree/releases/download/v<EMBREE_VERSION>/embree-<EMBREE_VERSION>.x64.vs12.msi). This
99
will install the 64-bit Embree version by default in `Program
1010
Files\Intel\Embree v<EMBREE_VERSION> x64`.
1111

@@ -25,13 +25,15 @@ then clicking `Programs and Features`. Select `Embree
2525
Windows ZIP File
2626
-----------------
2727

28-
Embree is also delivered as a ZIP file
29-
[embree-<EMBREE_VERSION>.x64.windows.zip](https://github.com/embree/embree/releases/download/v<EMBREE_VERSION>/embree-<EMBREE_VERSION>.x64.windows.zip). After
30-
unpacking this ZIP file, you should set the path to the `lib` folder
31-
manually to your `PATH` environment variable for applications to find
32-
Embree. To compile applications with Embree, you also have to set the
33-
`Include Directories` path in Visual Studio to the `include` folder of
34-
the Embree installation.
28+
Embree linked against Visual Studio 2013
29+
[embree-<EMBREE_VERSION>.x64.vs12.windows.zip](https://github.com/embree/embree/releases/download/v<EMBREE_VERSION>/embree-<EMBREE_VERSION>.x64.vs12.windows.zip)
30+
and Visual Studio 2015
31+
[embree-<EMBREE_VERSION>.x64.vs14.windows.zip](https://github.com/embree/embree/releases/download/v<EMBREE_VERSION>/embree-<EMBREE_VERSION>.x64.vs14.windows.zip)
32+
are provided as a ZIP file. After unpacking this ZIP file, you should
33+
set the path to the `lib` folder manually to your `PATH` environment
34+
variable for applications to find Embree. To compile applications with
35+
Embree, you also have to set the `Include Directories` path in Visual
36+
Studio to the `include` folder of the Embree installation.
3537

3638
If you plan to ship Embree with your application, best use the Embree
3739
version from this ZIP file.

‎man/man3/RTCRayN.3embree3‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ float&\ RTCRayN_dir_y(RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
2424
float&\ RTCRayN_dir_z(RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
2525
float&\ RTCRayN_time\ (RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
2626

27-
float&\ \ \ \ RTCRayN_tfar\ (RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
28-
unsigned&\ RTCRayN_mask\ (RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
29-
unsigned&\ RTCRayN_id\ \ \ (RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
30-
unsigned&\ RTCRayN_flags(RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
27+
float&\ \ \ \ \ \ \ \ RTCRayN_tfar\ (RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
28+
unsigned\ int&\ RTCRayN_mask\ (RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
29+
unsigned\ int&\ RTCRayN_id\ \ \ (RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
30+
unsigned\ int&\ RTCRayN_flags(RTCRayN*\ ray,\ unsigned\ int\ N,\ unsigned\ int\ i);
3131
\f[]
3232
.fi
3333
.SS DESCRIPTION

0 commit comments

Comments
 (0)