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

.TH "rtcSetGeometryMask" "3" "" "" "Embree Ray Tracing Kernels 3"
.SS NAME
.IP
.nf
\f[C]
rtcSetGeometryMask\ \-\ sets\ the\ geometry\ mask
\f[]
.fi
.SS SYNOPSIS
.IP
.nf
\f[C]
#include\ <embree3/rtcore.h>

void\ rtcSetGeometryMask(
\ \ RTCGeometry\ geometry,
\ \ unsigned\ int\ mask
);
\f[]
.fi
.SS DESCRIPTION
.PP
The \f[C]rtcSetGeometryMask\f[] function sets a 32\-bit geometry mask
(\f[C]mask\f[] argument) for the specified geometry (\f[C]geometry\f[]
argument).
.PP
This geometry mask is used together with the ray mask stored inside the
\f[C]mask\f[] field of the ray.
The primitives of the geometry are hit by the ray only if the bitwise
\f[C]and\f[] operation of the geometry mask with the ray mask is not 0.
This feature can be used to disable selected geometries for specifically
tagged rays, e.g.
to disable shadow casting for certain geometries.
.PP
Ray masks are disabled in Embree by default at compile time, and can be
enabled through the \f[C]EMBREE_RAY_MASK\f[] parameter in CMake.
One can query whether ray masks are enabled by querying the
\f[C]RTC_DEVICE_PROPERTY_RAY_MASK_SUPPORTED\f[] device property using
\f[C]rtcGetDeviceProperty\f[].
.SS EXIT STATUS
.PP
On failure an error code is set that can be queried using
\f[C]rtcGetDeviceError\f[].
.SS SEE ALSO
.PP
[RTCRay], [rtcGetDeviceProperty]