libigl_Martin/build2/install/share/man/man3/RTCHit.3embree3

.TH "RTCHit" "3" "" "" "Embree Ray Tracing Kernels 3"
.SS NAME
.IP
.nf
\f[C]
RTCHit\ \-\ single\ hit\ structure
\f[]
.fi
.SS SYNOPSIS
.IP
.nf
\f[C]
#include\ <embree3/rtcore.h>

struct\ RTCHit
{
\ \ float\ Ng_x;\ \ \ \ \ \ \ \ \ \ //\ x\ coordinate\ of\ geometry\ normal
\ \ float\ Ng_y;\ \ \ \ \ \ \ \ \ \ //\ y\ coordinate\ of\ geometry\ normal
\ \ float\ Ng_z;\ \ \ \ \ \ \ \ \ \ //\ z\ coordinate\ of\ geometry\ normal

\ \ float\ u;\ \ \ \ \ \ \ \ \ \ \ \ \ //\ barycentric\ u\ coordinate\ of\ hit
\ \ float\ v;\ \ \ \ \ \ \ \ \ \ \ \ \ //\ barycentric\ v\ coordinate\ of\ hit

\ \ unsigned\ int\ primID;\ //\ geometry\ ID
\ \ unsigned\ int\ geomID;\ //\ primitive\ ID
\ \ unsigned\ int\ instID[RTC_MAX_INSTANCE_LEVEL_COUNT];\ //\ instance\ ID
};
\f[]
.fi
.SS DESCRIPTION
.PP
The \f[C]RTCHit\f[] type defines the type of a ray/primitive
intersection result.
The hit contains the unnormalized geometric normal in object space at
the hit location (\f[C]Ng_x\f[], \f[C]Ng_y\f[], \f[C]Ng_z\f[] members),
the barycentric u/v coordinates of the hit (\f[C]u\f[] and \f[C]v\f[]
members), as well as the primitive ID (\f[C]primID\f[] member), geometry
ID (\f[C]geomID\f[] member), and instance ID (\f[C]instID\f[] member) of
the hit.
The parametric intersection distance is not stored inside the hit, but
stored inside the \f[C]tfar\f[] member of the ray.
.PP
The \f[C]embree3/rtcore_ray.h\f[] header additionally defines the same
hit structure in structure of array (SOA) layout for hit packets of size
4 (\f[C]RTCHit4\f[] type), size 8 (\f[C]RTCHit8\f[] type), and size 16
(\f[C]RTCHit16\f[] type).
The header additionally defines an \f[C]RTCHitNt\f[] template for hit
packets of an arbitrary compile\-time size.
.SS EXIT STATUS
.SS SEE ALSO
.PP
[RTCRay]