1rtcOccluded1(3)          Embree Ray Tracing Kernels 3          rtcOccluded1(3)
2
3
4
5   NAME
6              rtcOccluded1 - finds any hit for a single ray
7
8   SYNOPSIS
9              #include <embree3/rtcore.h>
10
11              void rtcOccluded1(
12                RTCScene scene,
13                struct RTCIntersectContext* context,
14                struct RTCRay* ray
15              );
16
17   DESCRIPTION
18       The  rtcOccluded1  function  checks  for  a  single  ray (ray argument)
19       whether there is any hit with the scene (scene argument).
20
21       The user must initialize the ray origin (org ray member), ray direction
22       (dir  ray  member), ray segment (tnear, tfar ray members), and must set
23       the ray flags to 0 (flags ray member).  If the  scene  contains  motion
24       blur  geometries,  also the ray time (time ray member) must be initial‐
25       ized to a value in the range [0, 1].  If ray masks are enabled at  com‐
26       pile  time, the ray mask (mask ray member) must be initialized as well.
27       The ray segment must be in the range [0, ∞],  thus  ranges  that  start
28       behind  the ray origin are not valid, but ranges can reach to infinity.
29       See Section [RTCRay] for the ray layout description.
30
31       When no intersection is found, the ray data is not updated.  In case  a
32       hit was found, the tfar component of the ray is set to -inf.
33
34       The  implementation  makes no guarantees that primitives whose hit dis‐
35       tance is exactly at (or very close to) tnear or tfar are hit or missed.
36       If  you  want  to  exclude  intersections at tnear just pass a slightly
37       enlarged tnear, and if you want to include intersections at tfar pass a
38       slightly enlarged tfar.
39
40       The ray must be aligned to 16 bytes.
41
42   EXIT STATUS
43       For  performance  reasons  this  function does not do any error checks,
44       thus will not set any error flags on failure.
45
46   SEE ALSO
47       [rtcOccluded1], [RTCRay]
48
49
50
51                                                               rtcOccluded1(3)