oyConnectorImaging_s Struct Reference

node connection descriptor More...

#include <oyranos_cmm.h>

Inheritance diagram for oyConnectorImaging_s:

Collaboration diagram for oyConnectorImaging_s:

Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release
oyCMMGetText_f	getText
const char **	texts
char *	connector_type
oyCMMFilterSocket_MatchPlug_f	filterSocket_MatchPlug
int	is_plug
oyDATATYPE_e *	data_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_e *	channel_types
int	channel_types_n
int	id
Data Fields inherited from oyConnector_s

Additional Inherited Members
Public Member Functions inherited from oyConnector_s
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
int	oyConnector_SetName (oyConnector_s *obj, const char *string, oyNAME_e type)
	set the names in a connector
const char *	oyConnector_GetName (oyConnector_s *obj, oyNAME_e type)
	set the names in a connector
int	oyConnector_IsPlug (oyConnector_s *obj)
	is this connector a plug or a socket
int	oyConnector_SetIsPlug (oyConnector_s *obj, int is_plug)
	Set this connector as a plug or a socket.
const char *	oyConnector_GetReg (oyConnector_s *obj)
	Get the registration for the connection type.
int	oyConnector_SetReg (oyConnector_s *obj, const char *type_registration)
	Set this connectors type string.
int	oyConnector_SetMatch (oyConnector_s *obj, oyCMMFilterSocket_MatchPlug_f func)
	Set this connectors type check function.
oyCMMFilterSocket_MatchPlug_f	oyConnector_GetMatch (oyConnector_s *obj)
	Set this connectors type check function.

---

Detailed Description

node connection descriptor

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.10

Since:

2008/07/26 (Oyranos: 0.1.8)

Date:

2010/06/25

---

Field Documentation

int oyConnectorImaging_s::can_interwoven

can read continuous channels

int oyConnectorImaging_s::can_planar

can read separated channels

int oyConnectorImaging_s::can_revert

revert 1 -> 0 and 0 -> 1

int oyConnectorImaging_s::can_subpixel

understand subpixel order

int oyConnectorImaging_s::can_swap

can swap colour channels (BGR)

int oyConnectorImaging_s::can_swap_bytes

non host byte order

oyCHANNELTYPE_e* oyConnectorImaging_s::channel_types

describe which channel types the connector requires

int oyConnectorImaging_s::channel_types_n

count in channel_types

char* oyConnectorImaging_s::connector_type

The following types should have a "data" attribute in the application level as these connectors pass the imaging data.

• a data manipulator. e.g. a normal filter - "//imaging/manipulator.data"
• a data generator, e.g. checkerboard, gradient "//imaging/generator.data"
• a pixel data provider, e.g. oyFILTER_TYPE_IMAGE "//imaging/image.data"
• observer, a endpoint, only input, e.g. text log, thumbnail viewer "//imaging/observer.data"
• a routing element, without data altering "//imaging/splitter.rectangle.data"
• combines or splits image data, e.g. blending "//imaging/blender.rectangle.data"
• converts pixel layout to other formats "//imaging/pixel.convertor.data"
• converts pixel layout to other formats, with precission loss, e.g. float -> uint8_t, only relevant for output connectors "//imaging/pixel.convertor.lossy.data"
• combines gray channels, e.g. from colour "//imaging/combiner.channels.data"
• provides gray scale views of channels "//imaging/splitter.channels.data"

The following types should have a "text" attribute in the application level as this connector type passes text.

• provides values or text, only output "///analysis.text"

Reimplemented from oyConnector_s.

oyStruct_Copy_f oyConnectorImaging_s::copy

copy function

Reimplemented from oyConnector_s.

oyDATATYPE_e* oyConnectorImaging_s::data_types

supported float's and int's

int oyConnectorImaging_s::data_types_n

elements in data_types array

oyCMMFilterSocket_MatchPlug_f oyConnectorImaging_s::filterSocket_MatchPlug

Check if two oyCMMapi7_s filter connectors of type oyConnector_s can match each other inside a given socket and a plug. For a imaging plugin just add here oyFilterSocket_MatchImagingPlug

Reimplemented from oyConnector_s.

oyCMMGetText_f oyConnectorImaging_s::getText

translated UI texts

Reimplemented from oyConnector_s.

int oyConnectorImaging_s::id

relative to oyFilterCore_s, e.g. 1 connector is mandatory or optional, important for modules

int oyConnectorImaging_s::is_plug

1 - make requests and receive data, by part of oyFilterPlug_s; 0 - receive requests and provide data, oyFilterSocket_s

Reimplemented from oyConnector_s.

oyStruct_Release_f oyConnectorImaging_s::release

release function

Reimplemented from oyConnector_s.

const char** oyConnectorImaging_s::texts

zero terminated categories for getText. Support at least "name", e.g. {"name",0}

The "name" texts shall include information about the connector. The oyNAME_NICK is a very small shorthand for the cnnnector. e.g. "Img" oyNAME_NAME should contain the connectors name, e.g. "Image" oyNAME_DESCRIPTION can contain some help text, e.g. "Image[PNG] File Input".

Reimplemented from oyConnector_s.