Lumiera  0.pre.03
»edit your freedom«
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

LumieraInterface(* acquire )(LumieraInterface self, LumieraInterface interfaces)
 Must be called before this interface is used. More...
 
LumieraInterface descriptor
 metadata descriptor, itself a interface (or NULL)
 
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 More...
 
size_t size
 size of the whole interface structure (minor version)
 
unsigned version
 major version, 0 means experimental
 

Member Data Documentation

◆ acquire

LumieraInterface(* acquire) (LumieraInterface self, LumieraInterface interfaces)

Must be called before this interface is used.

might be nested.

Parameters
selfpointer to the interface to be acquired
interfacespointer 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
selfpointer 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: