oyCMMapi4_s Struct Reference

context creator More...

#include <oyranos_cmm.h>

Inheritance diagram for oyCMMapi4_s:

Collaboration diagram for oyCMMapi4_s:

Public Types
typedef oyPointer(*	oyCMMFilterNode_ContextToMem_f )(oyFilterNode_s *node, size_t *size, oyAlloc_f allocateFunc)
	store a CMM filter context into a memory blob
typedef char *(*	oyCMMFilterNode_GetText_f )(oyFilterNode_s *node, oyNAME_e type, oyAlloc_f allocateFunc)
	describe a CMM filter context

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]
oyCMMFilterNode_ContextToMem_f	oyCMMFilterNode_ContextToMem
oyCMMFilterNode_GetText_f	oyCMMFilterNode_GetText
char	context_type [8]
oyCMMui_s *	ui
Data Fields inherited from oyCMMapiFilter_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyCMMapi_s

---

Detailed Description

context creator

The structure contains functions to specify and prepare parameters or a context dedicated for a filter node class. UI elements can be included for manual settings. As per definition the result of this filter is serialised, and can therefore be cached by Oyranos' core.

Different filters have to provide this struct each one per filter.

The ::oyCMMFilterNode_ContextToMem

See also:

oyCMMFilterNode_ContextToMem_f should be implemented in case the context_type is set to a context data type.

Todo:

in commit 5a2b7396 the connection descriptors where moved to oyCMMapi7_s. For a context, which must be created from the processing data this is not relyable, as the interpolator can not be shure that the context plug-in supports the same or larger set of connectors.

Version:

Oyranos: 0.1.10

Since:

2008/06/24 (Oyranos: 0.1.8)

Date:

2009/09/06

---

Field Documentation

char oyCMMapi4_s::context_type[8]

the data type of the context returned by oyCMMapi4_s::oyCMMFilterNode_ContextToMem_f, mandatory for a set oyCMMFilterNode_ContextToMem e.g. oyCOLOUR_ICC_DEVICE_LINK / "oyDL"

oyPointer oyCMMapi4_s::dummya

keep to zero

Reimplemented from oyCMMapi_s.

oyPointer oyCMMapi4_s::dummyb

keep to zero

Reimplemented from oyCMMapi_s.

oyPointer oyCMMapi4_s::dummyc

keep to zero

Reimplemented from oyCMMapi_s.

int32_t oyCMMapi4_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* oyCMMapi4_s::next

the next CMM api

Reimplemented from oyCMMapiFilter_s.

oyCMMFilterNode_ContextToMem_f oyCMMapi4_s::oyCMMFilterNode_ContextToMem

mandatory for "//colour/icc" context producing filters

Referenced by oyFilterGraph_s::oyFilterGraph_PrepareContexts().

oyCMMFilterNode_GetText_f oyCMMapi4_s::oyCMMFilterNode_GetText

optional for a set oyCMMFilterNode_ContextToMem, used to override a Oyranos side hash creation

Referenced by oyFilterNode_s::oyFilterNode_GetText().

oyCMMInit_f oyCMMapi4_s::oyCMMInit

Reimplemented from oyCMMapiFilter_s.

oyCMMMessageFuncSet_f oyCMMapi4_s::oyCMMMessageFuncSet

Reimplemented from oyCMMapiFilter_s.

const char* oyCMMapi4_s::registration

e.g. "sw/oyranos.org/imaging/scale" or "sw/oyranos.org/colour/icc.lcms", see as well Registration

Reimplemented from oyCMMapiFilter_s.

Referenced by oyFilterGraph_s::oyFilterGraph_GetNode().

oyOBJECT_e oyCMMapi4_s::type

struct type oyOBJECT_CMM_API4_S

Reimplemented from oyCMMapiFilter_s.

oyCMMui_s* oyCMMapi4_s::ui

a UI description Obligatory is a implemented oyCMMapi4_s::ui->getText( x, y ) call. The x argument shall cover "name" and "help" a UI description

Referenced by oyFilterCore_s::oyFilterCore_GetName(), and oyFilterNode_s::oyFilterNode_UiGet().

int32_t oyCMMapi4_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.

Referenced by oyFilterCore_s::oyFilterCore_GetText().