The CMM API resources struct to implement and set by a CMM. More...

#include <oyCMMinfo_s.h>

Inheritance diagram for oyCMMinfo_s:

Collaboration diagram for oyCMMinfo_s:

Public Types
typedef int(*	oyCMMinfoInit_f) (oyStruct_s *library)
	optional module init function More...

typedef int(*	oyCMMinfoReset_f) (oyStruct_s *library)
	optional module reset function More...

Public Member Functions
OYAPI oyCMMinfo_s *OYEXPORT	oyCMMinfo_New (oyObject_s object)
	allocate a new CMMinfo object More...

OYAPI oyCMMinfo_s *OYEXPORT	oyCMMinfo_Copy (oyCMMinfo_s *cmminfo, oyObject_s object)
	Copy or Reference a CMMinfo object. More...

OYAPI int OYEXPORT	oyCMMinfo_Release (oyCMMinfo_s **cmminfo)
	release and possibly deallocate a oyCMMinfo_s object More...

OYAPI const char *OYEXPORT	oyCMMinfo_GetCMM (oyCMMinfo_s *info)
	Get CMM signature, e.g. "lcms". More...

OYAPI const char *OYEXPORT	oyCMMinfo_GetVersion (oyCMMinfo_s *info)
	Get Backend Version. More...

OYAPI oyCMMGetText_f OYEXPORT	oyCMMinfo_GetTextF (oyCMMinfo_s *info)
	Get oyCMMGetText_f function. More...

OYAPI const char **OYEXPORT	oyCMMinfo_GetTexts (oyCMMinfo_s *info)
	Get keywords for oyCMMGetText_f function. More...

OYAPI int OYEXPORT	oyCMMinfo_GetCompatibility (oyCMMinfo_s *info)
	Get Oyranos compatibility. More...

OYAPI oyCMMapi_s *OYEXPORT	oyCMMinfo_GetApi (oyCMMinfo_s *info)
	Get the first api. More...

OYAPI void OYEXPORT	oyCMMinfo_SetApi (oyCMMinfo_s info, oyCMMapi_s first_api)
	Set the first api. More...

OYAPI oyIcon_s *OYEXPORT	oyCMMinfo_GetIcon (oyCMMinfo_s *info)
	Get icon. More...

OYAPI oyCMMinfoInit_f OYEXPORT	oyCMMinfo_GetInitF (oyCMMinfo_s *info)
	Get a init function. More...

OYAPI void OYEXPORT	oyCMMinfo_SetInitF (oyCMMinfo_s *info, oyCMMinfoInit_f init)
	Set a init function. More...

OYAPI oyCMMinfoReset_f OYEXPORT	oyCMMinfo_GetResetF (oyCMMinfo_s *info)
	Get a reset function. More...

OYAPI void OYEXPORT	oyCMMinfo_SetResetF (oyCMMinfo_s *info, oyCMMinfoReset_f reset)
	Set a reset function. More...

void	oyCMMinfo_Release__Members (oyCMMinfo_s_ *cmminfo)
	Custom CMMinfo destructor. More...

int	oyCMMinfo_Init__Members (oyCMMinfo_s_ *cmminfo OY_UNUSED)
	Custom CMMinfo constructor. More...

int	oyCMMinfo_Copy__Members (oyCMMinfo_s_ dst, oyCMMinfo_s_ src)
	Custom CMMinfo copy constructor. More...

Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module More...

const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump. More...

int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...

const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	get a additional string from a object More...

const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string. More...

Data Fields
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Data Fields inherited from oyStruct_s
const oyOBJECT_e	type_
	Type of object. More...

oyStruct_Copy_f	copy
	Copy function. More...

oyStruct_Release_f	release
	Release function. More...

oyObject_s	oy_
	Oyranos internal object. More...

Detailed Description

The CMM API resources struct to implement and set by a CMM.

Member Function Documentation

◆ oyCMMinfo_Copy()

