update doc

Author: dopitz

CHANGELOG.md

@@ -1,12 +1,20 @@
 Version History
 ---------------
 
+### Embree 4.4
+
+-  Added support for passing geometry data to Embree using explicit host and SYCL device memory (see `rtcSetSharedGeometryBufferHostDevice`, `rtcNewBufferHostDevice`, and other API calls with `HostDevice` suffix).
+-  Embree does not use SYCL shared memory anymore internally on systems without host unified memory (i.e., discrete GPUs). Therefore, memory transfers are triggered by specific Embree API calls (e.g. `rtcCommitScene`, `rtcCommitBuffer`).
+-  Objects of type `RTCScene` are not accessible on a SYCL device anymore. Ray queries on SYCL devices must be performed using `RTCTraversable` objects and the `rtcTraversableIntersect` and `rtcTraversableOccluded` API calls.
+-  Embree does not query the availability of RDRAND for its ISA detection anymore, which caused issues on some older AMD CPUs.
+-  Performance improvements on GPU for the two level instancing case (RTC_MAX_INSTANCE_LEVEL_COUNT 2).
+
 ### 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.
+-   Reduced the number of unnecessary 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.
 
@@ -27,7 +35,7 @@ Version History
 -   Known issue: Embree build using Apple Clang 15 and ARM support (via the SEE2NEON library) may cause "EXEC_BAD_INSTRUCTION" runtime exceptions. Please use Apple Clang <= 14 on macOS.
 
 ### Embree 4.3.0
--   Added instance array primitive for reducing memony requirements in scenes
+-   Added instance array primitive for reducing memory requirements in scenes
     with large amounts of similar instances.
 -   Properly checks driver if L0 RTAS extension can get loaded.
 -   Added varying version of rtcGetGeometryTransform for ISPC.

README.md

@@ -1,5 +1,19 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
 .TH "RTCBufferType" "3" "" "" "Embree Ray Tracing Kernels 4"
 .hy
 .SS NAME
@@ -42,39 +56,39 @@ enum RTCBufferType
 .fi
 .SS DESCRIPTION
 .PP
-The \f[C]RTBufferType\f[R] structure defines slots to assign data
+The \f[V]RTBufferType\f[R] structure defines slots to assign data
 buffers to using the [rtcSetGeometryBuffer],
 [rtcSetSharedGeometryBuffer], and [rtcSetNewGeometryBuffer] API calls.
 .PP
-For most geometry types the \f[C]RTC_BUFFER_TYPE_INDEX\f[R] slot is used
-to assign an index buffer, while the \f[C]RTC_BUFFER_TYPE_VERTEX\f[R] is
+For most geometry types the \f[V]RTC_BUFFER_TYPE_INDEX\f[R] slot is used
+to assign an index buffer, while the \f[V]RTC_BUFFER_TYPE_VERTEX\f[R] is
 used to assign the corresponding vertex buffer.
 .PP
-The \f[C]RTC_BUFFER_TYPE_VERTEX_ATTRIBUTE\f[R] slot can get used to
+The \f[V]RTC_BUFFER_TYPE_VERTEX_ATTRIBUTE\f[R] slot can get used to
 assign arbitrary additional vertex data which can get interpolated using
 the [rtcInterpolate] API call.
 .PP
-The \f[C]RTC_BUFFER_TYPE_NORMAL\f[R], \f[C]RTC_BUFFER_TYPE_TANGENT\f[R],
-and \f[C]RTC_BUFFER_TYPE_NORMAL_DERIVATIVE\f[R] are special buffers
+The \f[V]RTC_BUFFER_TYPE_NORMAL\f[R], \f[V]RTC_BUFFER_TYPE_TANGENT\f[R],
+and \f[V]RTC_BUFFER_TYPE_NORMAL_DERIVATIVE\f[R] are special buffers
 required to assign per vertex normals, tangents, and normal derivatives
 for some curve types.
 .PP
-The \f[C]RTC_BUFFER_TYPE_GRID\f[R] buffer is used to assign the grid
+The \f[V]RTC_BUFFER_TYPE_GRID\f[R] buffer is used to assign the grid
 primitive buffer for grid geometries (see [RTC_GEOMETRY_TYPE_GRID]).
 .PP
