rtcGetGeometryOppositeHalfEdge.3embree3 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .TH "rtcGetGeometryOppositeHalfEdge" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcGetGeometryOppositeHalfEdge\ \-\ returns\ the\ opposite\ half\ edge
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore.h>
  14. unsigned\ int\ rtcGetGeometryOppositeHalfEdge(
  15. \ \ RTCGeometry\ geometry,
  16. \ \ unsigned\ int\ topologyID,
  17. \ \ unsigned\ int\ edgeID
  18. );
  19. \f[]
  20. .fi
  21. .SS DESCRIPTION
  22. .PP
  23. The \f[C]rtcGetGeometryOppositeHalfEdge\f[] function returns the ID of
  24. the opposite half edge of the specified half edge (\f[C]edgeID\f[]
  25. argument) in the specified topology (\f[C]topologyID\f[] argument).
  26. For instance in the following example the opposite half edge of
  27. \f[C]e6\f[] is \f[C]e16\f[].
  28. .IP
  29. .nf
  30. \f[C]
  31. \f[]
  32. .fi
  33. .PP
  34. An opposite half edge does not exist if the specified half edge has
  35. either no neighboring face, or more than 2 neighboring faces.
  36. In these cases the function just returns the same edge \f[C]edgeID\f[]
  37. again.
  38. .PP
  39. This function can only be used for subdivision geometries.
  40. The function depends on the topology as the topologies of a subdivision
  41. geometry have different index buffers assigned.
  42. .SS EXIT STATUS
  43. .PP
  44. On failure an error code is set that can be queried using
  45. \f[C]rtcGetDeviceError\f[].
  46. .SS SEE ALSO
  47. .PP
  48. [rtcGetGeometryFirstHalfEdge], [rtcGetGeometryFace],
  49. [rtcGetGeometryOppositeHalfEdge], [rtcGetGeometryNextHalfEdge],
  50. [rtcGetGeometryPreviousHalfEdge]