OYAPI oyCMMinfo_s *OYEXPORT oyCMMinfo_Copy	(	oyCMMinfo_s *	cmminfo,
		oyObject_s	object
	)

Copy or Reference a CMMinfo object.

Function oyCMMinfo_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters

[in]	cmminfo	CMMinfo struct object
	object	NULL - means reference, the optional object triggers a real copy

◆ oyCMMinfo_Copy__Members()

int oyCMMinfo_Copy__Members	(	oyCMMinfo_s_ *	dst,
		oyCMMinfo_s_ *	src
	)

Custom CMMinfo copy constructor.

Function oyCMMinfo_Copy__Members

◆ oyCMMinfo_GetApi()

OYAPI oyCMMapi_s *OYEXPORT oyCMMinfo_GetApi ( oyCMMinfo_s * info )

Get the first api.

Function oyCMMinfo_GetApi

The returned struct must be casted to a according API. oyCMMapi_s forms a zero terminated list accesable through oyCMMapi_s::oyCMMapi_GetNext().

See also: oyCMMinfo_SetApi()

Version: Oyranos: 0.5.0

Date: 2012/09/14

Since: 2012/09/14 (Oyranos: 0.5.0)

◆ oyCMMinfo_GetCMM()

OYAPI const char *OYEXPORT oyCMMinfo_GetCMM ( oyCMMinfo_s * info )

Get CMM signature, e.g. "lcms".

Function oyCMMinfo_GetCMM

It contains only four bytes

Version: Oyranos: 0.5.0

Date: 2012/09/14

Since: 2012/09/14 (Oyranos: 0.5.0)

◆ oyCMMinfo_GetCompatibility()

OYAPI int OYEXPORT oyCMMinfo_GetCompatibility ( oyCMMinfo_s * info )

Get Oyranos compatibility.

Function oyCMMinfo_GetComp

last supported Oyranos CMM API : OYRANOS_VERSION

Version: Oyranos: 0.5.0

Date: 2012/09/14

Since: 2012/09/14 (Oyranos: 0.5.0)

◆ oyCMMinfo_GetIcon()

OYAPI oyIcon_s *OYEXPORT oyCMMinfo_GetIcon ( oyCMMinfo_s * info )

Get icon.

Function oyCMMinfo_GetIcon

zero terminated list of a icon pyramid

Version: Oyranos: 0.5.0

Date: 2012/09/14

Since: 2012/09/14 (Oyranos: 0.5.0)

◆ oyCMMinfo_GetInitF()

OYAPI oyCMMinfoInit_f OYEXPORT oyCMMinfo_GetInitF ( oyCMMinfo_s * info )

Get a init function.

Function oyCMMinfo_GetInitF

Get a init function for the actual oyCMMinfo_s.

See also: oyCMMinfo_SetInitF

Version: Oyranos: 0.9.5

Date: 2013/06/10

Since: 2013/06/10 (Oyranos: 0.9.5)

◆ oyCMMinfo_GetResetF()

OYAPI oyCMMinfoReset_f OYEXPORT oyCMMinfo_GetResetF ( oyCMMinfo_s * info )

Get a reset function.

Function oyCMMinfo_GetResetF

Get a reset function for the actual oyCMMinfo_s.

See also: oyCMMinfo_SetResetF

Version: Oyranos: 0.9.7

Date: 2019/09/03

Since: 2013/06/10 (Oyranos: 0.9.5)

◆ oyCMMinfo_GetTextF()

OYAPI oyCMMGetText_f OYEXPORT oyCMMinfo_GetTextF ( oyCMMinfo_s * info )

Get oyCMMGetText_f function.

Function oyCMMinfo_GetTextF

Version: Oyranos: 0.5.0

Date: 2012/09/14

Since: 2012/09/14 (Oyranos: 0.5.0)

◆ oyCMMinfo_GetTexts()

