rtcGetGeometryFirstHalfEdge.3embree3 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .TH "rtcGetGeometryFirstHalfEdge" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcGetGeometryFirstHalfEdge\ \-\ returns\ the\ first\ half\ edge\ of\ a\ face
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. unsigned\ int\ rtcGetGeometryFirstHalfEdge(
  15. \ \ RTCGeometry\ geometry,
  16. \ \ unsigned\ int\ faceID
  17. );
  18. \f[]
  19. .fi
  20. .SS DESCRIPTION
  21. .PP
  22. The \f[C]rtcGetGeometryFirstHalfEdge\f[] function returns the ID of the
  23. first half edge belonging to the specified face (\f[C]faceID\f[]
  24. argument).
  25. For instance in the following example the first half edge of face
  26. \f[C]f1\f[] is \f[C]e4\f[].
  27. .IP
  28. .nf
  29. \f[C]
  30. \f[]
  31. .fi
  32. .PP
  33. This function can only be used for subdivision geometries.
  34. As all topologies of a subdivision geometry share the same face buffer
  35. the function does not depend on the topology ID.
  36. .PP
  37. Here f0 to f7 are 8 quadrilateral faces with 4 vertices each.
  38. The edges e0 to e23 of these faces are shown with their orientation.
  39. For each face the ID of the edges corresponds to the slots the face
  40. occupies in the index array of the geometry.
  41. E.g.
  42. as the indices of face f1 start at location 4 of the index array, the
  43. first edge is edge e4, the next edge e5, etc.
  44. .SS EXIT STATUS
  45. .PP
  46. On failure an error code is set that can be queried using
  47. \f[C]rtcGetDeviceError\f[].
  48. .SS SEE ALSO
  49. .PP
  50. [rtcGetGeometryFirstHalfEdge], [rtcGetGeometryFace],
  51. [rtcGetGeometryOppositeHalfEdge], [rtcGetGeometryNextHalfEdge],
  52. [rtcGetGeometryPreviousHalfEdge]