rtcGetGeometry.3embree3 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. .TH "rtcGetGeometry" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcGetGeometry\ \-\ returns\ the\ geometry\ bound\ to
  7. \ \ the\ specified\ geometry\ ID
  8. \f[]
  9. .fi
  10. .SS SYNOPSIS
  11. .IP
  12. .nf
  13. \f[C]
  14. #include\ <embree3/rtcore.h>
  15. RTCGeometry\ rtcGetGeometry(RTCScene\ scene,\ unsigned\ int\ geomID);
  16. \f[]
  17. .fi
  18. .SS DESCRIPTION
  19. .PP
  20. The \f[C]rtcGetGeometry\f[] function returns the geometry that is bound
  21. to the specified geometry ID (\f[C]geomID\f[] argument) for the
  22. specified scene (\f[C]scene\f[] argument).
  23. This function just looks up the handle and does \f[I]not\f[] increment
  24. the reference count.
  25. If you want to get ownership of the handle, you need to additionally
  26. call \f[C]rtcRetainGeometry\f[].
  27. For this reason, this function is fast and can be used during rendering.
  28. However, it is generally recommended to store the geometry handle inside
  29. the application\[aq]s geometry representation and look up the geometry
  30. handle from that representation directly.
  31. .SS EXIT STATUS
  32. .PP
  33. On failure \f[C]NULL\f[] is returned and an error code is set that can
  34. be queried using \f[C]rtcGetDeviceError\f[].
  35. .SS SEE ALSO
  36. .PP
  37. [rtcAttachGeometry], [rtcAttachGeometryByID]