rtcSetGeometryBuildQuality.3embree3 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .TH "rtcSetGeometryBuildQuality" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcSetGeometryBuildQuality\ \-\ sets\ the\ build\ quality\ for\ the\ geometry
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. void\ rtcSetGeometryBuildQuality(
  15. \ \ RTCGeometry\ geometry,
  16. \ \ enum\ RTCBuildQuality\ quality
  17. );
  18. \f[]
  19. .fi
  20. .SS DESCRIPTION
  21. .PP
  22. The \f[C]rtcSetGeometryBuildQuality\f[] function sets the build quality
  23. (\f[C]quality\f[] argument) for the specified geometry
  24. (\f[C]geometry\f[] argument).
  25. The per\-geometry build quality is only a hint and may be ignored.
  26. Embree currently uses the per\-geometry build quality when the scene
  27. build quality is set to \f[C]RTC_BUILD_QUALITY_LOW\f[].
  28. In this mode a two\-level acceleration structure is build, and
  29. geometries build a separate acceleration structure using the geometry
  30. build quality.
  31. The per\-geometry build quality can be one of:
  32. .IP \[bu] 2
  33. \f[C]RTC_BUILD_QUALITY_LOW\f[]: Creates lower quality data structures,
  34. e.g.
  35. for dynamic scenes.
  36. .IP \[bu] 2
  37. \f[C]RTC_BUILD_QUALITY_MEDIUM\f[]: Default build quality for most
  38. usages.
  39. Gives a good compromise between build and render performance.
  40. .IP \[bu] 2
  41. \f[C]RTC_BUILD_QUALITY_HIGH\f[]: Creates higher quality data structures
  42. for final\-frame rendering.
  43. Enables a spatial split builder for certain primitive types.
  44. .IP \[bu] 2
  45. \f[C]RTC_BUILD_QUALITY_REFIT\f[]: Uses a BVH refitting approach when
  46. changing only the vertex buffer.
  47. .SS EXIT STATUS
  48. .PP
  49. On failure an error code is set that can be queried using
  50. \f[C]rtcGetDeviceError\f[].
  51. .SS SEE ALSO
  52. .PP
  53. [rtcSetSceneBuildQuality]