1rtcCommitScene(3)        Embree Ray Tracing Kernels 3        rtcCommitScene(3)
2
3
4
5   NAME
6              rtcCommitScene - commits scene changes
7
8   SYNOPSIS
9              #include <embree3/rtcore.h>
10
11              void rtcCommitScene(RTCScene scene);
12
13   DESCRIPTION
14       The rtcCommitScene function commits all changes for the specified scene
15       (scene argument).  This  internally  triggers  building  of  a  spatial
16       acceleration  structure  for  the  scene  using  all  available  worker
17       threads.  Ray queries can be performed only after committing all  scene
18       changes.
19
20       If  scene  geometries get modified or attached or detached, the rtcCom‐
21       mitScene call must be invoked before performing any further ray queries
22       for the scene; otherwise the effect of the ray query is undefined.  The
23       modification of a geometry, committing the scene, and tracing  of  rays
24       must  always  happen sequentially, and never at the same time.  Any API
25       call that sets a property of the scene or geometries contained  in  the
26       scene count as scene modification, e.g.  including setting of intersec‐
27       tion filter functions.
28
29       The kind of acceleration structure built can be influenced using  scene
30       flags  (see  rtcSetSceneFlags),  and the quality can be specified using
31       the rtcSetSceneBuildQuality function.
32
33       Embree silently ignores primitives during spatial  acceleration  struc‐
34       ture  construction  that would cause numerical issues, e.g.  primitives
35       containing NaNs, INFs, or values greater than 1.844E18f (as no  reason‐
36       able  calculations  can  be  performed with such values without causing
37       overflows).
38
39   EXIT STATUS
40       On failure an error code is set that can  be  queried  using  rtcGetDe‐
41       viceError.
42
43   SEE ALSO
44       [rtcJoinCommitScene]
45
46
47
48                                                             rtcCommitScene(3)