1rtcSetSceneProgressMonitorEFmubnrceteioRna(y3)TracinrgtcKSeertnSeclesne3ProgressMonitorFunction(3)
2
3
4
5   NAME
6              rtcSetSceneProgressMonitorFunction - registers a callback
7                to track build progress
8
9   SYNOPSIS
10              #include <embree3/rtcore.h>
11
12              typedef bool (*RTCProgressMonitorFunction)(
13                void* ptr,
14                double progress
15              );
16
17              void rtcSetSceneProgressMonitorFunction(
18                RTCScene scene,
19                RTCProgressMonitorFunction progress,
20                void* userPtr
21              );
22
23   DESCRIPTION
24       Embree  supports a progress monitor callback mechanism that can be used
25       to report progress of hierarchy build operations and  to  cancel  build
26       operations.
27
28       The  rtcSetSceneProgressMonitorFunction  registers  a  progress monitor
29       callback function (progress argument) with payload  (userPtr  argument)
30       for the specified scene (scene argument).
31
32       Only  a  single callback function can be registered per scene, and fur‐
33       ther invocations overwrite the previously set callback function.  Pass‐
34       ing NULL as function pointer disables the registered callback function.
35
36       Once  registered,  Embree  will  invoke  the callback function multiple
37       times during hierarchy build operations of the scene,  by  passing  the
38       payload as set at registration time (userPtr argument), and a double in
39       the  range  [0, 1]  which  estimates  the  progress  of  the  operation
40       (progress argument).  The callback function might be called from multi‐
41       ple threads concurrently.
42
43       When returning true from the callback function,  Embree  will  continue
44       the build operation normally.  When returning false, Embree will cancel
45       the build operation with the RTC_ERROR_CANCELLED error  code.   Issuing
46       multiple cancel requests for the same build operation is allowed.
47
48   EXIT STATUS
49       On  failure  an  error  code  is  set  that can be queried using rtcDe‐
50       viceGetError.
51
52   SEE ALSO
53       [rtcNewScene]
54
55
56
57                                         rtcSetSceneProgressMonitorFunction(3)