-The \f[C]RTC_BUFFER_TYPE_FACE\f[R], \f[C]RTC_BUFFER_TYPE_LEVEL\f[R],
-\f[C]RTC_BUFFER_TYPE_EDGE_CREASE_INDEX\f[R],
-\f[C]RTC_BUFFER_TYPE_EDGE_CREASE_WEIGHT\f[R],
-\f[C]RTC_BUFFER_TYPE_VERTEX_CREASE_INDEX\f[R],
-\f[C]RTC_BUFFER_TYPE_VERTEX_CREASE_WEIGHT\f[R], and
-\f[C]RTC_BUFFER_TYPE_HOLE\f[R] are special buffers required to create
+The \f[V]RTC_BUFFER_TYPE_FACE\f[R], \f[V]RTC_BUFFER_TYPE_LEVEL\f[R],
+\f[V]RTC_BUFFER_TYPE_EDGE_CREASE_INDEX\f[R],
+\f[V]RTC_BUFFER_TYPE_EDGE_CREASE_WEIGHT\f[R],
+\f[V]RTC_BUFFER_TYPE_VERTEX_CREASE_INDEX\f[R],
+\f[V]RTC_BUFFER_TYPE_VERTEX_CREASE_WEIGHT\f[R], and
+\f[V]RTC_BUFFER_TYPE_HOLE\f[R] are special buffers required to create
 subdivision meshes (see [RTC_GEOMETRY_TYPE_SUBDIVISION]).
 .PP
-The \f[C]RTC_BUFFER_TYPE_TRANSFORM\f[R] buffer is used to provide
+The \f[V]RTC_BUFFER_TYPE_TRANSFORM\f[R] buffer is used to provide
 instance transformation information for instance array geometries (see
 [RTC_GEOMETRY_TYPE_INSTANCE_ARRAY]).
 .PP
-The \f[C]RTC_BUFFER_TYPE_FLAGS\f[R] can get used to add additional flag
+The \f[V]RTC_BUFFER_TYPE_FLAGS\f[R] can get used to add additional flag
 per primitive of a geometry, and is currently only used for linear
 curves.
 .SS EXIT STATUS

man/man3/RTCBufferType.4embree4

@@ -1,5 +1,19 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
 .TH "RTCCurveFlags" "3" "" "" "Embree Ray Tracing Kernels 4"
 .hy
 .SS NAME

man/man3/RTCCurveFlags.4embree4

@@ -1,5 +1,19 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
 .TH "RTCFeatureFlags" "3" "" "" "Embree Ray Tracing Kernels 4"
 .hy
 .SS NAME
@@ -80,23 +94,23 @@ enum RTCFeatureFlags
 .fi
 .SS DESCRIPTION
 .PP
-The \f[C]RTCFeatureFlags\f[R] enum specify a bit mask to enable specific
+The \f[V]RTCFeatureFlags\f[R] enum specify a bit mask to enable specific
 ray tracing features for ray query operations.
-The feature flags are passed to the \f[C]rtcIntersect1/4/8/16\f[R] and
-\f[C]rtcOccluded1/4/8/16\f[R] functions through the
-\f[C]RTCIntersectArguments\f[R] and \f[C]RTCOccludedArguments\f[R]
+The feature flags are passed to the \f[V]rtcIntersect1/4/8/16\f[R] and
+\f[V]rtcOccluded1/4/8/16\f[R] functions through the
+\f[V]RTCIntersectArguments\f[R] and \f[V]RTCOccludedArguments\f[R]
 structures.
 Only a ray tracing feature whose bit is enabled in the feature mask can
 get used.
 If a feature bit is not set, the behaviour is undefined, thus the
 feature may work or not.
 To enable multiple features the respective features have to get combined
-using a bitwise \f[C]OR\f[R] operation.
+using a bitwise \f[V]OR\f[R] operation.
 .PP
 The purpose of feature flags is to reduce code size on the GPU by
 enabling just the features required to render the scene.
 On the CPU there is no need to use feature flags, and the default of all
-features enabled (\f[C]RTC_FEATURE_FLAG_ALL\f[R]) can just be kept.
+features enabled (\f[V]RTC_FEATURE_FLAG_ALL\f[R]) can just be kept.
 .PP
 The following features can get enabled using feature flags:
 .IP \[bu] 2
@@ -131,7 +145,7 @@ curves (RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_XXX_CURVE).
 RTC_FEATURE_FLAG_LINEAR_CURVES: Enables all linear curves
 (RTC_GEOMETRY_TYPE_XXX_LINEAR_CURVE).
 .IP \[bu] 2
