rtcGetSceneLinearBounds.3embree3 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .TH "rtcGetSceneLinearBounds" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcGetSceneLinearBounds\ \-\ returns\ the\ linear\ bounds\ of\ the\ scene
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. struct\ RTCORE_ALIGN(16)\ RTCLinearBounds
  15. {
  16. \ \ RTCBounds\ bounds0;
  17. \ \ RTCBounds\ bounds1;
  18. };
  19. void\ rtcGetSceneLinearBounds(
  20. \ \ RTCScene\ scene,
  21. \ \ struct\ RTCLinearBounds*\ bounds_o
  22. );
  23. \f[]
  24. .fi
  25. .SS DESCRIPTION
  26. .PP
  27. The \f[C]rtcGetSceneLinearBounds\f[] function queries the linear bounds
  28. of the specified scene (\f[C]scene\f[] argument) and stores them to the
  29. provided destination pointer (\f[C]bounds_o\f[] argument).
  30. The stored linear bounds consist of bounding boxes for time 0
  31. (\f[C]bounds0\f[] member) and time 1 (\f[C]bounds1\f[] member) as
  32. specified by the \f[C]RTCLinearBounds\f[] structure.
  33. Linearly interpolating these bounds to a specific time \f[C]t\f[] yields
  34. bounds for the geometry at that time.
  35. .PP
  36. The provided destination pointer must be aligned to 16 bytes.
  37. The function may be called only after committing the scene, otherwise
  38. the result is undefined.
  39. .SS EXIT STATUS
  40. .PP
  41. On failure an error code is set that can be queried using
  42. \f[C]rtcGetDeviceError\f[].
  43. .SS SEE ALSO
  44. .PP
  45. [rtcGetSceneBounds], [rtcCommitScene], [rtcJoinCommitScene]