1rtcSetDeviceErrorFunction(E3m)bree Ray Tracing Kernelsrt3cSetDeviceErrorFunction(3)
2
3
4
5 NAME
6 rtcSetDeviceErrorFunction - sets an error callback function for the device
7
8 SYNOPSIS
9 #include <embree3/rtcore.h>
10
11 typedef void (*RTCErrorFunction)(
12 void* userPtr,
13 RTCError code,
14 const char* str
15 );
16
17 void rtcSetDeviceErrorFunction(
18 RTCDevice device,
19 RTCErrorFunction error,
20 void* userPtr
21 );
22
23 DESCRIPTION
24 Using the rtcSetDeviceErrorFunction call, it is possible to set a call‐
25 back function (error argument) with payload (userPtr argument), which
26 is called whenever an error occurs for the specified device (device ar‐
27 gument).
28
29 Only a single callback function can be registered per device, and fur‐
30 ther invocations overwrite the previously set callback function. Pass‐
31 ing NULL as function pointer disables the registered callback function.
32
33 When the registered callback function is invoked, it gets passed the
34 user-defined payload (userPtr argument as specified at registration
35 time), the error code (code argument) of the occurred error, as well as
36 a string (str argument) that further describes the error.
37
38 The error code is also set if an error callback function is registered.
39
40 EXIT STATUS
41 On failure an error code is set that can be queried using rtcGetDe‐
42 viceError.
43
44 SEE ALSO
45 [rtcGetDeviceError]
46
47
48
49 rtcSetDeviceErrorFunction(3)