rtcSetSceneBuildQuality.3embree3 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .TH "rtcSetSceneBuildQuality" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcSetSceneBuildQuality\ \-\ sets\ the\ build\ quality\ for
  7. \ \ the\ scene
  8. \f[]
  9. .fi
  10. .SS SYNOPSIS
  11. .IP
  12. .nf
  13. \f[C]
  14. #include\ <embree3/rtcore.h>
  15. void\ rtcSetSceneBuildQuality(
  16. \ \ RTCScene\ scene,
  17. \ \ enum\ RTCBuildQuality\ quality
  18. );
  19. \f[]
  20. .fi
  21. .SS DESCRIPTION
  22. .PP
  23. The \f[C]rtcSetSceneBuildQuality\f[] function sets the build quality
  24. (\f[C]quality\f[] argument) for the specified scene (\f[C]scene\f[]
  25. argument).
  26. Possible values for the build quality are:
  27. .IP \[bu] 2
  28. \f[C]RTC_BUILD_QUALITY_LOW\f[]: Create lower quality data structures,
  29. e.g.
  30. for dynamic scenes.
  31. A two\-level spatial index structure is built when enabling this mode,
  32. which supports fast partial scene updates, and allows for setting a
  33. per\-geometry build quality through the
  34. \f[C]rtcSetGeometryBuildQuality\f[] function.
  35. .IP \[bu] 2
  36. \f[C]RTC_BUILD_QUALITY_MEDIUM\f[]: Default build quality for most
  37. usages.
  38. Gives a good compromise between build and render performance.
  39. .IP \[bu] 2
  40. \f[C]RTC_BUILD_QUALITY_HIGH\f[]: Create higher quality data structures
  41. for final\-frame rendering.
  42. For certain geometry types this enables a spatial split BVH.
  43. .PP
  44. Selecting a higher build quality results in better rendering performance
  45. but slower scene commit times.
  46. The default build quality for a scene is
  47. \f[C]RTC_BUILD_QUALITY_MEDIUM\f[].
  48. .SS EXIT STATUS
  49. .PP
  50. On failure an error code is set that can be queried using
  51. \f[C]rtcGetDeviceError\f[].
  52. .SS SEE ALSO
  53. .PP
  54. [rtcSetGeometryBuildQuality]