rtcOccludedNp.3embree3 1.5 KB

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