RTCRayHit.3embree3 976 B

12345678910111213141516171819202122232425262728293031323334353637
  1. .TH "RTCRay" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. RTCRayHit\ \-\ combined\ single\ ray/hit\ structure
  7. \f[]
  8. .fi
  9. .SS SYNOPSIS
  10. .IP
  11. .nf
  12. \f[C]
  13. #include\ <embree3/rtcore_ray.h>
  14. struct\ RTCORE_ALIGN(16)\ RTCRayHit
  15. {
  16. \ \ struct\ RTCRay\ ray;
  17. \ \ struct\ RTCHit\ hit;
  18. };
  19. \f[]
  20. .fi
  21. .SS DESCRIPTION
  22. .PP
  23. The \f[C]RTCRayHit\f[] structure is used as input for the
  24. \f[C]rtcIntersect\f[]\-type functions and stores the ray to intersect
  25. and some hit fields that hold the intersection result afterwards.
  26. .PP
  27. The \f[C]embree3/rtcore_ray.h\f[] header additionally defines the same
  28. ray/hit structure in structure of array (SOA) layout for API functions
  29. accepting ray packets of size 4 (\f[C]RTCRayHit4\f[] type), size 8
  30. (\f[C]RTCRayHit8\f[] type), and size 16 (\f[C]RTCRayHit16\f[] type).
  31. The header additionally defines an \f[C]RTCRayHitNt\f[] template to
  32. generate ray/hit packets of an arbitrary compile\-time size.
  33. .SS EXIT STATUS
  34. .SS SEE ALSO
  35. .PP
  36. [RTCRay], [RTCHit]