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
oyCMMapi5_s Struct Reference

Module or script loader. More...

#include <oyCMMapi5_s.h>

Inheritance diagram for oyCMMapi5_s:
Inheritance graph
Collaboration diagram for oyCMMapi5_s:
Collaboration graph

Public Types

typedef int(* oyCMMFilterSocket_MatchPlug_f )(oyFilterSocket_s *socket, oyFilterPlug_s *plug)
 verify connectors matching each other More...
 
- Public Types inherited from oyCMMapi_s
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 oyCMMapi5_s *OYEXPORT oyCMMapi5_New (oyObject_s object)
 allocate a new CMMapi5 object More...
 
OYAPI oyCMMapi5_s *OYEXPORT oyCMMapi5_Copy (oyCMMapi5_s *cmmapi5, oyObject_s object)
 copy or reference a CMMapi5 object More...
 
OYAPI int OYEXPORT oyCMMapi5_Release (oyCMMapi5_s **cmmapi5)
 release and possibly deallocate a oyCMMapi5_s object More...
 
void oyCMMapi5_Release__Members (oyCMMapi5_s_ *cmmapi5)
 Custom CMMapi5 destructor. More...
 
int oyCMMapi5_Init__Members (oyCMMapi5_s_ *cmmapi5)
 Custom CMMapi5 constructor. More...
 
int oyCMMapi5_Copy__Members (oyCMMapi5_s_ *dst, oyCMMapi5_s_ *src)
 Custom CMMapi5 copy constructor. More...
 
- Public Member Functions inherited from oyCMMapi_s
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 oyCMMapi_s
oyStruct_Copy_f copy
 
oyStruct_Release_f release
 
- Data Fields inherited from oyStruct_s
oyStruct_Copy_f copy
 
oyStruct_Release_f release
 

Detailed Description

Module or script loader.

Member Function Documentation

OYAPI oyCMMapi5_s *OYEXPORT oyCMMapi5_Copy ( oyCMMapi5_s cmmapi5,
oyObject_s  object 
)

copy or reference a CMMapi5 object

Function oyCMMapi5_Copy

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

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

References oyOBJECT_CMM_API5_S.

int oyCMMapi5_Copy__Members ( oyCMMapi5_s_ *  dst,
oyCMMapi5_s_ *  src 
)

Custom CMMapi5 copy constructor.

Function oyCMMapi5_Copy__Members

int oyCMMapi5_Init__Members ( oyCMMapi5_s_ *  cmmapi5)

Custom CMMapi5 constructor.

Function oyCMMapi5_Init__Members

OYAPI oyCMMapi5_s *OYEXPORT oyCMMapi5_New ( oyObject_s  object)

allocate a new CMMapi5 object

Function oyCMMapi5_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyCMMapi5_Release ( oyCMMapi5_s **  cmmapi5)

release and possibly deallocate a oyCMMapi5_s object

Function oyCMMapi5_Release

Parameters
[in,out]cmmapi5CMMapi5 struct object

References oyOBJECT_CMM_API5_S.

void oyCMMapi5_Release__Members ( oyCMMapi5_s_ *  cmmapi5)

Custom CMMapi5 destructor.

Function oyCMMapi5_Release__Members

Field Documentation

oyStruct_Copy_f oyCMMapi5_s::copy

copy function

oyStruct_Release_f oyCMMapi5_s::release

release function