1rtcGetDeviceError(3) Embree Ray Tracing Kernels 3 rtcGetDeviceError(3)
2
3
4
5 NAME
6 rtcGetDeviceError - returns the error code of the device
7
8 SYNOPSIS
9 #include <embree3/rtcore.h>
10
11 RTCError rtcGetDeviceError(RTCDevice device);
12
13 DESCRIPTION
14 Each thread has its own error code per device. If an error occurs when
15 calling an API function, this error code is set to the occurred error
16 if it stores no previous error. The rtcGetDeviceError function reads
17 and returns the currently stored error and clears the error code. This
18 assures that the returned error code is always the first error occurred
19 since the last invocation of rtcGetDeviceError.
20
21 Possible error codes returned by rtcGetDeviceError are:
22
23 · RTC_ERROR_NONE: No error occurred.
24
25 · RTC_ERROR_UNKNOWN: An unknown error has occurred.
26
27 · RTC_ERROR_INVALID_ARGUMENT: An invalid argument was specified.
28
29 · RTC_ERROR_INVALID_OPERATION: The operation is not allowed for the
30 specified object.
31
32 · RTC_ERROR_OUT_OF_MEMORY: There is not enough memory left to complete
33 the operation.
34
35 · RTC_ERROR_UNSUPPORTED_CPU: The CPU is not supported as it does not
36 support the lowest ISA Embree is compiled for.
37
38 · RTC_ERROR_CANCELLED: The operation got canceled by a memory monitor
39 callback or progress monitor callback function.
40
41 When the device construction fails, rtcNewDevice returns NULL as
42 device. To detect the error code of a such a failed device construc‐
43 tion, pass NULL as device to the rtcGetDeviceError function. For all
44 other invocations of rtcGetDeviceError, a proper device pointer must be
45 specified.
46
47 EXIT STATUS
48 Returns the error code for the device.
49
50 SEE ALSO
51 [rtcSetDeviceErrorFunction]
52
53
54
55 rtcGetDeviceError(3)