Skip to content

Commit c49e72b

Browse files
dopitzdopitz
committed
fix update doc
1 parent ff93817 commit c49e72b

25 files changed

+11135
-1
lines changed

‎README.md‎

Lines changed: 9675 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/src/api-ref.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@
431431
\pagebreak
432432

433433
## rtcGetGeometryTransformFromTraversable
434-
``` {include=src/api/rtcGetGeometryTransformFromScenTraversable.md}
434+
``` {include=src/api/rtcGetGeometryTransformFromTraversable.md}
435435
```
436436
\pagebreak
437437

‎man/man3/rtcCommitBuffer.4embree4‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.\" Automatically generated by Pandoc 3.1.3
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rtcCommitBuffer" "3" "" "" "Embree Ray Tracing Kernels 4"
18+
.hy
19+
.SS NAME
20+
.IP
21+
.nf
22+
\f[C]
23+
rtcCommitBuffer - commits buffer content from host to device
24+
\f[R]
25+
.fi
26+
.SS SYNOPSIS
27+
.IP
28+
.nf
29+
\f[C]
30+
#include <embree4/rtcore.h>
31+
32+
void rtcCommitBuffer(RTCBuffer buffer);
33+
\f[R]
34+
.fi
35+
.SS DESCRIPTION
36+
.PP
37+
If the buffer was created using \f[V]rtcNewBufferHostDevice\f[R] the
38+
\f[V]rtcCommitBuffer\f[R] function commits changes of the host buffer
39+
data to the device.
40+
This call is not necessary if the buffer was created with a non SYCL
41+
Embree device.
42+
.PP
43+
The call to \f[V]rtcCommitBuffer\f[R] will internally use a temporary
44+
SYCL queue and wait for the memory copy to finish.
45+
The function \f[V]rtcCommitBufferWithQueue\f[R] can be used to
46+
asyncronously copy the data to the device.
47+
.SS EXIT STATUS
48+
.PP
49+
On failure an error code is set that can be queried using
50+
\f[V]rtcGetDeviceError\f[R].
51+
.SS SEE ALSO
52+
.PP
53+
[rtcCommitBufferWithQueue] [rtcNewBufferHostDevice]

‎man/man3/rtcCommitBufferWithQueue.4embree4‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
.\" Automatically generated by Pandoc 3.1.3
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rtcCommitBufferWithQueue" "3" "" "" "Embree Ray Tracing Kernels 4"
18+
.hy
19+
.SS NAME
20+
.IP
21+
.nf
22+
\f[C]
23+
rtcCommitBufferWithQueue - commits buffer content from host to device using a given SYCL queue
24+
\f[R]
25+
.fi
26+
.SS SYNOPSIS
27+
.IP
28+
.nf
29+
\f[C]
30+
#include <embree4/rtcore.h>
31+
32+
void rtcCommitBufferWithQueue(RTCBuffer buffer,
33+
sycl::queue queue, sycl::event* event);
34+
\f[R]
35+
.fi
36+
.SS DESCRIPTION
37+
.PP
38+
If the buffer was created using \f[V]rtcNewBufferHostDevice\f[R] the
39+
\f[V]rtcCommitBufferWithQueue\f[R] function commits changes of the host
40+
buffer data to the device.
41+
If the buffer was created with a non SYCL Embree device or the SYCL
42+
device has host unified memory, this call has no effect.
43+
.PP
44+
The call to \f[V]rtcCommitBufferWithQueue\f[R] will use the given SYCL
45+
queue to copy the memory asynchronously.
46+
If the SYCL event argument \f[V]event\f[R] is a valid pointer, Embree
47+
will use this pointer to return a copy of the SYCL event associated to
48+
the memory copy.
49+
The parameter \f[V]event\f[R] is optional and will be ignored if it is a
50+
null pointer.
51+
.PP
52+
The user is responsible for synchronization using the SYCL queue or the
53+
optional SYCL event.
54+
.PP
55+
This function is only avaiable on Embree versions with enabled SYCL
56+
support.
57+
.SS EXIT STATUS
58+
.PP
59+
On failure an error code is set that can be queried using
60+
\f[V]rtcGetDeviceError\f[R].
61+
.SS SEE ALSO
62+
.PP
63+
[rtcCommitBuffer] [rtcNewBufferHostDevice]

‎man/man3/rtcCommitSceneWithQueue.4embree4‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
.\" Automatically generated by Pandoc 3.1.3
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rtcCommitSceneWithQueue" "3" "" "" "Embree Ray Tracing Kernels 4"
18+
.hy
19+
.SS NAME
20+
.IP
21+
.nf
22+
\f[C]
23+
rtcCommitSceneWithQueue - commits scene changes using a given
24+
SYCL queue for host-to-device memory transfers
25+
\f[R]
26+
.fi
27+
.SS SYNOPSIS
28+
.IP
29+
.nf
30+
\f[C]
31+
#include <embree4/rtcore.h>
32+
33+
void rtcCommitScene(RTCScene scene,
34+
sycl::queue queue,
35+
sycl::event* event);
36+
\f[R]
37+
.fi
38+
.SS DESCRIPTION
39+
.PP
40+
The \f[V]rtcCommitSceneWithQueue\f[R] function commits all changes for
41+
the specified scene (\f[V]scene\f[R] argument).
42+
This internally triggers building of a spatial acceleration structure
43+
for the scene using all available worker threads.
44+
Ray queries can be performed only after committing all scene changes.
45+
.PP
46+
The \f[V]rtcCommitSceneWithQueue\f[R] function differs from
47+
\f[V]rtcCommitScene\f[R] only in that the former uses a SYCL queue
48+
passed by the application for asynchronous host-to-device memory
49+
transfers and the latter uses an internal and temporary SYCL queue and
50+
is blocking, i.e.\ the function returns after all memory transfers are
51+
completed.
52+
.PP
53+
The application is responsible for synchronization when using
54+
\f[V]rtcCommitSceneWithQueue\f[R] by either calling \f[V]wait()\f[R] on
55+
the \f[V]queue\f[R] or use the optional \f[V]event\f[R] argument to
56+
receive a copy of the sycl::event associated with the last memcpy
57+
command that was submitted to the queue.
58+
The argument \f[V]event\f[R] can also be a null pointer in which case
59+
the argument will be ignored internally.
60+
.PP
61+
A SYCL kernel calling rtcTraversableIntersect or rtcTraversableOccluded
62+
using a RTCTraversable associated with the RTCScene \f[V]scene\f[R] has
63+
a dependency on the host-to-device memory transfers and therefore has to
64+
be synchronized properly.
65+
.PP
66+
This function is only available when SYCL support is enabled.
67+
In case the RTCDevice associated with the \f[V]scene\f[R] is not a SYCL
68+
device, \f[V]rtcCommitSceneWithQueue\f[R] will behave the same as
69+
\f[V]rtcCommitScene\f[R].
70+
.SS EXIT STATUS
71+
.PP
72+
On failure an error code is set that can be queried using
73+
\f[V]rtcGetDeviceError\f[R].
74+
.SS SEE ALSO
75+
.PP
76+
[rtcCommitScene]

‎man/man3/rtcGetBufferDataDevice.4embree4‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.\" Automatically generated by Pandoc 3.1.3
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rtcGetBufferData" "3" "" "" "Embree Ray Tracing Kernels 4"
18+
.hy
19+
.SS NAME
20+
.IP
21+
.nf
22+
\f[C]
23+
rtcGetBufferDataDevice - gets a device pointer to the buffer data
24+
\f[R]
25+
.fi
26+
.SS SYNOPSIS
27+
.IP
28+
.nf
29+
\f[C]
30+
#include <embree4/rtcore.h>
31+
32+
void* rtcGetBufferDataDevice(RTCBuffer buffer);
33+
\f[R]
34+
.fi
35+
.SS DESCRIPTION
36+
.PP
37+
The \f[V]rtcGetBufferDataDevice\f[R] function returns a pointer to the
38+
buffer data of the specified buffer object (\f[V]buffer\f[R] argument)
39+
which can be used for accessing the data on the device.
40+
If Embree has no SYCL support or the SYCL device has host unified
41+
memory, the pointer is equal to the pointer returned by
42+
\f[V]rtcGetBufferData\f[R].
43+
.SS EXIT STATUS
44+
.PP
45+
On failure an error code is set that can be queried using
46+
\f[V]rtcGetDeviceError\f[R].
47+
.SS SEE ALSO
48+
.PP
49+
[rtcGetBufferData], [rtcNewBuffer]

‎man/man3/rtcGetGeometryBufferDataDevice.4embree4‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.\" Automatically generated by Pandoc 3.1.3
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rtcGetGeometryBufferDataDevice" "3" "" "" "Embree Ray Tracing Kernels 4"
18+
.hy
19+
.SS NAME
20+
.IP
21+
.nf
22+
\f[C]
23+
rtcGetGeometryBufferDataDevice - gets pointer to
24+
the first buffer view element on the device.
25+
\f[R]
26+
.fi
27+
.SS SYNOPSIS
28+
.IP
29+
.nf
30+
\f[C]
31+
#include <embree4/rtcore.h>
32+
33+
void* rtcGetGeometryBufferDataDevice(
34+
RTCGeometry geometry,
35+
enum RTCBufferType type,
36+
unsigned int slot
37+
);
38+
\f[R]
39+
.fi
40+
.SS DESCRIPTION
41+
.PP
42+
The \f[V]rtcGetGeometryBufferDataDevice\f[R] function returns a pointer
43+
to the first element of the buffer view attached to the specified buffer
44+
type and slot (\f[V]type\f[R] and \f[V]slot\f[R] argument) of the
45+
geometry (\f[V]geometry\f[R] argument) on the device.
46+
.PP
47+
If the device associated with \f[V]geometry\f[R] is no SYCL device, or
48+
if Embree is executed on a system with host unified memory (e.g., on an
49+
iGPU), the returned pointer is the same as the one returned by
50+
\f[V]rtcGetGeometryBufferData\f[R].
51+
.SS EXIT STATUS
52+
.PP
53+
On failure an error code is set that can be queried using
54+
\f[V]rtcGetDeviceError\f[R].
55+
.SS SEE ALSO
56+
.PP
57+
[rtcGetGeometryBufferData], [rtcSetGeometryBuffer],
58+
[rtcSetSharedGeometryBuffer], [rtcSetNewGeometryBuffer]

‎man/man3/rtcGetGeometryTransformFromTraversable.4embree4‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.\" Automatically generated by Pandoc 3.1.3
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rtcGetGeometryTransformFromTraversable" "3" "" "" "Embree Ray Tracing Kernels 4"
18+
.hy
19+
.SS NAME
20+
.IP
21+
.nf
22+
\f[C]
23+
rtcGetGeometryTransformFromTraversable - returns the interpolated instance
24+
transformation for the specified time
25+
\f[R]
26+
.fi
27+
.SS SYNOPSIS
28+
.IP
29+
.nf
30+
\f[C]
31+
#include <embree4/rtcore.h>
32+
33+
void rtcGetGeometryTransformFromTraversable(
34+
RTCTraversable traversable,
35+
unsigned int geomID,
36+
float time,
37+
enum RTCFormat format,
38+
void* xfm
39+
);
40+
\f[R]
41+
.fi
42+
.SS DESCRIPTION
43+
.PP
44+
The \f[V]rtcGetGeometryTransformFromTraversable\f[R] function is
45+
equivalent to \f[V]rtcGetGeometryTransformFromScene\f[R] but takes
46+
traversable object (\f[V]traversable\f[R] argument) instead of a scene
47+
object.
48+
Using this method is optional on CPU but it is required for SYCL.
49+
.PP
50+
For more details, refer to the documentation of
51+
\f[V]rtcGetGeometryTransformFromScene\f[R].
52+
.SS EXIT STATUS
53+
.PP
54+
On failure an error code is set that can be queried using
55+
\f[V]rtcGetDeviceError\f[R].
56+
.SS SEE ALSO
57+
.PP
58+
[rtcGetGeometryTransformFromScene], [rtcGetSceneTraversable]

0 commit comments

Comments
 (0)