1rtcOccluded1(3)          Embree Ray Tracing Kernels 4          rtcOccluded1(3)
2
3
4
5   NAME
6              rtcOccluded1 - finds any hit for a single ray
7
8   SYNOPSIS
9              #include <embree4/rtcore.h>
10
11              void rtcOccluded1(
12                RTCScene scene,
13                struct RTCRay* ray,
14                struct RTCOccludedArguments* args = NULL
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).   The  passed
20       optional arguments struct (args argument) can get used for advanced use
21       cases, see section [rtcInitOccludedArguments] for more details.
22
23       To trace a ray, the user must initialize the ray origin (org  ray  mem‐
24       ber), ray direction (dir ray member), ray segment (tnear, tfar ray mem‐
25       bers), ray mask (mask ray member), and must set  the  ray  flags  to  0
26       (flags ray member).  The ray time (time ray member) must be initialized
27       to a value in the range [0, 1].  The ray segment must be in  the  range
28       [0, ∞], thus ranges that start behind the ray origin are not valid, but
29       ranges can reach to infinity.  See Section [RTCRay] for the ray  layout
30       description.
31
32       When  no intersection is found, the ray data is not updated.  In case a
33       hit was found, the tfar component of the ray is set to -inf.
34
35       The implementation makes no guarantees that primitives whose  hit  dis‐
36       tance is exactly at (or very close to) tnear or tfar are hit or missed.
37       If you want to exclude intersections at tnear just pass a slightly  en‐
38       larged  tnear,  and if you want to include intersections at tfar pass a
39       slightly enlarged tfar.
40
41       The ray must be aligned to 16 bytes.
42
43   EXIT STATUS
44       For performance reasons this function does not  do  any  error  checks,
45       thus will not set any error flags on failure.
46
47   SEE ALSO
48       [rtcIntersect1],  [rtcOccluded4/8/16],  [RTCRay], [rtcInitOccludedArgu‐
49       ments]
50
51
52
53                                                               rtcOccluded1(3)
Impressum