Oyranos  git-devel
Oyranos is a full featured Color Management System
Public Types | Public Member Functions | Data Fields
oyCMMapi3_s Struct Reference

The API 3 to implement and set to provide low level ICC profile support. More...

#include <oyCMMapi3_s.h>

Inheritance diagram for oyCMMapi3_s:
Inheritance graph
Collaboration diagram for oyCMMapi3_s:
Collaboration graph

Public Types

typedef oyStructList_s *(* oyCMMProfileTag_GetValues_f) (oyProfileTag_s *tag)
 
typedef int(* oyCMMProfileTag_Create_f) (oyProfileTag_s *tag, oyStructList_s *list, icTagTypeSignature tag_type, uint32_t version)
 
- 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 oyCMMapi3_s *OYEXPORT oyCMMapi3_New (oyObject_s object)
 allocate a new CMMapi3 object More...
 
OYAPI oyCMMapi3_s *OYEXPORT oyCMMapi3_Copy (oyCMMapi3_s *cmmapi3, oyObject_s object)
 Copy or Reference a CMMapi3 object. More...
 
OYAPI int OYEXPORT oyCMMapi3_Release (oyCMMapi3_s **cmmapi3)
 release and possibly deallocate a oyCMMapi3_s object More...
 
void oyCMMapi3_Release__Members (oyCMMapi3_s_ *cmmapi3)
 Custom CMMapi3 destructor. More...
 
int oyCMMapi3_Init__Members (oyCMMapi3_s_ *cmmapi3 OY_UNUSED)
 Custom CMMapi3 constructor. More...
 
int oyCMMapi3_Copy__Members (oyCMMapi3_s_ *dst, oyCMMapi3_s_ *src)
 Custom CMMapi3 copy constructor. More...
 
oyOBJECT_e oyCMMapi3_Query_ (oyCMMinfo_s_ *cmm_info, oyCMMapi_s_ *api, oyPointer data, uint32_t *rank)
 Implements oyCMMapi_Check_f. 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_soyCMMapi_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...
 
oyCMMProfileTag_GetValues_f oyCMMProfileTag_GetValues
 
oyCMMProfileTag_Create_f oyCMMProfileTag_Create
 
- 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...
 

Detailed Description

The API 3 to implement and set to provide low level ICC profile support.

Member Typedef Documentation

◆ oyCMMProfileTag_Create_f

typedef int(* oyCMMProfileTag_Create_f) (oyProfileTag_s *tag, oyStructList_s *list, icTagTypeSignature tag_type, uint32_t version)

typedef oyCMMProfileTag_Create_f

◆ oyCMMProfileTag_GetValues_f

typedef oyStructList_s*(* oyCMMProfileTag_GetValues_f) (oyProfileTag_s *tag)

typedef oyCMMProfileTag_GetValues_f

Member Function Documentation

◆ oyCMMapi3_Copy()

OYAPI oyCMMapi3_s *OYEXPORT oyCMMapi3_Copy ( oyCMMapi3_s cmmapi3,
oyObject_s  object 
)

Copy or Reference a CMMapi3 object.

Function oyCMMapi3_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

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

◆ oyCMMapi3_Copy__Members()

int oyCMMapi3_Copy__Members ( oyCMMapi3_s_ *  dst,
oyCMMapi3_s_ *  src 
)

Custom CMMapi3 copy constructor.

Function oyCMMapi3_Copy__Members

◆ oyCMMapi3_Init__Members()

int oyCMMapi3_Init__Members ( oyCMMapi3_s_ *cmmapi3  OY_UNUSED)

Custom CMMapi3 constructor.

Function oyCMMapi3_Init__Members

◆ oyCMMapi3_New()

OYAPI oyCMMapi3_s *OYEXPORT oyCMMapi3_New ( oyObject_s  object)

allocate a new CMMapi3 object

Function oyCMMapi3_New

◆ oyCMMapi3_Query_()

oyOBJECT_e oyCMMapi3_Query_ ( oyCMMinfo_s_ *  cmm_info,
oyCMMapi_s_ *  api,
oyPointer  data,
uint32_t *  rank 
)

Implements oyCMMapi_Check_f.

Function oyCMMapi3_Query_

◆ oyCMMapi3_Release()

OYAPI int OYEXPORT oyCMMapi3_Release ( oyCMMapi3_s **  cmmapi3)

release and possibly deallocate a oyCMMapi3_s object

Function oyCMMapi3_Release

Parameters
[in,out]cmmapi3CMMapi3 struct object

◆ oyCMMapi3_Release__Members()

void oyCMMapi3_Release__Members ( oyCMMapi3_s_ *  cmmapi3)

Custom CMMapi3 destructor.

Function oyCMMapi3_Release__Members

Field Documentation

◆ copy

oyStruct_Copy_f oyCMMapi3_s::copy

Copy function.

◆ oy_

oyObject_s oyCMMapi3_s::oy_

Oyranos internal object.

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

◆ oyCMMProfileTag_Create

oyCMMProfileTag_Create_f oyCMMProfileTag_Create

◆ oyCMMProfileTag_GetValues

oyCMMProfileTag_GetValues_f oyCMMProfileTag_GetValues

◆ release

oyStruct_Release_f oyCMMapi3_s::release

Release function.

◆ type_

const oyOBJECT_e oyCMMapi3_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.