Oyranos
git-devel
Oyranos is a full featured Color Management System
|
the basic API interface More...
#include <oyCMMapi_s.h>
Public Types | |
typedef int(* | oyCMMInit_f) (oyStruct_s *filter) |
optional CMM init function More... | |
typedef int(* | oyCMMReset_f) (oyStruct_s *filter) |
optional CMM reset 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... | |
typedef const char *(* | oyCMMGetText_f) (const char *select, oyNAME_e type, oyStruct_s *context) |
get strings from a CMM 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_Set (oyCMMapi_s *api, oyCMMInit_f init, oyCMMReset_f reset, oyCMMMessageFuncSet_f msg_set, const char *registration, int32_t version[3], int32_t module_api[3]) |
CMMapi member setter. More... | |
void | oyCMMapi_SetNext (oyCMMapi_s *api, oyCMMapi_s *next) |
chain CMMapi's More... | |
oyCMMapi_s * | oyCMMapi_GetNext (oyCMMapi_s *api) |
get next CMMapi More... | |
void | oyCMMapi_Release__Members (oyCMMapi_s_ *cmmapi) |
Custom CMMapi destructor. More... | |
int | oyCMMapi_Init__Members (oyCMMapi_s_ *cmmapi OY_UNUSED) |
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_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... | |
the basic API interface
The registration should provide keywords for selection. The api5_ member is missed for oyCMMapi5_s.
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.
[in] | cmmapi | CMMapi struct object |
object | NULL - means reference, the optional object triggers a real copy |
int oyCMMapi_Copy__Members | ( | oyCMMapi_s_ * | dst, |
oyCMMapi_s_ * | src | ||
) |
Custom CMMapi copy constructor.
Function oyCMMapi_Copy__Members
oyCMMapi_s * oyCMMapi_GetNext | ( | oyCMMapi_s * | api | ) |
get next CMMapi
Function oyCMMapi_GetNext
oyCMMapi_s forms a single linked list. The start must be set in oyCMMinfo_s to be parsed by the module loader.
api | the struct |
int oyCMMapi_Init__Members | ( | oyCMMapi_s_ *cmmapi | OY_UNUSED | ) |
Custom CMMapi constructor.
Function oyCMMapi_Init__Members
OYAPI oyCMMapi_s *OYEXPORT oyCMMapi_New | ( | oyObject_s | object | ) |
allocate a new CMMapi object
Function oyCMMapi_New
OYAPI int OYEXPORT oyCMMapi_Release | ( | oyCMMapi_s ** | cmmapi | ) |
release and possibly deallocate a oyCMMapi_s object
Function oyCMMapi_Release
[in,out] | cmmapi | CMMapi struct object |
void oyCMMapi_Release__Members | ( | oyCMMapi_s_ * | cmmapi | ) |
Custom CMMapi destructor.
Function oyCMMapi_Release__Members
void oyCMMapi_Set | ( | oyCMMapi_s * | api, |
oyCMMInit_f | init, | ||
oyCMMReset_f | reset, | ||
oyCMMMessageFuncSet_f | msg_set, | ||
const char * | registration, | ||
int32_t | version[3], | ||
int32_t | module_api[3] | ||
) |
CMMapi member setter.
Function oyCMMapi_Set
api | the struct |
init | custom initialisation |
reset | custom deinitialisation |
msg_set | message function setter |
registration | the modules Registration string, |
version | module version
|
module_api | tell compatibility with Oyranos API
|
void oyCMMapi_SetNext | ( | oyCMMapi_s * | api, |
oyCMMapi_s * | next | ||
) |
chain CMMapi's
Function oyCMMapi_SetNext
A oyCMMapi_s is initially not chained and will thus not be detected during parsing the oyCMMinfo_s structure. Append a CMMapi by searching for a empty place through oyCMMapi_s::oyCMMapi_GetNext ( api ) == NULL . Then append the new CMMapi with oyCMMapi_s::oyCMMapi_SetNext ( old_api, my_new_api ).
api | the struct |
next | struct to chain |
oyStruct_Copy_f oyCMMapi_s::copy |
Copy function.
oyObject_s oyCMMapi_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyCMMapi_s::release |
Release function.
const oyOBJECT_e oyCMMapi_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.