![]() |
Oyranos Color Management System API - Version 0.9.6 |
Context convertor. More...
#include <oyCMMapi6_s.h>
Public Types | |
typedef int(* | oyModuleData_Convert_f) (oyPointer_s *data_in, oyPointer_s *data_out, oyFilterNode_s *node) |
convert between data formats More... | |
![]() | |
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... | |
typedef const char *(* | oyCMMGetText_f) (const char *select, oyNAME_e type, oyStruct_s *context) |
get strings from a CMM More... | |
Public Member Functions | |
OYAPI oyCMMapi6_s *OYEXPORT | oyCMMapi6_New (oyObject_s object) |
allocate a new CMMapi6 object More... | |
oyCMMapi6_Copy | |
Copy or Reference a CMMapi6 object. More... | |
OYAPI int OYEXPORT | oyCMMapi6_Release (oyCMMapi6_s **cmmapi6) |
release and possibly deallocate a oyCMMapi6_s object More... | |
OYAPI int OYEXPORT | oyCMMapi6_SetBackendContext (oyCMMapi6_s *api, oyPointer_s *ptr) |
set filter type specific runtime data More... | |
OYAPI oyPointer_s *OYEXPORT | oyCMMapi6_GetBackendContext (oyCMMapi6_s *api) |
get filter type specific runtime data More... | |
const char * | oyCMMapi6_GetDataType (oyCMMapi6_s *api, int out_direction) |
Get data type identifier. More... | |
oyModuleData_Convert_f | oyCMMapi6_GetConvertF (oyCMMapi6_s *api) |
Get data conversion function. More... | |
void | oyCMMapi6_Release__Members (oyCMMapi6_s_ *cmmapi6) |
Custom CMMapi6 destructor. More... | |
int | oyCMMapi6_Init__Members (oyCMMapi6_s_ *cmmapi6) |
Custom CMMapi6 constructor. More... | |
int | oyCMMapi6_Copy__Members (oyCMMapi6_s_ *dst, oyCMMapi6_s_ *src) |
Custom CMMapi6 copy constructor. More... | |
![]() | |
OYAPI oyCMMapiFilter_s *OYEXPORT | oyCMMapiFilter_New (oyObject_s object) |
allocate a new CMMapiFilter object More... | |
oyCMMapiFilter_Copy | |
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) |
Custom CMMapiFilter constructor. More... | |
int | oyCMMapiFilter_Copy__Members (oyCMMapiFilter_s_ *dst, oyCMMapiFilter_s_ *src) |
Custom CMMapiFilter copy constructor. More... | |
![]() | |
OYAPI oyCMMapi_s *OYEXPORT | oyCMMapi_New (oyObject_s object) |
allocate a new CMMapi object More... | |
oyCMMapi_Copy | |
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... | |
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... | |
![]() | |
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... | |
oyStruct_RegisterStaticMessageFunc | |
register a function for verbosity More... | |
oyStruct_GetInfo | |
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... | |
![]() | |
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... | |
Context convertor.
The context provided by a filter can be exotic. The API provides the means to get him into a known format. With this format connector it is possible to interface otherwise divergine formats.
The context is set by calling into oyConversion_RunPixels(), which calls oyFilterGraph_PrepareContexts() as needed, that oyPointer_ConvertData() and then a suitable oyCMMapi6_s format connector. The result is cached in memory by higher than this layer.
oyCMMapi6_Copy |
Copy or Reference a CMMapi6 object.
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | cmmapi6 | CMMapi6 struct object |
object | NULL - means reference, the optional object triggers a real copy |
Referenced by oyCMMapi6_Copy__Members(), and oyCMMapi6_New().
int oyCMMapi6_Copy__Members | ( | oyCMMapi6_s_ * | dst, |
oyCMMapi6_s_ * | src | ||
) |
Custom CMMapi6 copy constructor.
Function oyCMMapi6_Copy__Members
References oy_debug, oyCMMapi6_Copy(), oyCMMapi6_Init__Members(), oyCMMapi6_New(), oyCMMapi6_Release(), oyCMMapi6_Release__Members(), oyCMMapi_s::oyCMMapi_Copy__Members(), oyCMMapi_s::oyCMMapi_Init__Members(), oyCMMapi_s::oyCMMapi_Release__Members(), oyCMMapiFilter_s::oyCMMapiFilter_Copy__Members(), oyCMMapiFilter_s::oyCMMapiFilter_Init__Members(), oyCMMapiFilter_s::oyCMMapiFilter_Release__Members(), oyNAME_NICK, oyOBJECT_CMM_API6_S, oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_S, oyObject_Copy(), oyObject_GetId(), oyObject_NewFrom(), oyObject_Release(), oyObject_SetParent(), oyObject_UnRef(), oyStruct_s::oyStruct_RegisterStaticMessageFunc(), and oyStruct_s::oyStructTypeToText().
OYAPI oyPointer_s *OYEXPORT oyCMMapi6_GetBackendContext | ( | oyCMMapi6_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 oyCMMapi6_GetDataType(), oyOBJECT_CMM_API6_S, oyOBJECT_CMM_API_MAX, and oyPointer_s::oyPointer_Copy().
oyModuleData_Convert_f oyCMMapi6_GetConvertF | ( | oyCMMapi6_s * | api | ) |
Get data conversion function.
api | object |
Referenced by oyCMMapi6_GetDataType(), and oyOptions_s::oyOptions_Handle().
const char * oyCMMapi6_GetDataType | ( | oyCMMapi6_s * | api, |
int | out_direction | ||
) |
Get data type identifier.
api | object |
out_direction |
|
References oyCMMapi6_GetConvertF().
Referenced by oyCMMapi6_GetBackendContext().
int oyCMMapi6_Init__Members | ( | oyCMMapi6_s_ * | cmmapi6 | ) |
Custom CMMapi6 constructor.
Function oyCMMapi6_Init__Members
Referenced by oyCMMapi6_Copy__Members().
OYAPI oyCMMapi6_s *OYEXPORT oyCMMapi6_New | ( | oyObject_s | object | ) |
allocate a new CMMapi6 object
Function oyCMMapi6_New
References oyCMMapi6_Copy(), oyOBJECT_CMM_API6_S, and oyOBJECT_OBJECT_S.
Referenced by oyCMMapi6_Copy__Members().
OYAPI int OYEXPORT oyCMMapi6_Release | ( | oyCMMapi6_s ** | cmmapi6 | ) |
release and possibly deallocate a oyCMMapi6_s object
Function oyCMMapi6_Release
[in,out] | cmmapi6 | CMMapi6 struct object |
References oyOBJECT_CMM_API6_S.
Referenced by oyCMMapi6_Copy__Members().
void oyCMMapi6_Release__Members | ( | oyCMMapi6_s_ * | cmmapi6 | ) |
Custom CMMapi6 destructor.
Function oyCMMapi6_Release__Members
Referenced by oyCMMapi6_Copy__Members().
OYAPI int OYEXPORT oyCMMapi6_SetBackendContext | ( | oyCMMapi6_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_API6_S, oyOBJECT_CMM_API_MAX, oyPointer_s::oyPointer_Copy(), and oyPointer_s::oyPointer_Release().
oyStruct_Copy_f oyCMMapi6_s::copy |
Copy function.
oyObject_s oyCMMapi6_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyCMMapi6_s::release |
Release function.
const oyOBJECT_e oyCMMapi6_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.