VPI - Vision Programming Interface

0.3.7 Release

User-Defined Function

Typedefs

typedef VPIStatus(* VPIUserFunction) (void *)
 Pointer to user function. More...
 

Functions

VPIStatus vpiSubmitUserFunction (VPIStream stream, VPIUserFunction func, void *userData)
 Pushes a command that will invoke a custom host-side function after all prior commands have been processed. More...
 

Detailed Description

Submits a user-defined function to be executed on the stream.

Typedef Documentation

◆ VPIUserFunction

typedef VPIStatus(* VPIUserFunction) (void *)

#include <vpi/Types.h>

Pointer to user function.

Parameters
void* [in] callback data

Definition at line 546 of file Types.h.

Function Documentation

◆ vpiSubmitUserFunction()

VPIStatus vpiSubmitUserFunction ( VPIStream  stream,
VPIUserFunction  func,
void *  userData 
)

#include <vpi/UserFunction.h>

Pushes a command that will invoke a custom host-side function after all prior commands have been processed.

The execution of commands submitted after this call is suspended until the callback is finished.

Parameters
stream[in] a stream handle
func[in] Pointer to the user function to be executed.
userData[in] pointer that will be passed unchanged to the user function
Returns
an error code on failure else VPI_SUCCESS