![]() |
Oyranos Color Management System API |
the module API 4,6,7 interface base More...
#include <oyCMMapiFilter_s.h>
Public Member Functions | |
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... | |
![]() | |
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, 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... | |
![]() | |
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... | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
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 const char *(* | oyCMMGetText_f) (const char *select, oyNAME_e type, oyStruct_s *context) |
get strings from a CMM More... | |
the module API 4,6,7 interface base
The registration should provide keywords for selection. The api5_ member is missed for oyCMMapi5_s.
OYAPI oyCMMapiFilter_s *OYEXPORT oyCMMapiFilter_Copy | ( | oyCMMapiFilter_s * | cmmapifilter, |
oyObject_s | object | ||
) |
copy or reference a CMMapiFilter object
Function oyCMMapiFilter_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | cmmapifilter | CMMapiFilter struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_CMM_API_FILTER_S.
OYAPI oyPointer_s *OYEXPORT oyCMMapiFilter_GetBackendContext | ( | oyCMMapiFilter_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 |
References oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_MAX, and oyPointer_s::oyPointer_Copy().
OYAPI oyCMMapiFilter_s *OYEXPORT oyCMMapiFilter_New | ( | oyObject_s | object | ) |
OYAPI int OYEXPORT oyCMMapiFilter_Release | ( | oyCMMapiFilter_s ** | cmmapifilter | ) |
release and possibly deallocate a oyCMMapiFilter_s object
Function oyCMMapiFilter_Release
[in,out] | cmmapifilter | CMMapiFilter struct object |
References oyOBJECT_CMM_API_FILTER_S.
OYAPI int OYEXPORT oyCMMapiFilter_SetBackendContext | ( | oyCMMapiFilter_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 |
References oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_MAX, oyPointer_s::oyPointer_Copy(), and oyPointer_s::oyPointer_Release().
oyStruct_Copy_f oyCMMapiFilter_s::copy |
Copy function.
Referenced by oyCMMui_s::oyCMMui_GetParent().
oyObject_s oyCMMapiFilter_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyCMMapiFilter_s::release |
Release function.
const oyOBJECT_e oyCMMapiFilter_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.