oyCMMapi7_s Struct Reference

data processing node More...

#include <oyranos_cmm.h>

Inheritance diagram for oyCMMapi7_s:

Collaboration diagram for oyCMMapi7_s:

Public Types
typedef int(*	oyCMMFilterPlug_Run_f )(oyFilterPlug_s *plug, oyPixelAccess_s *pixel_access)
	get a pixel or channel from the previous filter

Data Fields
oyOBJECT_e	type
oyPointer	dummya
oyPointer	dummyb
oyPointer	dummyc
oyCMMapi_s *	next
oyCMMInit_f	oyCMMInit
oyCMMMessageFuncSet_f	oyCMMMessageFuncSet
const char *	registration
int32_t	version [3]
int32_t	module_api [3]
oyCMMFilterPlug_Run_f	oyCMMFilterPlug_Run
char	context_type [8]
oyConnector_s **	plugs
uint32_t	plugs_n
uint32_t	plugs_last_add
oyConnector_s **	sockets
uint32_t	sockets_n
uint32_t	sockets_last_add
char **	properties
Data Fields inherited from oyCMMapiFilter_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyCMMapi_s

---

Detailed Description

data processing node

The structure forms a node element in a directed acyclic graph. It's connectors allow to communicate cababilities and semantics. This node type acts mostly on data processing.

It is possible to delegate parameter or context creation to other specialised filter types. The filter context can be stored in oyFilterNode_s::backend_data if the oyCMMapi7_s::context_type is filled with a understood format hint. The registration should provide keywords to select the processing function.

(in CM jargon - interpolator)

Version:

Oyranos: 0.1.10

Since:

2008/12/15 (Oyranos: 0.1.9)

Date:

2008/12/27

---

Field Documentation

char oyCMMapi7_s::context_type[8]

e.g. oyCMMFilterPlug_Run specific context data "lcCC"

Referenced by oyFilterGraph_s::oyFilterGraph_PrepareContexts().

oyPointer oyCMMapi7_s::dummya

keep to zero

Reimplemented from oyCMMapi_s.

oyPointer oyCMMapi7_s::dummyb

keep to zero

Reimplemented from oyCMMapi_s.

oyPointer oyCMMapi7_s::dummyc

keep to zero

Reimplemented from oyCMMapi_s.

int32_t oyCMMapi7_s::module_api[3]

0: last major Oyranos version during development time, e.g. 0 1: last minor Oyranos version during development time, e.g. 0 2: last Oyranos patch version during development time, e.g. 10

Reimplemented from oyCMMapiFilter_s.

oyCMMapi_s* oyCMMapi7_s::next

the next CMM api

Reimplemented from oyCMMapiFilter_s.

oyCMMFilterPlug_Run_f oyCMMapi7_s::oyCMMFilterPlug_Run

mandatory for all filters; Special care has to taken for the oyPixelAccess_s argument to this function.

Referenced by oyConversion_s::oyConversion_GetImage(), oyConversion_s::oyConversion_GetOnePixel(), oyConversion_s::oyConversion_RunPixels(), and oyFilterPlug_s::oyFilterPlug_ResolveImage().

oyCMMInit_f oyCMMInit

Reimplemented from oyCMMapiFilter_s.

oyCMMMessageFuncSet_f oyCMMMessageFuncSet

Reimplemented from oyCMMapiFilter_s.

oyConnector_s** oyCMMapi7_s::plugs

We have to tell about valid input and output connectors, by passively providing enough informations.

Referenced by oyFilterNode_s::oyFilterNode_GetConnectorPos(), and oyFilterNode_s::oyFilterNode_ShowConnector().

uint32_t oyCMMapi7_s::plugs_last_add

additional allowed number for last input connector, e.g. typical 0

Referenced by oyFilterNode_s::oyFilterNode_Create(), oyFilterNode_s::oyFilterNode_EdgeCount(), and oyFilterNode_s::oyFilterNode_GetConnectorPos().

uint32_t oyCMMapi7_s::plugs_n

number of different plugs

Referenced by oyFilterNode_s::oyFilterNode_Create(), oyFilterNode_s::oyFilterNode_EdgeCount(), oyFilterNode_s::oyFilterNode_GetConnectorPos(), oyFilterNode_s::oyFilterNode_ShowConnector(), and oyFilterPlug_s::oyFilterPlug_ResolveImage().

char** oyCMMapi7_s::properties

A zero terminated list of strings. The semantics are plugin defined. e.g.: {"key1=value1","key2=value2",0}

const char* oyCMMapi7_s::registration

e.g. "sw/oyranos.org/colour.tonemap.imaging/hydra.shiva.CPU.GPU" or "sw/oyranos.org/colour/icc.lcms.CPU", see as well Registration

Reimplemented from oyCMMapiFilter_s.

oyConnector_s** oyCMMapi7_s::sockets

the socket description

Referenced by oyFilterNode_s::oyFilterNode_GetConnectorPos(), and oyFilterNode_s::oyFilterNode_ShowConnector().

uint32_t oyCMMapi7_s::sockets_last_add

additional allowed number for last output connector, e.g. typical 0

Referenced by oyFilterNode_s::oyFilterNode_Create(), oyFilterNode_s::oyFilterNode_EdgeCount(), and oyFilterNode_s::oyFilterNode_GetConnectorPos().

uint32_t oyCMMapi7_s::sockets_n

number of sockets

Referenced by oyFilterNode_s::oyFilterNode_Create(), oyFilterNode_s::oyFilterNode_EdgeCount(), oyFilterNode_s::oyFilterNode_GetConnectorPos(), and oyFilterNode_s::oyFilterNode_ShowConnector().

oyOBJECT_e oyCMMapi7_s::type

struct type oyOBJECT_CMM_API7_S

Reimplemented from oyCMMapiFilter_s.

int32_t oyCMMapi7_s::version[3]

0: major - should be stable for the live time of a filter,
1: minor - mark new features,
2: patch version - correct errors

Reimplemented from oyCMMapiFilter_s.