Oyranos Colour Management System API
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Data Fields
oyCMMinfo_s Struct Reference

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

#include <oyCMMinfo_s.h>

Inheritance diagram for oyCMMinfo_s:
Inheritance graph
Collaboration diagram for oyCMMinfo_s:
Collaboration graph

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 oyIcon_s *OYEXPORT oyCMMinfo_GetIcon (oyCMMinfo_s *info)
 Get icon. More...
 
void oyCMMinfo_Release__Members (oyCMMinfo_s_ *cmminfo)
 Custom CMMinfo destructor. More...
 
int oyCMMinfo_Init__Members (oyCMMinfo_s_ *cmminfo)
 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_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 get a text dump More...
 

Data Fields

oyStruct_Copy_f copy
 
oyStruct_Release_f release
 
- Data Fields inherited from oyStruct_s
oyStruct_Copy_f copy
 
oyStruct_Release_f release
 

Detailed Description

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

Member Function Documentation

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]cmminfoCMMinfo struct object
objectNULL - means reference, the optional object triggers a real copy

References oyOBJECT_CMM_INFO_S.

int oyCMMinfo_Copy__Members ( oyCMMinfo_s_ *  dst,
oyCMMinfo_s_ *  src 
)

Custom CMMinfo copy constructor.

Function oyCMMinfo_Copy__Members

OYAPI oyCMMapi_s *OYEXPORT oyCMMinfo_GetApi ( oyCMMinfo_s info)

Get the first api.

Function oyCMMinfo_GetApi

must be casted to a according API, zero terminated list

Version
Oyranos: 0.5.0
Date
2012/09/14
Since
2012/09/14 (Oyranos: 0.5.0)
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)
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)
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)
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)
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)
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)
int oyCMMinfo_Init__Members ( oyCMMinfo_s_ *  cmminfo)

Custom CMMinfo constructor.

Function oyCMMinfo_Init__Members

OYAPI oyCMMinfo_s *OYEXPORT oyCMMinfo_New ( oyObject_s  object)

allocate a new CMMinfo object

Function oyCMMinfo_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyCMMinfo_Release ( oyCMMinfo_s **  cmminfo)

release and possibly deallocate a oyCMMinfo_s object

Function oyCMMinfo_Release

Parameters
[in,out]cmminfoCMMinfo struct object

References oyOBJECT_CMM_INFO_S.

void oyCMMinfo_Release__Members ( oyCMMinfo_s_ *  cmminfo)

Custom CMMinfo destructor.

Function oyCMMinfo_Release__Members

Field Documentation

oyStruct_Copy_f oyCMMinfo_s::copy

copy function

oyStruct_Release_f oyCMMinfo_s::release

release function