Oyranos
git-devel
Oyranos is a full featured Color Management System
|
Generic data exchange. More...
#include <oyCMMapi10_s.h>
Public Types | |
typedef int(* | oyMOptions_Handle_f) (oyOptions_s *options, const char *command, oyOptions_s **result) |
generic data exchange More... | |
Public Types inherited from oyCMMapi_s | |
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 oyCMMapi10_s *OYEXPORT | oyCMMapi10_New (oyObject_s object) |
allocate a new CMMapi10 object More... | |
OYAPI oyCMMapi10_s *OYEXPORT | oyCMMapi10_Copy (oyCMMapi10_s *cmmapi10, oyObject_s object) |
Copy or Reference a CMMapi10 object. More... | |
OYAPI int OYEXPORT | oyCMMapi10_Release (oyCMMapi10_s **cmmapi10) |
release and possibly deallocate a oyCMMapi10_s object More... | |
OYAPI int OYEXPORT | oyCMMapi10_SetBackendContext (oyCMMapi10_s *api, oyPointer_s *ptr) |
set filter type specific runtime data More... | |
OYAPI oyPointer_s *OYEXPORT | oyCMMapi10_GetBackendContext (oyCMMapi10_s *api) |
get filter type specific runtime data More... | |
OYAPI oyCMMapi10_s *OYEXPORT | oyCMMapi10_Create (oyCMMInit_f init, oyCMMReset_f reset, oyCMMMessageFuncSet_f msg_set, const char *registration, int32_t version[3], int32_t module_api[3], oyCMMGetText_f getText, const char **texts, oyMOptions_Handle_f oyMOptions_Handle, oyObject_s object) |
Custom CMMapi10 constructor. More... | |
void | oyCMMapi10_Release__Members (oyCMMapi10_s_ *cmmapi10) |
Custom CMMapi10 destructor. More... | |
int | oyCMMapi10_Init__Members (oyCMMapi10_s_ *cmmapi10 OY_UNUSED) |
Custom CMMapi10 constructor. More... | |
int | oyCMMapi10_Copy__Members (oyCMMapi10_s_ *dst, oyCMMapi10_s_ *src) |
Custom CMMapi10 copy constructor. More... | |
Public Member Functions inherited from oyCMMapiFilter_s | |
OYAPI oyCMMapiFilter_s *OYEXPORT | oyCMMapiFilter_New (oyObject_s object) |
allocate a new CMMapiFilter object More... | |
OYAPI oyCMMapiFilter_s *OYEXPORT | oyCMMapiFilter_Copy (oyCMMapiFilter_s *cmmapifilter, oyObject_s object) |
Copy or Reference a CMMapiFilter object. More... | |
OYAPI int OYEXPORT | oyCMMapiFilter_Release (oyCMMapiFilter_s **cmmapifilter) |
release and possibly deallocate a oyCMMapiFilter_s object More... | |
OYAPI int OYEXPORT | oyCMMapiFilter_SetBackendContext (oyCMMapiFilter_s *api, oyPointer_s *ptr) |
set filter type specific runtime data More... | |
OYAPI oyPointer_s *OYEXPORT | oyCMMapiFilter_GetBackendContext (oyCMMapiFilter_s *api) |
get filter type specific runtime data More... | |
void | oyCMMapiFilter_Release__Members (oyCMMapiFilter_s_ *cmmapifilter) |
Custom CMMapiFilter destructor. More... | |
int | oyCMMapiFilter_Init__Members (oyCMMapiFilter_s_ *cmmapifilter OY_UNUSED) |
Custom CMMapiFilter constructor. More... | |
int | oyCMMapiFilter_Copy__Members (oyCMMapiFilter_s_ *dst, oyCMMapiFilter_s_ *src) |
Custom CMMapiFilter 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_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... | |
oyMOptions_Handle_f | oyMOptions_Handle |
Data Fields inherited from oyCMMapiFilter_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... | |
Data Fields inherited from oyCMMapi_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... | |
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... | |
Generic data exchange.
OYAPI oyCMMapi10_s *OYEXPORT oyCMMapi10_Copy | ( | oyCMMapi10_s * | cmmapi10, |
oyObject_s | object | ||
) |
Copy or Reference a CMMapi10 object.
Function oyCMMapi10_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | cmmapi10 | CMMapi10 struct object |
object | NULL - means reference, the optional object triggers a real copy |
int oyCMMapi10_Copy__Members | ( | oyCMMapi10_s_ * | dst, |
oyCMMapi10_s_ * | src | ||
) |
Custom CMMapi10 copy constructor.
Function oyCMMapi10_Copy__Members
OYAPI oyCMMapi10_s *OYEXPORT oyCMMapi10_Create | ( | oyCMMInit_f | init, |
oyCMMReset_f | reset, | ||
oyCMMMessageFuncSet_f | msg_set, | ||
const char * | registration, | ||
int32_t | version[3], | ||
int32_t | module_api[3], | ||
oyCMMGetText_f | getText, | ||
const char ** | texts, | ||
oyMOptions_Handle_f | oyMOptions_Handle, | ||
oyObject_s | object | ||
) |
Custom CMMapi10 constructor.
Function oyCMMapi10_Create
init | custom initialisation |
reset | custom deinitialisation |
msg_set | message function setter |
registration | the modules Registration string, it shall contain the command name, so it can be selected |
version | module version
|
module_api | tell compatibility with Oyranos API
|
getText | for filter help descriptions; It shall at least contain "can_handle", "help" and the command name as used in the registration string |
texts | types for getText member |
oyMOptions_Handle | the function pointer to do the work |
object | a optional object |
OYAPI oyPointer_s *OYEXPORT oyCMMapi10_GetBackendContext | ( | oyCMMapi10_s * | api | ) |
get filter type specific runtime data
Runtime data can be used as context by a backend during execution.
That data is apart from a filter object, which can have lifetime data associated through a oyFilterNode_GetContext(). A filter connector can have its processing data associated through oyFilterNode_SetData().
[in] | api | api object |
int oyCMMapi10_Init__Members | ( | oyCMMapi10_s_ *cmmapi10 | OY_UNUSED | ) |
Custom CMMapi10 constructor.
Function oyCMMapi10_Init__Members
OYAPI oyCMMapi10_s *OYEXPORT oyCMMapi10_New | ( | oyObject_s | object | ) |
allocate a new CMMapi10 object
Function oyCMMapi10_New
OYAPI int OYEXPORT oyCMMapi10_Release | ( | oyCMMapi10_s ** | cmmapi10 | ) |
release and possibly deallocate a oyCMMapi10_s object
Function oyCMMapi10_Release
[in,out] | cmmapi10 | CMMapi10 struct object |
void oyCMMapi10_Release__Members | ( | oyCMMapi10_s_ * | cmmapi10 | ) |
Custom CMMapi10 destructor.
Function oyCMMapi10_Release__Members
OYAPI int OYEXPORT oyCMMapi10_SetBackendContext | ( | oyCMMapi10_s * | api, |
oyPointer_s * | ptr | ||
) |
set filter type specific runtime data
Runtime data can be used as context by a backend during execution. The data is typical set during backend load.
That data is apart from a filter object, which can have lifetime data associated through a oyFilterNode_GetContext(). A filter connector can have its processing data associated through oyFilterNode_SetData().
[in,out] | api | api object |
[in] | ptr | the data needed to run the filter type |
oyStruct_Copy_f oyCMMapi10_s::copy |
Copy function.
oyObject_s oyCMMapi10_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyMOptions_Handle_f oyMOptions_Handle |
oyStruct_Release_f oyCMMapi10_s::release |
Release function.
const oyOBJECT_e oyCMMapi10_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.