Tool

Tool

Classes

struct kuvio_plugin_info

Typedefs

typedef void(* kuvio_registration_func)(const char* ,...)
typedef void*(* kuvio_construct_func)(void*)
typedef void(* kuvio_destruct_func)(void*)
typedef int32_t(* kuvio_process_func)(void* , void*)
typedef void(* kuvio_notify_func)(void* , kuvio_event_type, void*)
typedef void(* kuvio_get_value_func)(const void* , void*)
typedef void(* kuvio_plugin_init_func)(kuvio_registration_func)
typedef void(* kuvio_plugin_info_func)(struct kuvio_plugin_info*)

Enumerations

enum kuvio_tool_info_type
enum kuvio_event_type
enum kuvio_execution_mode

Typedef Documentation

typedef void*(* kuvio_construct_func)(void*)

The type of a tool instance constructor function.

typedef void(* kuvio_destruct_func)(void*)

The type of a tool instance destructor function.

typedef void(* kuvio_get_value_func)(const void* , void*)

The type of a function that is used to retrieve default parameter values and values of meta-data entries.

typedef void(* kuvio_notify_func)(void* , kuvio_event_type, void*)

The type of a notification function that receives event notifications.

typedef void(* kuvio_plugin_info_func)(struct kuvio_plugin_info*)

The type of a function that returns basic information about a plug-in.

typedef void(* kuvio_plugin_init_func)(kuvio_registration_func)

The type of a function that registers tools in a plug-in.

typedef int32_t(* kuvio_process_func)(void* , void*)

The type of a processing function that actually performs the job of a registered tool.

typedef void(* kuvio_registration_func)(const char* ,...)

The type of the registration function that will be passed as a function pointer to a plugin initialization function when a plugin is loaded. The initialization function uses the registration function to register tool instances to the VisionAppster platform.

Enumeration Type Documentation

Event types.

Enumerator
kuvio_event_started

The processing graph containing the tool was just started. This event happens before the first call to process.

kuvio_event_stopped

The processing graph containing the tool was just stopped. This event happens after the last call to process.

Execution modes. A tool can specify a single execution mode or a bitwise OR of supported modes.

Enumerator
kuvio_execute_nonthreaded

The tool will be executed immediately when input data is available in the context of the thread that produced the last missing parameter. The thread may be different from time to time, but no concurrent calls will happen.

kuvio_execute_singlethreaded

The tool will be executed in a dedicated processing thread.

kuvio_execute_multithreaded

The tool will be executed by an arbitrary processing thread from a thread pool. Many calls may be active simultaneously.

kuvio_execute_any

All execution modes are supported.

Data identifiers for a tool registration call. There is usually no need to manually enter these values because the registration macros automatically use them where needed. They may be needed as a work-around if the number of variable arguments in a registration macro call grows larger than a particular C preprocessor implementation can handle.