rtcOccludedNM.3embree3 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. .TH "rtcOccludedNM" "3" "" "" "Embree Ray Tracing Kernels 3"
  2. .SS NAME
  3. .IP
  4. .nf
  5. \f[C]
  6. rtcOccludedNM\ \-\ finds\ any\ hits\ for\ a\ stream\ of\ M\ ray\ packets\ of
  7. \ \ size\ N
  8. \f[]
  9. .fi
  10. .SS SYNOPSIS
  11. .IP
  12. .nf
  13. \f[C]
  14. #include\ <embree3/rtcore.h>
  15. void\ rtcOccludedNM(
  16. \ \ RTCScene\ scene,
  17. \ \ struct\ RTCIntersectContext*\ context,
  18. \ \ struct\ RTCRayN*\ ray,
  19. \ \ unsigned\ int\ N,
  20. \ \ unsigned\ int\ M,
  21. \ \ size_t\ byteStride
  22. );
  23. \f[]
  24. .fi
  25. .SS DESCRIPTION
  26. .PP
  27. The \f[C]rtcOccludedNM\f[] function checks whether there are any hits
  28. for a stream of \f[C]M\f[] ray packets (\f[C]ray\f[] argument) of size
  29. \f[C]N\f[] with the scene (\f[C]scene\f[] argument).
  30. The \f[C]ray\f[] argument points to an array of ray packets with
  31. specified byte stride (\f[C]byteStride\f[] argument) between the ray
  32. packets.
  33. See Section [rtcOccluded1] for a description of how to set up and trace
  34. occlusion rays.
  35. .IP
  36. .nf
  37. \f[C]
  38. \f[]
  39. .fi
  40. .IP
  41. .nf
  42. \f[C]
  43. \f[]
  44. .fi
  45. .PP
  46. A ray in a ray stream is considered inactive if its \f[C]tnear\f[] value
  47. is larger than its \f[C]tfar\f[] value.
  48. .PP
  49. The packet size \f[C]N\f[] must be larger than 0, and the stream size
  50. \f[C]M\f[] can be an arbitrary positive integer including 0.
  51. Each ray must be aligned to 16 bytes.
  52. .SS EXIT STATUS
  53. .PP
  54. For performance reasons this function does not do any error checks, thus
  55. will not set any error flags on failure.
  56. .SS SEE ALSO
  57. .PP
  58. [rtcIntersectNM]