lumiera_interface_struct Struct Reference
#include <interface.h>
Detailed Description
Header for an interface, just the absolute necessary metadata.Definition at line 377 of file interface.h.
Public Attributes | |
| LumieraInterface(* | acquire )(LumieraInterface self, LumieraInterface interfaces) |
| Must be called before this interface is used. | |
| LumieraInterface | descriptor |
| metadata descriptor, itself a interface (or NULL) | |
| lumiera_interfaceslot | functions [] |
| placeholder array for the following function slots, C++ doesn't support flexible arrays | |
| const char * | interface |
| name of the interface (type) | |
| const char * | name |
| name of this instance | |
| void(* | release )(LumieraInterface self) |
| called when finished using this interface must match the acquire calls | |
| size_t | size |
| size of the whole interface structure (minor version) | |
| unsigned | version |
| major version, 0 means experimental | |
Member Data Documentation
| LumieraInterface(* lumiera_interface_struct::acquire)(LumieraInterface self, LumieraInterface interfaces) |
Must be called before this interface is used.
might be nested.
- Parameters:
-
self pointer to the interface to be acquired interfaces pointer to a 'interfaces' interface giving plugins access to opening and closing interfaces, this is already opened and if a plugin wants to use other interfaces it has to store this pointer
- Returns:
- pointer to the interface or NULL on error
placeholder array for the following function slots, C++ doesn't support flexible arrays
Definition at line 413 of file interface.h.
| const char* lumiera_interface_struct::interface |
name of the interface (type)
Definition at line 380 of file interface.h.
Referenced by lumiera::register_and_open(), and lumiera::verify_validity().
| const char* lumiera_interface_struct::name |
name of this instance
Definition at line 386 of file interface.h.
Referenced by lumiera::register_and_open(), and lumiera::verify_validity().
| void(* lumiera_interface_struct::release)(LumieraInterface self) |
called when finished using this interface must match the acquire calls
- Parameters:
-
self pointer to the interface to be released
size of the whole interface structure (minor version)
Definition at line 389 of file interface.h.
Referenced by lumiera::register_and_open().
| unsigned lumiera_interface_struct::version |
major version, 0 means experimental
Definition at line 383 of file interface.h.
Referenced by lumiera::register_and_open(), and lumiera::verify_validity().
The documentation for this struct was generated from the following file:
- common/interface.h