OYAPI const char **OYEXPORT oyCMMinfo_GetTexts ( oyCMMinfo_s * info )

Get keywords for oyCMMGetText_f function.

Function oyCMMinfo_GetTexts

zero terminated list for getText

Version: Oyranos: 0.5.0

Date: 2012/09/14

Since: 2012/09/14 (Oyranos: 0.5.0)

◆ oyCMMinfo_GetVersion()

OYAPI const char *OYEXPORT oyCMMinfo_GetVersion ( oyCMMinfo_s * info )

Get Backend Version.

Function oyCMMinfo_GetVersion

non translatable, eg "v1.17"

Version: Oyranos: 0.5.0

Date: 2012/09/14

Since: 2012/09/14 (Oyranos: 0.5.0)

◆ oyCMMinfo_Init__Members()

int oyCMMinfo_Init__Members ( oyCMMinfo_s_ *cmminfo OY_UNUSED )

Custom CMMinfo constructor.

Function oyCMMinfo_Init__Members

◆ oyCMMinfo_New()

OYAPI oyCMMinfo_s *OYEXPORT oyCMMinfo_New ( oyObject_s object )

allocate a new CMMinfo object

Function oyCMMinfo_New

◆ oyCMMinfo_Release()

OYAPI int OYEXPORT oyCMMinfo_Release ( oyCMMinfo_s ** cmminfo )

release and possibly deallocate a oyCMMinfo_s object

Function oyCMMinfo_Release

Parameters

[in,out] cmminfo CMMinfo struct object

◆ oyCMMinfo_Release__Members()

void oyCMMinfo_Release__Members ( oyCMMinfo_s_ * cmminfo )

Custom CMMinfo destructor.

Function oyCMMinfo_Release__Members

◆ oyCMMinfo_SetApi()

OYAPI void OYEXPORT oyCMMinfo_SetApi	(	oyCMMinfo_s *	info,
		oyCMMapi_s *	first_api
	)

Set the first api.

Function oyCMMinfo_SetApi

Set a zero terminated list, which will be visible by the module loader. You can do this inside the oyCMMinfo_s init function setable by oyCMMinfo_SetInitF(). Check if oyCMMinfo_s has already an api set through oyCMMinfo_GetApi(). Append more oyCMMapi_s 's through oyCMMapi_s::oyCMMapi_SetNext().

Version: Oyranos: 0.9.5

Date: 2013/06/11

Since: 2013/06/11 (Oyranos: 0.9.5)

◆ oyCMMinfo_SetInitF()

OYAPI void OYEXPORT oyCMMinfo_SetInitF	(	oyCMMinfo_s *	info,
		oyCMMinfoInit_f	init
	)

Set a init function.

Function oyCMMinfo_SetInitF

Set a init function for the actual oyCMMinfo_s.

See also: oyCMMinfo_SetApi() oyCMMinfo_GetInitF()

Version: Oyranos: 0.9.5

Date: 2013/06/11

Since: 2013/06/11 (Oyranos: 0.9.5)

◆ oyCMMinfo_SetResetF()

OYAPI void OYEXPORT oyCMMinfo_SetResetF	(	oyCMMinfo_s *	info,
		oyCMMinfoReset_f	reset
	)

Set a reset function.

Function oyCMMinfo_SetResetF

Set a reset function for the actual oyCMMinfo_s.

See also: oyCMMinfo_SetApi() oyCMMinfo_GetResetF()

Version: Oyranos: 0.9.7

Date: 2019/09/03

Since: 2013/06/10 (Oyranos: 0.9.5)

Field Documentation

◆ copy

oyStruct_Copy_f oyCMMinfo_s::copy

Copy function.

◆ oy_

oyObject_s oyCMMinfo_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

◆ release

oyStruct_Release_f oyCMMinfo_s::release

Release function.

◆ type_

const oyOBJECT_e oyCMMinfo_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Public Types

Public Member Functions

Data Fields