1rtcAttachGeometryByID(3) Embree Ray Tracing Kernels 3 rtcAttachGeometryByID(3)
2
3
4
5   NAME
6              rtcAttachGeometryByID - attaches a geometry to the scene
7                using a specified geometry ID
8
9   SYNOPSIS
10              #include <embree3/rtcore.h>
11
12              void rtcAttachGeometryByID(
13                RTCScene scene,
14                RTCGeometry geometry,
15                unsigned int geomID
16              );
17
18   DESCRIPTION
19       The  rtcAttachGeometryByID function attaches a geometry (geometry argu‐
20       ment) to a scene (scene argument) and assigns a user provided  geometry
21       ID  (geomID  argument)  to that geometry.  All geometries attached to a
22       scene are defined to be included inside the scene.  A geometry can  get
23       attached  to  multiple  scenes.  The passed user-defined geometry ID is
24       used to identify the geometry when hit by a  ray  during  ray  queries.
25       Using  this  function, it is possible to share the same IDs to refer to
26       geometries inside the application and Embree.
27
28       This function is thread-safe, thus multiple threads can  attach  geome‐
29       tries to a scene in parallel.
30
31       The  user-provided  geometry  ID must be unused in the scene, otherwise
32       the creation of the geometry will fail.  Further, the user-provided ge‐
33       ometry  IDs  should  be  compact, as Embree internally creates a vector
34       which size is equal to the largest geometry  ID  used.   Creating  very
35       large  geometry IDs for small scenes would thus cause a memory consump‐
36       tion and performance overhead.
37
38   EXIT STATUS
39       On failure an error code is set that can  be  queried  using  rtcGetDe‐
40       viceError.
41
42   SEE ALSO
43       [rtcAttachGeometry]
44
45
46
47                                                      rtcAttachGeometryByID(3)