rtcSetGeometryUserData.3embree3 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. .TH "rtcSetGeometryUserData" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcSetGeometryUserData\ \-\ sets\ the\ user\-defined\ data\ pointer\ of\ the
  7. \ \ geometry
  8. \f[]
  9. .fi
  10. .SS SYNOPSIS
  11. .IP
  12. .nf
  13. \f[C]
  14. #include\ <embree3/rtcore.h>
  15. void\ rtcSetGeometryUserData(RTCGeometry\ geometry,\ void*\ userPtr);
  16. \f[]
  17. .fi
  18. .SS DESCRIPTION
  19. .PP
  20. The \f[C]rtcSetGeometryUserData\f[] function sets the user\-defined data
  21. pointer (\f[C]userPtr\f[] argument) for a geometry (\f[C]geometry\f[]
  22. argument).
  23. This user data pointer is intended to be pointing to the
  24. application\[aq]s representation of the geometry, and is passed to
  25. various callback functions.
  26. The application can use this pointer inside the callback functions to
  27. access its geometry representation.
  28. .PP
  29. The \f[C]rtcGetGeometryUserData\f[] function can be used to query an
  30. already set user data pointer of a geometry.
  31. .SS EXIT STATUS
  32. .PP
  33. On failure an error code is set that can be queried using
  34. \f[C]rtcGetDeviceError\f[].
  35. .SS SEE ALSO
  36. .PP
  37. [rtcGetGeometryUserData]