Skip to content

Commit 9b427da

Browse files
committed
Updated documentation for version 4.5.0
Reflected changes in the documentation for version 4.5.0 Regenerated PDF documentation
1 parent 1b63e6b commit 9b427da

151 files changed

Lines changed: 1286 additions & 269 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5758,9 +5758,38 @@ On failure an error code is set that can be queried using
57585758
```
57595759
## rtcGetGeometryUserDataFromTraversable
57605760

5761-
`{include=src/api/rtcGetGeometryUserDataFromScenTraversable`
5762-
``{=tex}
5761+
#### NAME {#name}
5762+
5763+
rtcGetGeometryUserDataFromTraversable - returns the user data pointer
5764+
of the geometry through the scene object
5765+
5766+
#### SYNOPSIS {#synopsis}
5767+
5768+
#include <embree4/rtcore.h>
5769+
5770+
void* rtcGetGeometryUserDataFromTraversable(
5771+
RTCTraversable traversable,
5772+
unsigned int geomID);
5773+
5774+
#### DESCRIPTION {#description}
5775+
5776+
The `rtcGetGeometryUserDataFromTraversable` function is equivalent to
5777+
`rtcGetGeometryUserDataFromScene` but takes traversable object
5778+
(`traversable` argument) instead of a scene object. Using this method
5779+
is optional on CPU but it is required for SYCL.
5780+
5781+
#### EXIT STATUS {#exit-status}
5782+
5783+
On failure an error code is set that can be queried using
5784+
`rtcGetDeviceError`.
57635785

5786+
#### SEE ALSO {#see-also}
5787+
5788+
[rtcGetGeometryUserDataFromScene], [rtcGetSceneTraversable]
5789+
5790+
```{=tex}
5791+
5792+
```
57645793
## rtcSetGeometryUserPrimitiveCount
57655794

57665795
#### NAME {#name}

‎doc/preamble.tex‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@
8787
% margins by default, and it is still possible to overwrite the defaults
8888
% using explicit options in \includegraphics[width, height, ...]{}
8989
\setkeys{Gin}{width=\maxwidth,height=\maxheight,keepaspectratio}
90+
\providecommand{\pandocbounded}[1]{#1}
9091

9192
\ifxetex
9293
\usepackage[setpagesize=false, % page size defined by xetex

‎doc/src/readme.tex‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
\IfFileExists{intelstyle/intel-spec.cls}
55
{
66
\documentclass[oneside]{intelstyle/intel-spec}
7-
\include{preamble}
7+
\input{preamble}
88
\copyrightyears{2009--2020}
99
\trademarkacknowledgment{%
1010
Intel, the Intel logo, Xeon, Intel Xeon Phi, and Intel Core are
@@ -15,7 +15,7 @@
1515
}
1616
{
1717
\documentclass[oneside]{report}
18-
\include{preamble}
18+
\input{preamble}
1919
}
2020

2121
\usepackage{longtable}

‎man/man3/RTCBufferType.3embree4‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" Automatically generated by Pandoc 3.1.11.1
1+
.\" Automatically generated by Pandoc 3.7.0.2
22
.\"
33
.TH "RTCBufferType" "3" "" "" "Embree Ray Tracing Kernels 4"
44
.SS NAME

‎man/man3/RTCCurveFlags.3embree4‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" Automatically generated by Pandoc 3.1.11.1
1+
.\" Automatically generated by Pandoc 3.7.0.2
22
.\"
33
.TH "RTCCurveFlags" "3" "" "" "Embree Ray Tracing Kernels 4"
44
.SS NAME

‎man/man3/RTCFeatureFlags.3embree4‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" Automatically generated by Pandoc 3.1.11.1
1+
.\" Automatically generated by Pandoc 3.7.0.2
22
.\"
33
.TH "RTCFeatureFlags" "3" "" "" "Embree Ray Tracing Kernels 4"
44
.SS NAME
@@ -93,129 +93,129 @@ On the CPU there is no need to use feature flags, and the default of all
9393
features enabled (\f[CR]RTC_FEATURE_FLAG_ALL\f[R]) can just be kept.
9494
.PP
9595
The following features can get enabled using feature flags:
96-
.IP \[bu] 2
96+
.IP \(bu 2
9797
RTC_FEATURE_FLAG_MOTION_BLUR: Enables motion blur for all geometry
9898
types.
99-
.IP \[bu] 2
99+
.IP \(bu 2
100100
RTC_FEATURE_FLAG_TRIANGLE: Enables triangle geometries
101101
(RTC_GEOMETRY_TYPE_TRIANGLE).
102-
.IP \[bu] 2
102+
.IP \(bu 2
103103
RTC_FEATURE_FLAG_QUAD: Enables quad geometries (RTC_GEOMETRY_TYPE_QUAD).
104-
.IP \[bu] 2
104+
.IP \(bu 2
105105
RTC_FEATURE_FLAG_GRID: Enables grid geometries (RTC_GEOMETRY_TYPE_GRID).
106-
.IP \[bu] 2
106+
.IP \(bu 2
107107
RTC_FEATURE_FLAG_SUBDIVISION: Enables subdivision geometries
108108
(RTC_GEOMETRY_TYPE_SUBDIVISION).
109-
.IP \[bu] 2
109+
.IP \(bu 2
110110
RTC_FEATURE_FLAG_POINT: Enables all point geometry types
111111
(RTC_GEOMETRY_TYPE_XXX_POINT)
112-
.IP \[bu] 2
112+
.IP \(bu 2
113113
RTC_FEATURE_FLAG_CURVES: Enables all curve geometry types
114114
(RTC_GEOMETRY_TYPE_XXX_YYY_CURVE)
115-
.IP \[bu] 2
115+
.IP \(bu 2
116116
RTC_FEATURE_FLAG_ROUND_CURVES: Enables all round curves
117117
(RTC_GEOMETRY_TYPE_ROUND_XXX_CURVE).
118-
.IP \[bu] 2
118+
.IP \(bu 2
119119
RTC_FEATURE_FLAG_FLAT_CURVES: Enables all flat curves
120120
(RTC_GEOMETRY_TYPE_FLAT_XXX_CURVE).
121-
.IP \[bu] 2
121+
.IP \(bu 2
122122
RTC_FEATURE_FLAG_NORMAL_ORIENTED_CURVES: Enables all normal oriented
123123
curves (RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_XXX_CURVE).
124-
.IP \[bu] 2
124+
.IP \(bu 2
125125
RTC_FEATURE_FLAG_LINEAR_CURVES: Enables all linear curves
126126
(RTC_GEOMETRY_TYPE_XXX_LINEAR_CURVE).
127-
.IP \[bu] 2
127+
.IP \(bu 2
128128
RTC_FEATURE_FLAG_BEZIER_CURVES: Enables all Bézier curves
129129
(RTC_GEOMETRY_TYPE_XXX_BEZIER_CURVE).
130-
.IP \[bu] 2
130+
.IP \(bu 2
131131
RTC_FEATURE_FLAG_BSPLINE_CURVES: Enables all B\-spline curves
132132
(RTC_GEOMETRY_TYPE_XXX_BSPLINE_CURVE).
133-
.IP \[bu] 2
133+
.IP \(bu 2
134134
RTC_FEATURE_FLAG_HERMITE_CURVES: Enables all Hermite curves
135135
(RTC_GEOMETRY_TYPE_XXX_HERMITE_CURVE).
136-
.IP \[bu] 2
136+
.IP \(bu 2
137137
RTC_FEATURE_FLAG_CONE_LINEAR_CURVE: Enables cone geometry type
138138
(RTC_GEOMETRY_TYPE_CONE_LINEAR_CURVE).
139-
.IP \[bu] 2
139+
.IP \(bu 2
140140
RTC_FEATURE_FLAG_ROUND_LINEAR_CURVE: Enables round linear curves
141141
(RTC_GEOMETRY_TYPE_ROUND_LINEAR_CURVE).
142-
.IP \[bu] 2
142+
.IP \(bu 2
143143
RTC_FEATURE_FLAG_FLAT_LINEAR_CURVE: Enables flat linear curves
144144
(RTC_GEOMETRY_TYPE_FLAT_LINEAR_CURVE).
145-
.IP \[bu] 2
145+
.IP \(bu 2
146146
RTC_FEATURE_FLAG_ROUND_BEZIER_CURVE: Enables round Bézier curves
147147
(RTC_GEOMETRY_TYPE_ROUND_BEZIER_CURVE).
148-
.IP \[bu] 2
148+
.IP \(bu 2
149149
RTC_FEATURE_FLAG_FLAT_BEZIER_CURVE: Enables flat Bézier curves
150150
(RTC_GEOMETRY_TYPE_FLAT_BEZIER_CURVE).
151-
.IP \[bu] 2
151+
.IP \(bu 2
152152
RTC_FEATURE_FLAG_NORMAL_ORIENTED_BEZIER_CURVE: Enables normal oriented
153153
Bézier curves (RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_BEZIER_CURVE).
154-
.IP \[bu] 2
154+
.IP \(bu 2
155155
RTC_FEATURE_FLAG_ROUND_BSPLINE_CURVE: Enables round B\-spline curves
156156
(RTC_GEOMETRY_TYPE_ROUND_BSPLINE_CURVE).
157-
.IP \[bu] 2
157+
.IP \(bu 2
158158
RTC_FEATURE_FLAG_FLAT_BSPLINE_CURVE: Enables flat B\-spline curves
159159
(RTC_GEOMETRY_TYPE_FLAT_BSPLINE_CURVE).
160-
.IP \[bu] 2
160+
.IP \(bu 2
161161
RTC_FEATURE_FLAG_NORMAL_ORIENTED_BSPLINE_CURVE: Enables normal oriented
162162
B\-spline curves (RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_BSPLINE_CURVE).
163-
.IP \[bu] 2
163+
.IP \(bu 2
164164
RTC_FEATURE_FLAG_ROUND_HERMITE_CURVE: Enables round Hermite curves
165165
(RTC_GEOMETRY_TYPE_ROUND_HERMITE_CURVE).
166-
.IP \[bu] 2
166+
.IP \(bu 2
167167
RTC_FEATURE_FLAG_FLAT_HERMITE_CURVE: Enables flat Hermite curves
168168
(RTC_GEOMETRY_TYPE_FLAT_HERMITE_CURVE).
169-
.IP \[bu] 2
169+
.IP \(bu 2
170170
RTC_FEATURE_FLAG_NORMAL_ORIENTED_HERMITE_CURVE: Enables normal oriented
171171
Hermite curves (RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_HERMITE_CURVE).
172-
.IP \[bu] 2
172+
.IP \(bu 2
173173
RTC_FEATURE_FLAG_ROUND_CATMULL_ROM_CURVE: Enables round Catmull Rom
174174
curves (RTC_GEOMETRY_TYPE_ROUND_CATMULL_ROM_CURVE).
175-
.IP \[bu] 2
175+
.IP \(bu 2
176176
RTC_FEATURE_FLAG_FLAT_CATMULL_ROM_CURVE: Enables flat Catmull Rom curves
177177
(RTC_GEOMETRY_TYPE_FLAT_CATMULL_ROM_CURVE).
178-
.IP \[bu] 2
178+
.IP \(bu 2
179179
RTC_FEATURE_FLAG_NORMAL_ORIENTED_CATMULL_ROM_CURVE: Enables normal
180180
oriented Catmull Rom curves
181181
(RTC_GEOMETRY_TYPE_NORMAL_ORIENTED_CATMULL_ROM_CURVE).
182-
.IP \[bu] 2
182+
.IP \(bu 2
183183
RTC_FEATURE_FLAG_SPHERE_POINT: Enables sphere geometry type
184184
(RTC_GEOMETRY_TYPE_SPHERE_POINT).
185-
.IP \[bu] 2
185+
.IP \(bu 2
186186
RTC_FEATURE_FLAG_DISC_POINT: Enables disc geometry type
187187
(RTC_GEOMETRY_TYPE_DISC_POINT).
188-
.IP \[bu] 2
188+
.IP \(bu 2
189189
RTC_FEATURE_FLAG_ORIENTED_DISC_POINT: Enables oriented disc geometry
190190
types (RTC_GEOMETRY_TYPE_ORIENTED_DISC_POINT).
191-
.IP \[bu] 2
191+
.IP \(bu 2
192192
RTC_FEATURE_FLAG_INSTANCE: Enables instance geometries
193193
(RTC_GEOMETRY_TYPE_INSTANCE).
194-
.IP \[bu] 2
194+
.IP \(bu 2
195195
RTC_FEATURE_FLAG_FILTER_FUNCTION_IN_ARGUMENTS: Enables filter functions
196196
passed through intersect arguments.
197-
.IP \[bu] 2
197+
.IP \(bu 2
198198
RTC_FEATURE_FLAG_FILTER_FUNCTION_IN_GEOMETRY: Enable filter functions
199199
passed through geometry.
200-
.IP \[bu] 2
200+
.IP \(bu 2
201201
RTC_FEATURE_FLAG_FILTER_FUNCTION: Enables filter functions (argument and
202202
geometry version).
203-
.IP \[bu] 2
203+
.IP \(bu 2
204204
RTC_FEATURE_FLAG_USER_GEOMETRY_CALLBACK_IN_ARGUMENTS: Enables
205205
RTC_GEOMETRY_TYPE_USER with function pointer passed through intersect
206206
arguments.
207-
.IP \[bu] 2
207+
.IP \(bu 2
208208
RTC_FEATURE_FLAG_USER_GEOMETRY_CALLBACK_IN_GEOMETRY: Enables
209209
RTC_GEOMETRY_TYPE_USER with function pointer passed through geometry
210210
object.
211-
.IP \[bu] 2
211+
.IP \(bu 2
212212
RTC_FEATURE_FLAG_USER_GEOMETRY: Enables RTC_GEOMETRY_TYPE_USER
213213
geometries (both argument and geometry callback versions).
214-
.IP \[bu] 2
214+
.IP \(bu 2
215215
RTC_FEATURE_FLAG_32_BIT_RAY_MASK: Enables full 32 bit ray masks.
216216
If not used, only the lower 7 bits in the ray mask are handled
217217
correctly.
218-
.IP \[bu] 2
218+
.IP \(bu 2
219219
RTC_FEATURE_FLAG_ALL: Enables all features (default).
220220
.SS EXIT STATUS
221221
.SS SEE ALSO

‎man/man3/RTCFormat.3embree4‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" Automatically generated by Pandoc 3.1.11.1
1+
.\" Automatically generated by Pandoc 3.7.0.2
22
.\"
33
.TH "RTCFormat" "3" "" "" "Embree Ray Tracing Kernels 4"
44
.SS NAME

‎man/man3/RTCHit.3embree4‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" Automatically generated by Pandoc 3.1.11.1
1+
.\" Automatically generated by Pandoc 3.7.0.2
22
.\"
33
.TH "RTCHit" "3" "" "" "Embree Ray Tracing Kernels 4"
44
.SS NAME

‎man/man3/RTCHitN.3embree4‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" Automatically generated by Pandoc 3.1.11.1
1+
.\" Automatically generated by Pandoc 3.7.0.2
22
.\"
33
.TH "RTCHitN" "3" "" "" "Embree Ray Tracing Kernels 4"
44
.SS NAME

‎man/man3/RTCQuaternionDecomposition.3embree4‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" Automatically generated by Pandoc 3.1.11.1
1+
.\" Automatically generated by Pandoc 3.7.0.2
22
.\"
33
.TH "RTCQuaternionDecomposition" "3" "" "" "Embree Ray Tracing Kernels 4"
44
.SS NAME
@@ -26,25 +26,25 @@ An upper triangular scaling/skew/shift matrix
2626
.PP
2727
.RS
2828
$$
29-
S = \[rs]left( \[rs]begin{array}{cccc}
30-
scale_x & skew_{xy} & skew_{xz} & shift_x \[rs]\[rs]
31-
0 & scale_y & skew_{yz} & shift_y \[rs]\[rs]
32-
0 & 0 & scale_z & shift_z \[rs]\[rs]
33-
0 & 0 & 0 & 1 \[rs]\[rs]
34-
\[rs]end{array} \[rs]right),
29+
S = \(rsleft( \(rsbegin{array}{cccc}
30+
scale_x & skew_{xy} & skew_{xz} & shift_x \(rs\(rs
31+
0 & scale_y & skew_{yz} & shift_y \(rs\(rs
32+
0 & 0 & scale_z & shift_z \(rs\(rs
33+
0 & 0 & 0 & 1 \(rs\(rs
34+
\(rsend{array} \(rsright),
3535
$$
3636
.RE
3737
.PP
3838
a translation matrix
3939
.PP
4040
.RS
4141
$$
42-
T = \[rs]left( \[rs]begin{array}{cccc}
43-
1 & 0 & 0 & translation_x \[rs]\[rs]
44-
0 & 1 & 0 & translation_y \[rs]\[rs]
45-
0 & 0 & 1 & translation_z \[rs]\[rs]
46-
0 & 0 & 0 & 1 \[rs]\[rs]
47-
\[rs]end{array} \[rs]right),
42+
T = \(rsleft( \(rsbegin{array}{cccc}
43+
1 & 0 & 0 & translation_x \(rs\(rs
44+
0 & 1 & 0 & translation_y \(rs\(rs
45+
0 & 0 & 1 & translation_z \(rs\(rs
46+
0 & 0 & 0 & 1 \(rs\(rs
47+
\(rsend{array} \(rsright),
4848
$$
4949
.RE
5050
.PP
@@ -62,7 +62,7 @@ The affine transformation matrix corresponding to a
6262
\f[I]p\f[R] = (\f[I]p\f[R]~\f[I]x\f[R]~, \f[I]p\f[R]~\f[I]y\f[R]~, \f[I]p\f[R]~\f[I]z\f[R]~, 1)^\f[I]T\f[R]^
6363
will be transformed as
6464
.RS
65-
\f[I]p\f[R]′ = \f[I]T\f[R]\ \f[I]R\f[R]\ \f[I]S\f[R]\ \f[I]p\f[R].
65+
\f[I]p\f[R]^′^ = \f[I]T\f[R]\ \f[I]R\f[R]\ \f[I]S\f[R]\ \f[I]p\f[R].
6666
.RE
6767
.PP
6868
The functions \f[CR]rtcInitQuaternionDecomposition\f[R],

0 commit comments

Comments
 (0)