rtcSetSceneFlags.3embree3 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .TH "rtcSetSceneFlags" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcSetSceneFlags\ \-\ sets\ the\ flags\ for\ the\ scene
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. void\ rtcSetSceneFlags(RTCScene\ scene,\ enum\ RTCSceneFlags\ flags);
  15. \f[]
  16. .fi
  17. .SS DESCRIPTION
  18. .PP
  19. The \f[C]rtcSetSceneFlags\f[] function sets the scene flags
  20. (\f[C]flags\f[] argument) for the specified scene (\f[C]scene\f[]
  21. argument).
  22. Possible scene flags are:
  23. .IP \[bu] 2
  24. \f[C]RTC_SCENE_FLAG_NONE\f[]: No flags set.
  25. .IP \[bu] 2
  26. \f[C]RTC_SCENE_FLAG_DYNAMIC\f[]: Provides better build performance for
  27. dynamic scenes (but also higher memory consumption).
  28. .IP \[bu] 2
  29. \f[C]RTC_SCENE_FLAG_COMPACT\f[]: Uses compact acceleration structures
  30. and avoids algorithms that consume much memory.
  31. .IP \[bu] 2
  32. \f[C]RTC_SCENE_FLAG_ROBUST\f[]: Uses acceleration structures that allow
  33. for robust traversal, and avoids optimizations that reduce arithmetic
  34. accuracy.
  35. This mode is typically used for avoiding artifacts caused by rays
  36. shooting through edges of neighboring primitives.
  37. .IP \[bu] 2
  38. \f[C]RTC_SCENE_FLAG_CONTEXT_FILTER_FUNCTION\f[]: Enables support for a
  39. filter function inside the intersection context.
  40. See Section [rtcInitIntersectContext] for more details.
  41. .PP
  42. Multiple flags can be enabled using an \f[C]or\f[] operation, e.g.
  43. \f[C]RTC_SCENE_FLAG_COMPACT\ |\ RTC_SCENE_FLAG_ROBUST\f[].
  44. .SS EXIT STATUS
  45. .PP
  46. On failure an error code is set that can be queried using
  47. \f[C]rtcGetDeviceError\f[].
  48. .SS SEE ALSO
  49. .PP
  50. [rtcGetSceneFlags]