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

the basic API interface More...

#include <oyCMMapi_s.h>

Inheritance diagram for oyCMMapi_s:
Inheritance graph
Collaboration diagram for oyCMMapi_s:
Collaboration graph

Public Types

typedef int(* oyCMMInit_f )(oyStruct_s *filter)
 optional CMM init function More...
 
typedef int(* oyCMMMessageFuncSet_f )(oyMessage_f message_func)
 optionaly sets a CMM message function More...
 
typedef int(* oyCMMCanHandle_f )(oyCMMQUERY_e type, uint32_t value)
 CMM feature declaration function. More...
 
typedef int(* oyCMMOptions_Check_f )(oyOptions_s *validate)
 a function to check options More...
 

Public Member Functions

OYAPI oyCMMapi_s *OYEXPORT oyCMMapi_New (oyObject_s object)
 allocate a new CMMapi object More...
 
OYAPI oyCMMapi_s *OYEXPORT oyCMMapi_Copy (oyCMMapi_s *cmmapi, oyObject_s object)
 copy or reference a CMMapi object More...
 
OYAPI int OYEXPORT oyCMMapi_Release (oyCMMapi_s **cmmapi)
 release and possibly deallocate a oyCMMapi_s object More...
 
void oyCMMapi_Release__Members (oyCMMapi_s_ *cmmapi)
 Custom CMMapi destructor. More...
 
int oyCMMapi_Init__Members (oyCMMapi_s_ *cmmapi)
 Custom CMMapi constructor. More...
 
int oyCMMapi_Copy__Members (oyCMMapi_s_ *dst, oyCMMapi_s_ *src)
 Custom CMMapi 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 basic API interface

Member Function Documentation

OYAPI oyCMMapi_s *OYEXPORT oyCMMapi_Copy ( oyCMMapi_s cmmapi,
oyObject_s  object 
)

copy or reference a CMMapi object

Function oyCMMapi_Copy

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

Parameters
[in]cmmapiCMMapi struct object
objectNULL - means reference, the optional object triggers a real copy

References oyOBJECT_CMM_API_S.

int oyCMMapi_Copy__Members ( oyCMMapi_s_ *  dst,
oyCMMapi_s_ *  src 
)

Custom CMMapi copy constructor.

Function oyCMMapi_Copy__Members

int oyCMMapi_Init__Members ( oyCMMapi_s_ *  cmmapi)

Custom CMMapi constructor.

Function oyCMMapi_Init__Members

OYAPI oyCMMapi_s *OYEXPORT oyCMMapi_New ( oyObject_s  object)

allocate a new CMMapi object

Function oyCMMapi_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyCMMapi_Release ( oyCMMapi_s **  cmmapi)

release and possibly deallocate a oyCMMapi_s object

Function oyCMMapi_Release

Parameters
[in,out]cmmapiCMMapi struct object

References oyOBJECT_CMM_API_S.

void oyCMMapi_Release__Members ( oyCMMapi_s_ *  cmmapi)

Custom CMMapi destructor.

Function oyCMMapi_Release__Members

Field Documentation

oyStruct_Copy_f oyCMMapi_s::copy

copy function

oyStruct_Release_f oyCMMapi_s::release

release function