-RTC_FEATURE_FLAG_BEZIER_CURVES: Enables all B\['e]zier curves
+RTC_FEATURE_FLAG_BEZIER_CURVES: Enables all Bézier curves
 (RTC_GEOMETRY_TYPE_XXX_BEZIER_CURVE).
 .IP \[bu] 2
 RTC_FEATURE_FLAG_BSPLINE_CURVES: Enables all B-spline curves
@@ -149,14 +163,14 @@ RTC_FEATURE_FLAG_ROUND_LINEAR_CURVE: Enables round linear curves
 RTC_FEATURE_FLAG_FLAT_LINEAR_CURVE: Enables flat linear curves
 (RTC_GEOMETRY_TYPE_FLAT_LINEAR_CURVE).
 .IP \[bu] 2
-RTC_FEATURE_FLAG_ROUND_BEZIER_CURVE: Enables round B\['e]zier curves
+RTC_FEATURE_FLAG_ROUND_BEZIER_CURVE: Enables round Bézier curves
 (RTC_GEOMETRY_TYPE_ROUND_BEZIER_CURVE).
 .IP \[bu] 2
-RTC_FEATURE_FLAG_FLAT_BEZIER_CURVE: Enables flat B\['e]zier curves
+RTC_FEATURE_FLAG_FLAT_BEZIER_CURVE: Enables flat Bézier curves
 (RTC_GEOMETRY_TYPE_FLAT_BEZIER_CURVE).
 .IP \[bu] 2
 RTC_FEATURE_FLAG_NORMAL_ORIENTED_BEZIER_CURVE: Enables normal oriented
-B\['e]zier curves (RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_BEZIER_CURVE).
+Bézier curves (RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_BEZIER_CURVE).
 .IP \[bu] 2
 RTC_FEATURE_FLAG_ROUND_BSPLINE_CURVE: Enables round B-spline curves
 (RTC_GEOMETRY_TYPE_ROUND_BSPLINE_CURVE).

man/man3/RTCFeatureFlags.4embree4

@@ -1,5 +1,19 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
 .TH "RTCFormat" "3" "" "" "Embree Ray Tracing Kernels 4"
 .hy
 .SS NAME
@@ -53,38 +67,38 @@ enum RTCFormat
 .fi
 .SS DESCRIPTION
 .PP
-The \f[C]RTFormat\f[R] structure defines the data format stored in data
+The \f[V]RTFormat\f[R] structure defines the data format stored in data
 buffers provided to Embree using the [rtcSetGeometryBuffer],
 [rtcSetSharedGeometryBuffer], and [rtcSetNewGeometryBuffer] API calls.
 .PP
-The \f[C]RTC_FORMAT_UINT/2/3/4\f[R] format are used to specify that data
+The \f[V]RTC_FORMAT_UINT/2/3/4\f[R] format are used to specify that data
 buffers store unsigned integers, or unsigned integer vectors of size 2,3
 or 4.
 This format has typically to get used when specifying index buffers,
-e.g.\ \f[C]RTC_FORMAT_UINT3\f[R] for triangle meshes.
+e.g.\ \f[V]RTC_FORMAT_UINT3\f[R] for triangle meshes.
 .PP
-The \f[C]RTC_FORMAT_FLOAT/2/3/4...\f[R] format are used to specify that
+The \f[V]RTC_FORMAT_FLOAT/2/3/4...\f[R] format are used to specify that
 data buffers store single precision floating point values, or vectors
 there of (size 2,3,4, etc.).
 This format is typcally used to specify to format of vertex buffers,
-e.g.\ the \f[C]RTC_FORMAT_FLOAT3\f[R] type for vertex buffers of
+e.g.\ the \f[V]RTC_FORMAT_FLOAT3\f[R] type for vertex buffers of
 triangle meshes.
 .PP
-The \f[C]RTC_FORMAT_FLOAT3X4_ROW_MAJOR\f[R] and
-\f[C]RTC_FORMAT_FLOAT3X4_COLUMN_MAJOR\f[R] formats, specify a 3x4
+The \f[V]RTC_FORMAT_FLOAT3X4_ROW_MAJOR\f[R] and
+\f[V]RTC_FORMAT_FLOAT3X4_COLUMN_MAJOR\f[R] formats, specify a 3x4
 floating point matrix layed out either row major or column major.
-The \f[C]RTC_FORMAT_FLOAT4X4_ROW_MAJOR\f[R] and
-\f[C]RTC_FORMAT_FLOAT4X4_COLUMN_MAJOR\f[R] formats, specify a 4x4
+The \f[V]RTC_FORMAT_FLOAT4X4_ROW_MAJOR\f[R] and
+\f[V]RTC_FORMAT_FLOAT4X4_COLUMN_MAJOR\f[R] formats, specify a 4x4
 floating point matrix layed out either row major or column major.
-The \f[C]RTC_FORMAT_QUATERNION_DECOMPOSITION\f[R] format specifies a
+The \f[V]RTC_FORMAT_QUATERNION_DECOMPOSITION\f[R] format specifies a
 structure that represents a quaternion decomposition (see
 [RTCQuaternionDecomposition]) of an affine transformation.
 These formats are used in the [rtcSetGeometryTransform] function or in
-geometry buffers with type \f[C]RTC_BUFFER_TYPE_TRANSFORM\f[R] in order
+geometry buffers with type \f[V]RTC_BUFFER_TYPE_TRANSFORM\f[R] in order
 to set a transformation matrix for instance and instance array
 geometries.
 .PP
-The \f[C]RTC_FORMAT_GRID\f[R] is a special data format used to specify
+The \f[V]RTC_FORMAT_GRID\f[R] is a special data format used to specify
 grid primitives of layout RTCGrid when creating grid geometries (see
 [RTC_GEOMETRY_TYPE_GRID]).
 .SS EXIT STATUS

man/man3/RTCFormat.4embree4

@@ -1,5 +1,19 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
 .TH "RTCHit" "3" "" "" "Embree Ray Tracing Kernels 4"
 .hy
 .SS NAME
@@ -32,22 +46,22 @@ struct RTCHit
 .fi
 .SS DESCRIPTION
 .PP
-The \f[C]RTCHit\f[R] type defines the type of a ray/primitive
+The \f[V]RTCHit\f[R] type defines the type of a ray/primitive
 intersection result.
 The hit contains the unnormalized geometric normal in object space at
-the hit location (\f[C]Ng_x\f[R], \f[C]Ng_y\f[R], \f[C]Ng_z\f[R]
-members), the barycentric u/v coordinates of the hit (\f[C]u\f[R] and
-\f[C]v\f[R] members), as well as the primitive ID (\f[C]primID\f[R]
-member), geometry ID (\f[C]geomID\f[R] member), and instance ID stack
-(\f[C]instID\f[R] member) of the hit.
+the hit location (\f[V]Ng_x\f[R], \f[V]Ng_y\f[R], \f[V]Ng_z\f[R]
+members), the barycentric u/v coordinates of the hit (\f[V]u\f[R] and
+\f[V]v\f[R] members), as well as the primitive ID (\f[V]primID\f[R]
+member), geometry ID (\f[V]geomID\f[R] member), and instance ID stack
+(\f[V]instID\f[R] member) of the hit.
 The parametric intersection distance is not stored inside the hit, but
-stored inside the \f[C]tfar\f[R] member of the ray.
+stored inside the \f[V]tfar\f[R] member of the ray.
 .PP
-The \f[C]embree4/rtcore_ray.h\f[R] header additionally defines the same
+The \f[V]embree4/rtcore_ray.h\f[R] header additionally defines the same
 hit structure in structure of array (SOA) layout for hit packets of size
-4 (\f[C]RTCHit4\f[R] type), size 8 (\f[C]RTCHit8\f[R] type), and size 16
-(\f[C]RTCHit16\f[R] type).
-The header additionally defines an \f[C]RTCHitNt\f[R] template for hit
+4 (\f[V]RTCHit4\f[R] type), size 8 (\f[V]RTCHit8\f[R] type), and size 16
+(\f[V]RTCHit16\f[R] type).
+The header additionally defines an \f[V]RTCHitNt\f[R] template for hit
 packets of an arbitrary compile-time size.
 .SS EXIT STATUS
 .SS SEE ALSO

man/man3/RTCHit.4embree4

@@ -1,5 +1,19 @@
-.\" Automatically generated by Pandoc 2.9.2.1
+.\" Automatically generated by Pandoc 3.1.3
 .\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
 .TH "RTCHitN" "3" "" "" "Embree Ray Tracing Kernels 4"
 .hy
 .SS NAME
@@ -32,20 +46,20 @@ unsigned& RTCHitN_instID(RTCHitN* hit, unsigned int N, unsigned int i, unsigned
 .SS DESCRIPTION
 .PP
 When the hit packet size is not known at compile time (e.g.\ when Embree
-returns a hit packet in the \f[C]RTCFilterFuncN\f[R] callback function),
-Embree uses the \f[C]RTCHitN\f[R] type for hit packets.
+returns a hit packet in the \f[V]RTCFilterFuncN\f[R] callback function),
+Embree uses the \f[V]RTCHitN\f[R] type for hit packets.
 These hit packets can only have sizes of 1, 4, 8, or 16.
 No other packet size will be used.
 .PP
 You can either implement different special code paths for each of these
 possible packet sizes and cast the hit to the appropriate hit packet
 type, or implement one general code path that uses the
-\f[C]RTCHitN_XXX\f[R] helper functions to access hit packet components.
+\f[V]RTCHitN_XXX\f[R] helper functions to access hit packet components.
 .PP
-These helper functions get a pointer to the hit packet (\f[C]hit\f[R]
-argument), the packet size (\f[C]N\f[R] argument), and returns a
-reference to a component (e.g.\ x component of \f[C]Ng\f[R]) of the the
-i-th hit of the packet (\f[C]i\f[R] argument).
+These helper functions get a pointer to the hit packet (\f[V]hit\f[R]
+argument), the packet size (\f[V]N\f[R] argument), and returns a
+reference to a component (e.g.\ x component of \f[V]Ng\f[R]) of the the
+i-th hit of the packet (\f[V]i\f[R] argument).
 .SS EXIT STATUS
 .SS SEE ALSO
 .PP