lumiera_interface Struct Reference

#include "common/interface.h"

Description

Header for an interface, just the absolute necessary metadata.

Definition at line 371 of file interface.h.

Public Attributes
const char *	interface
	name of the interface (type)
unsigned	version
	major version, 0 means experimental
const char *	name
	name of this instance
size_t	size
	size of the whole interface structure (minor version)
LumieraInterface	descriptor
	metadata descriptor, itself a interface (or NULL)
LumieraInterface(*	acquire )(LumieraInterface self, LumieraInterface interfaces)
	Must be called before this interface is used.
void(*	release )(LumieraInterface self)
	called when finished using this interface must match the acquire calls

Member Data Documentation

interface

const char* interface

name of the interface (type)

Definition at line 374 of file interface.h.

Referenced by lumiera_interfaceregistry_interface_find(), and lumiera_interfaceregistry_interfacenode_find().

version

unsigned version

major version, 0 means experimental

Definition at line 377 of file interface.h.

Referenced by lumiera_interfaceregistry_interface_find(), and lumiera_interfaceregistry_interfacenode_find().

name

const char* name

name of this instance

Definition at line 380 of file interface.h.

Referenced by lumiera_interfaceregistry_interface_find(), and lumiera_interfaceregistry_interfacenode_find().

size

size_t size

size of the whole interface structure (minor version)

Definition at line 383 of file interface.h.

descriptor

LumieraInterface descriptor

metadata descriptor, itself a interface (or NULL)

Definition at line 386 of file interface.h.

acquire

LumieraInterface(* 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

Definition at line 397 of file interface.h.

release

void(* release) (LumieraInterface self)

called when finished using this interface must match the acquire calls

Parameters

self	pointer to the interface to be released

Definition at line 403 of file interface.h.

Collaboration diagram for lumiera_interface:

---

The documentation for this struct was generated from the following file:

• interface.h