Oyranos Color Management System API
Public Member Functions | Data Fields
oyCMMapiFilter_s Struct Reference

the module API 4,6,7 interface base More...

#include <oyCMMapiFilter_s.h>

Inheritance diagram for oyCMMapiFilter_s:
Inheritance graph
Collaboration diagram for oyCMMapiFilter_s:
Collaboration graph

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...
 
- 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, 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_soyCMMapi_GetNext (oyCMMapi_s *api)
 get next CMMapi 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...
 

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 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...
 

Additional Inherited Members

- Public Types inherited from oyCMMapi_s
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...
 

Detailed Description

the module API 4,6,7 interface base

The registration should provide keywords for selection. The api5_ member is missed for oyCMMapi5_s.

Version
Oyranos: 0.1.10
Since
2008/12/28 (Oyranos: 0.1.10)
Date
2008/12/28

Member Function Documentation

◆ oyCMMapiFilter_Copy()

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.

Parameters
[in]cmmapifilterCMMapiFilter struct object
objectNULL - means reference, the optional object triggers a real copy

References oyOBJECT_CMM_API_FILTER_S.

◆ oyCMMapiFilter_GetBackendContext()

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().

Parameters
[in]apiapi object
Returns
the context needed to run the filter type
Version
Oyranos: 0.9.5
Date
2013/12/19
Since
2013/12/19 (Oyranos: 0.9.5)

References oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_MAX, and oyPointer_s::oyPointer_Copy().

◆ oyCMMapiFilter_New()

OYAPI oyCMMapiFilter_s *OYEXPORT oyCMMapiFilter_New ( oyObject_s  object)

allocate a new CMMapiFilter object

Function oyCMMapiFilter_New

References oyOBJECT_OBJECT_S.

◆ oyCMMapiFilter_Release()

OYAPI int OYEXPORT oyCMMapiFilter_Release ( oyCMMapiFilter_s **  cmmapifilter)

release and possibly deallocate a oyCMMapiFilter_s object

Function oyCMMapiFilter_Release

Parameters
[in,out]cmmapifilterCMMapiFilter struct object

References oyOBJECT_CMM_API_FILTER_S.

◆ oyCMMapiFilter_SetBackendContext()

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().

Parameters
[in,out]apiapi object
[in]ptrthe data needed to run the filter type
Returns
error
Version
Oyranos: 0.9.5
Date
2013/12/19
Since
2013/12/19 (Oyranos: 0.9.5)

References oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_MAX, oyPointer_s::oyPointer_Copy(), and oyPointer_s::oyPointer_Release().

Field Documentation

◆ copy

oyStruct_Copy_f oyCMMapiFilter_s::copy

Copy function.

Referenced by oyCMMui_s::oyCMMui_GetParent().

◆ oy_

oyObject_s oyCMMapiFilter_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

◆ release

oyStruct_Release_f oyCMMapiFilter_s::release

Release function.

◆ type_

const oyOBJECT_e oyCMMapiFilter_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.