All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
VuErrorHandlerConfig Struct Reference

Public Attributes

VuErrorHandlererrorHandler
 Error handler function to report Engine lifecycle-related errors.
 
void * clientData
 Client data to pass back when the error handler function is called.
 

Detailed Description

Data structure to configure the handling of Engine lifecycle-related errors via a callback after the Engine instance has been created.

Member Data Documentation

◆ errorHandler

VuErrorHandler* errorHandler

Error handler function to report Engine lifecycle-related errors.

Note
The parameter is ignored if set to NULL. In this case Engine does not have a way to notify its client about errors after Engine instance creation. The default value is NULL.

The parameter errorCode in the errorHandler function reports the code of an error, which occurs after the Engine instance has been already created and has a fundamental impact on the Engine lifecycle (e.g. Engine stopped internally due to receiving a report about an invalid license key or the platform-specific camera resource dropped by the operating system). The thread on which Engine invokes the handler function depends on the platform and the error (may or may not be the camera thread), there is no harmonized, cross-platform behavior.

See also the general documentation on callbacks and reentrancy in Engine.h.

◆ clientData

void* clientData

Client data to pass back when the error handler function is called.

Note
Default value is NULL.