oyCMMapi_s Struct Reference

the basic API interface More...

#include <oyranos_cmm.h>

Inheritance diagram for oyCMMapi_s:

Collaboration diagram for oyCMMapi_s:

Public Types
typedef int(*	oyCMMCanHandle_f )(oyCMMQUERY_e type, uint32_t value)
	CMM feature declaration function.
typedef int(*	oyCMMInit_f )(oyStruct_s *filter)
	optional CMM init function
typedef int(*	oyCMMMessageFuncSet_f )(oyMessage_f message_func)
	optionaly sets a CMM message function
typedef int(*	oyCMMOptions_Check_f )(oyOptions_s *validate)
	a function to check options
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]

---

Detailed Description

the basic API interface

The registration should provide keywords for selection. The api5_ member is missed for oyCMMapi5_s.

Version:

Oyranos: 0.1.10

Since:

2009/01/16 (Oyranos: 0.1.10)

Date:

2009/01/16

---

Field Documentation

oyPointer oyCMMapi_s::dummya

keep to zero

Reimplemented in oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, and oyCMMapi3_s.

oyPointer oyCMMapi_s::dummyb

keep to zero

Reimplemented in oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, and oyCMMapi3_s.

oyPointer oyCMMapi_s::dummyc

keep to zero

Reimplemented in oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, and oyCMMapi3_s.

int32_t oyCMMapi_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 in oyCMMapi10_s, oyCMMapi9_s, oyCMMapi8_s, oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, oyCMMapiFilter_s, and oyCMMapi3_s.

oyCMMapi_s* oyCMMapi_s::next

the next CMM api

Reimplemented in oyCMMapi10_s, oyCMMapi9_s, oyCMMapi8_s, oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, oyCMMapiFilter_s, and oyCMMapi3_s.

oyCMMInit_f oyCMMapi_s::oyCMMInit

Reimplemented in oyCMMapi10_s, oyCMMapi9_s, oyCMMapi8_s, oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, oyCMMapiFilter_s, and oyCMMapi3_s.

oyCMMMessageFuncSet_f oyCMMapi_s::oyCMMMessageFuncSet

Reimplemented in oyCMMapi10_s, oyCMMapi9_s, oyCMMapi8_s, oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, oyCMMapiFilter_s, and oyCMMapi3_s.

const char* oyCMMapi_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 in oyCMMapi10_s, oyCMMapi9_s, oyCMMapi8_s, oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, oyCMMapiFilter_s, and oyCMMapi3_s.

oyOBJECT_e oyCMMapi_s::type

struct type oyOBJECT_CMM_API7_S

Reimplemented in oyCMMapi10_s, oyCMMapi9_s, oyCMMapi8_s, oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, oyCMMapiFilter_s, and oyCMMapi3_s.

Referenced by oyCMMapis_s::oyCMMapis_MoveIn().

int32_t oyCMMapi_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 in oyCMMapi10_s, oyCMMapi9_s, oyCMMapi8_s, oyCMMapi4_s, oyCMMapi6_s, oyCMMapi7_s, oyCMMapi5_s, oyCMMapiFilter_s, and oyCMMapi3_s.