regenerated documentation

RenderKit · Oct 26, 2021 · d715747 · d715747
1 parent e6b2880
commit d715747
Show file tree

Hide file tree

Showing 7 changed files with 110 additions and 74 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 Version History
 ---------------
 
+### Embree 3.13.2
+-   Avoiding spatial split positions that are slightly out of geometry bounds.
+-   Introduced rtcGetGeometryThreadSafe function, which is a thread safe version of rtcGetGeometry.
+-   Using more accurate rcp implementation.
+-   Bugfix to rare corner case of high quality BVH builder.
+
 ### Embree 3.13.1
 -   Added support for ISPC+ARM.
 -   Releases upgrade to TBB 2021.3.0 and ISPC 1.16.1

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-% Embree: High Performance Ray Tracing Kernels 3.13.1
+% Embree: High Performance Ray Tracing Kernels 3.13.2
 % Intel Corporation
 
 Embree Overview
@@ -79,7 +79,7 @@ Windows MSI Installer
 ---------------------
 
 You can install the Embree library using the Windows MSI installer
-[embree-3.13.1-x64.vc14.msi](https://github.com/embree/embree/releases/download/v3.13.1/embree-3.13.1.x64.vc14.msi). This
+[embree-3.13.2-x64.vc14.msi](https://github.com/embree/embree/releases/download/v3.13.2/embree-3.13.2.x64.vc14.msi). This
 will install the 64-bit Embree version by default in `Program
 Files\Intel\Embree3`.
 
@@ -94,13 +94,13 @@ Files\Intel\Embree3`.
 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.13.1 x64` and uninstall it.
+3.13.2 x64` and uninstall it.
 
 Windows ZIP File
 -----------------
 
 Embree linked against Visual Studio 2015 are provided as a ZIP file
-[embree-3.13.1.x64.vc14.windows.zip](https://github.com/embree/embree/releases/download/v3.13.1/embree-3.13.1.x64.vc14.windows.zip). After
+[embree-3.13.2.x64.vc14.windows.zip](https://github.com/embree/embree/releases/download/v3.13.2/embree-3.13.2.x64.vc14.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
@@ -114,13 +114,13 @@ Linux tar.gz Files
 ------------------
 
 The Linux version of Embree is also delivered as a `tar.gz` file:
-[embree-3.13.1.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v3.13.1/embree-3.13.1.x86_64.linux.tar.gz). Unpack
+[embree-3.13.2.x86_64.linux.tar.gz](https://github.com/embree/embree/releases/download/v3.13.2/embree-3.13.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.13.1.x86_64.linux.tar.gz
-    source embree-3.13.1.x86_64.linux/embree-vars.sh
+    tar xzf embree-3.13.2.x86_64.linux.tar.gz
+    source embree-3.13.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.
@@ -133,7 +133,7 @@ macOS PKG Installer
 
 To install the Embree library on your macOS system use the
 provided package installer inside
-[embree-3.13.1.x86_64.pkg](https://github.com/embree/embree/releases/download/v3.13.1/embree-3.13.1.x86_64.pkg). This
+[embree-3.13.2.x86_64.pkg](https://github.com/embree/embree/releases/download/v3.13.2/embree-3.13.2.x86_64.pkg). 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.
@@ -155,13 +155,13 @@ macOS ZIP file
 -----------------
 
 The macOS version of Embree is also delivered as a ZIP file:
-[embree-3.13.1.x86_64.macosx.zip](https://github.com/embree/embree/releases/download/v3.13.1/embree-3.13.1.x86_64.macosx.zip). Unpack
+[embree-3.13.2.x86_64.macosx.zip](https://github.com/embree/embree/releases/download/v3.13.2/embree-3.13.2.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-3.13.1.x64.macosx.zip
-    source embree-3.13.1.x64.macosx/embree-vars.sh
+    unzip embree-3.13.2.x64.macosx.zip
+    source embree-3.13.2.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
@@ -1851,20 +1851,63 @@ The `rtcGetGeometry` function returns the geometry that is bound to the
 specified geometry ID (`geomID` argument) for the specified scene
 (`scene` argument). This function just looks up the handle and does
 *not* increment the reference count. If you want to get ownership of
-the handle, you need to additionally call `rtcRetainGeometry`. For this
-reason, this function is fast and can be used during rendering.
+the handle, you need to additionally call `rtcRetainGeometry`.
+
+This function is not thread safe and thus can be used during rendering.
 However, it is generally recommended to store the geometry handle
 inside the application's geometry representation and look up the
 geometry handle from that representation directly.
 
+If you need a thread safe version of this function please use
+[rtcGetGeometryThreadSafe].
+
 #### EXIT STATUS {#exit-status}
 
 On failure `NULL` is returned and an error code is set that can be
 queried using `rtcGetDeviceError`.
 
 #### SEE ALSO {#see-also}
 
-[rtcAttachGeometry], [rtcAttachGeometryByID]
+[rtcAttachGeometry], [rtcAttachGeometryByID],
+[rtcGetGeometryThreadSafe]
+
+
+
+rtcGetGeometryThreadSafe
+------------------------
+
+#### NAME {#name}
+
+    rtcGetGeometryThreadSafe - returns the geometry bound to
+      the specified geometry ID
+
+#### SYNOPSIS {#synopsis}
+
+    #include <embree3/rtcore.h>
+
+    RTCGeometry rtcGetGeometryThreadSafe(RTCScene scene, unsigned int geomID);
+
+#### DESCRIPTION {#description}
+
+The `rtcGetGeometryThreadSafe` function returns the geometry that is
+bound to the specified geometry ID (`geomID` argument) for the
+specified scene (`scene` argument). This function just looks up the
+handle and does *not* increment the reference count. If you want to get
+ownership of the handle, you need to additionally call
+`rtcRetainGeometry`.
+
+This function is thread safe and should NOT get used during rendering.
+If you need a fast non-thread safe version during rendering please use
+the [rtcGetGeometry] function.
+
+#### EXIT STATUS {#exit-status}
+
+On failure `NULL` is returned and an error code is set that can be
+queried using `rtcGetDeviceError`.
+
+#### SEE ALSO {#see-also}
+
+[rtcAttachGeometry], [rtcAttachGeometryByID], [rtcGetGeometry]
 
 
 

diff --git a/doc/src/api/rtcGetGeometryTheadSafe.md → doc/src/api/rtcGetGeometryThreadSafe.md b/doc/src/api/rtcGetGeometryTheadSafe.md → doc/src/api/rtcGetGeometryThreadSafe.md
diff --git a/man/man3/rtcGetGeometry.3embree3 b/man/man3/rtcGetGeometry.3embree3
@@ -28,14 +28,18 @@ This function just looks up the handle and does \f[I]not\f[R] increment
 the reference count.
 If you want to get ownership of the handle, you need to additionally
 call \f[C]rtcRetainGeometry\f[R].
-For this reason, this function is fast and can be used during rendering.
+.PP
+This function is not thread safe and thus can be used during rendering.
 However, it is generally recommended to store the geometry handle inside
 the application\[cq]s geometry representation and look up the geometry
 handle from that representation directly.
+.PP
+If you need a thread safe version of this function please use
+[rtcGetGeometryThreadSafe].
 .SS EXIT STATUS
 .PP
 On failure \f[C]NULL\f[R] is returned and an error code is set that can
 be queried using \f[C]rtcGetDeviceError\f[R].
 .SS SEE ALSO
 .PP
-[rtcAttachGeometry], [rtcAttachGeometryByID]
+[rtcAttachGeometry], [rtcAttachGeometryByID], [rtcGetGeometryThreadSafe]
diff --git a/man/man3/rtcGetGeometryThreadSafe.3embree3 b/man/man3/rtcGetGeometryThreadSafe.3embree3
@@ -0,0 +1,41 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "rtcGetGeometryThreadSafe" "3" "" "" "Embree Ray Tracing Kernels 3"
+.hy
+.SS NAME
+.IP
+.nf
+\f[C]
+rtcGetGeometryThreadSafe \- returns the geometry bound to
+  the specified geometry ID
+\f[R]
+.fi
+.SS SYNOPSIS
+.IP
+.nf
+\f[C]
+#include <embree3/rtcore.h>
+
+RTCGeometry rtcGetGeometryThreadSafe(RTCScene scene, unsigned int geomID);
+\f[R]
+.fi
+.SS DESCRIPTION
+.PP
+The \f[C]rtcGetGeometryThreadSafe\f[R] function returns the geometry
+that is bound to the specified geometry ID (\f[C]geomID\f[R] argument)
+for the specified scene (\f[C]scene\f[R] argument).
+This function just looks up the handle and does \f[I]not\f[R] increment
+the reference count.
+If you want to get ownership of the handle, you need to additionally
+call \f[C]rtcRetainGeometry\f[R].
+.PP
+This function is thread safe and should NOT get used during rendering.
+If you need a fast non\-thread safe version during rendering please use
+the [rtcGetGeometry] function.
+.SS EXIT STATUS
+.PP
+On failure \f[C]NULL\f[R] is returned and an error code is set that can
+be queried using \f[C]rtcGetDeviceError\f[R].
+.SS SEE ALSO
+.PP
+[rtcAttachGeometry], [rtcAttachGeometryByID], [rtcGetGeometry]
diff --git a/man/man3/rtcInitPointQueryInstanceStack.3embree3 b/man/man3/rtcInitPointQueryInstanceStack.3embree3
diff --git a/readme.pdf b/readme.pdf