rtcCommitScene.3embree3 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. .TH "rtcCommitScene" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcCommitScene\ \-\ commits\ scene\ changes
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. void\ rtcCommitScene(RTCScene\ scene);
  15. \f[]
  16. .fi
  17. .SS DESCRIPTION
  18. .PP
  19. The \f[C]rtcCommitScene\f[] function commits all changes for the
  20. specified scene (\f[C]scene\f[] argument).
  21. This internally triggers building of a spatial acceleration structure
  22. for the scene using all available worker threads.
  23. Ray queries can be performed only after committing all scene changes.
  24. .PP
  25. The kind of acceleration structure built can be influenced using scene
  26. flags (see \f[C]rtcSetSceneFlags\f[]), and the quality can be specified
  27. using the \f[C]rtcSetSceneBuildQuality\f[] function.
  28. .PP
  29. Embree silently ignores primitives during spatial acceleration structure
  30. construction that would cause numerical issues, e.g.
  31. primitives containing NaNs, INFs, or values greater than 1.844E18f (as
  32. no reasonable calculations can be performed with such values without
  33. causing overflows).
  34. .SS EXIT STATUS
  35. .PP
  36. On failure an error code is set that can be queried using
  37. \f[C]rtcGetDeviceError\f[].
  38. .SS SEE ALSO
  39. .PP
  40. [rtcJoinCommitScene]