![]() |
Oyranos Color Management System API |
Graph policies. More...
#include <oyCMMapi9_s.h>
Public Types | |
typedef int(* | oyConversion_Correct_f )(oyConversion_s *conversion, uint32_t flags, oyOptions_s *options) |
Check for correctly adhering to policies. 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 oyCMMapi9_s *OYEXPORT | oyCMMapi9_New (oyObject_s object) |
allocate a new CMMapi9 object More... | |
OYAPI oyCMMapi9_s *OYEXPORT | oyCMMapi9_Copy (oyCMMapi9_s *cmmapi9, oyObject_s object) |
copy or reference a CMMapi9 object More... | |
OYAPI int OYEXPORT | oyCMMapi9_Release (oyCMMapi9_s **cmmapi9) |
release and possibly deallocate a oyCMMapi9_s object More... | |
OYAPI int OYEXPORT | oyCMMapi9_SetBackendContext (oyCMMapi9_s *api, oyPointer_s *ptr) |
set filter type specific runtime data More... | |
OYAPI oyPointer_s *OYEXPORT | oyCMMapi9_GetBackendContext (oyCMMapi9_s *api) |
get filter type specific runtime data More... | |
void | oyCMMapi9_Release__Members (oyCMMapi9_s_ *cmmapi9) |
Custom CMMapi9 destructor. More... | |
int | oyCMMapi9_Init__Members (oyCMMapi9_s_ *cmmapi9) |
Custom CMMapi9 constructor. More... | |
int | oyCMMapi9_Copy__Members (oyCMMapi9_s_ *dst, oyCMMapi9_s_ *src) |
Custom CMMapi9 copy constructor. More... | |
![]() | |
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) |
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... | |
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... | |
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... | |
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... | |
Graph policies.
typedef int(* oyConversion_Correct_f)(oyConversion_s *conversion, uint32_t flags, oyOptions_s *options) |
Check for correctly adhering to policies.
typedef oyConversion_Correct_f
Without any options the module shall perform graph analysis and correct the graph.
conversion | the to be checked configuration | |
[in] | flags | for inbuild defaults | oyOPTIONSOURCE_FILTER; for options marked as advanced | oyOPTIONATTRIBUTE_ADVANCED | OY_SELECT_FILTER | OY_SELECT_COMMON |
options | options to the policy module |
OYAPI oyCMMapi9_s *OYEXPORT oyCMMapi9_Copy | ( | oyCMMapi9_s * | cmmapi9, |
oyObject_s | object | ||
) |
copy or reference a CMMapi9 object
Function oyCMMapi9_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | cmmapi9 | CMMapi9 struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_CMM_API9_S.
int oyCMMapi9_Copy__Members | ( | oyCMMapi9_s_ * | dst, |
oyCMMapi9_s_ * | src | ||
) |
Custom CMMapi9 copy constructor.
Function oyCMMapi9_Copy__Members
OYAPI oyPointer_s *OYEXPORT oyCMMapi9_GetBackendContext | ( | oyCMMapi9_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_API9_S, oyOBJECT_CMM_API_MAX, and oyPointer_s::oyPointer_Copy().
int oyCMMapi9_Init__Members | ( | oyCMMapi9_s_ * | cmmapi9 | ) |
Custom CMMapi9 constructor.
Function oyCMMapi9_Init__Members
OYAPI oyCMMapi9_s *OYEXPORT oyCMMapi9_New | ( | oyObject_s | object | ) |
OYAPI int OYEXPORT oyCMMapi9_Release | ( | oyCMMapi9_s ** | cmmapi9 | ) |
release and possibly deallocate a oyCMMapi9_s object
Function oyCMMapi9_Release
[in,out] | cmmapi9 | CMMapi9 struct object |
References oyOBJECT_CMM_API9_S.
void oyCMMapi9_Release__Members | ( | oyCMMapi9_s_ * | cmmapi9 | ) |
Custom CMMapi9 destructor.
Function oyCMMapi9_Release__Members
OYAPI int OYEXPORT oyCMMapi9_SetBackendContext | ( | oyCMMapi9_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_API9_S, oyOBJECT_CMM_API_MAX, oyPointer_s::oyPointer_Copy(), and oyPointer_s::oyPointer_Release().
oyStruct_Copy_f oyCMMapi9_s::copy |
Copy function.
oyObject_s oyCMMapi9_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyCMMapi9_s::release |
Release function.
Referenced by oyFilterNode_s::oyFilterNode_GetUi(), oyStruct_s::oyStruct_GetText(), and oyStruct_s::oyStruct_GetTextFromModule().
const oyOBJECT_e oyCMMapi9_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.