oyConnector_s Struct Reference
[Conversion API's]

a filter connection description structure

This structure holds informations about the connection capabilities. It holds common structure members of oyFilterPlug_s and oyFilterSocket_s. More...

#include <oyranos_alpha.h>


Data Fields

oyOBJECT_e type_
oyStruct_Copy_f copy
oyStruct_Release_f release
oyObject_s oy_
oyName_s name
oyCONNECTOR_e connector_type
int is_plug
oyDATATYPE_edata_types
int data_types_n
int can_planar
int can_interwoven
int can_swap
int can_swap_bytes
int can_revert
int can_subpixel
oyCHANNELTYPE_echannel_types
int channel_types_n
int id

Related Functions

(Note that these are not member functions.)

OYAPI oyConnector_s *OYEXPORT oyConnector_New (oyObject_s object)
 allocate a new Connector object
OYAPI oyConnector_s *OYEXPORT oyConnector_Copy (oyConnector_s *obj, oyObject_s object)
 copy or reference a Connector object
OYAPI int OYEXPORT oyConnector_Release (oyConnector_s **obj)
 release and possibly deallocate a Connector object


Detailed Description

a filter connection description structure

This structure holds informations about the connection capabilities. It holds common structure members of oyFilterPlug_s and oyFilterSocket_s.

To signal a value is not initialised or does not apply, set the according integer value to -1.

Todo:
generalise the connector properties
Version:
Oyranos: 0.1.8
Since:
2008/07/26 (Oyranos: 0.1.8)
Date:
2008/07/29

Field Documentation

can read continuous channels

can read separated channels

revert 1 -> 0 and 0 -> 1

understand subpixel order

can swap colour channels (BGR)

non host byte order

describe which channel types the connector requires

Referenced by oyConnector_Release().

count in channel_types

oyStruct_Copy_f oyConnector_s::copy

copy function

supported float's and int's

Referenced by oyConnector_Release().

elements in data_types array

Referenced by oyConnector_Release().

relative to oyFilter_s, e.g. 1 connector is mandatory or optional, important for backends

make requests and receive data, by part of oyFilterPlug_s

e.g."Img", "Image", "Image Socket"

Referenced by oyConnector_Release().

base object

Referenced by oyConnector_Copy(), and oyConnector_Release().

oyStruct_Release_f oyConnector_s::release

release function

Referenced by oyConnector_New().

struct type oyOBJECT_CONNECTOR_S

Referenced by oyConnector_Release(), and oyFilterNode_s::oyFilterNode_ConnectorMatch().


Generated on Tue Mar 10 09:46:42 2009 for Oyranos by  doxygen 1.5.8