![]() |
Oyranos Color Management System API |
The CMM API resources struct to implement and set by a CMM. More...
#include <oyCMMinfo_s.h>
Public Types | |
typedef int(* | oyCMMinfoInit_f) (oyStruct_s *library) |
optional module init function More... | |
Public Member Functions | |
OYAPI oyCMMinfo_s *OYEXPORT | oyCMMinfo_New (oyObject_s object) |
allocate a new CMMinfo object More... | |
OYAPI oyCMMinfo_s *OYEXPORT | oyCMMinfo_Copy (oyCMMinfo_s *cmminfo, oyObject_s object) |
copy or reference a CMMinfo object More... | |
OYAPI int OYEXPORT | oyCMMinfo_Release (oyCMMinfo_s **cmminfo) |
release and possibly deallocate a oyCMMinfo_s object More... | |
OYAPI const char *OYEXPORT | oyCMMinfo_GetCMM (oyCMMinfo_s *info) |
Get CMM signature, e.g. "lcms". More... | |
OYAPI const char *OYEXPORT | oyCMMinfo_GetVersion (oyCMMinfo_s *info) |
Get Backend Version. More... | |
OYAPI oyCMMGetText_f OYEXPORT | oyCMMinfo_GetTextF (oyCMMinfo_s *info) |
Get oyCMMGetText_f function. More... | |
OYAPI const char **OYEXPORT | oyCMMinfo_GetTexts (oyCMMinfo_s *info) |
Get keywords for oyCMMGetText_f function. More... | |
OYAPI int OYEXPORT | oyCMMinfo_GetCompatibility (oyCMMinfo_s *info) |
Get Oyranos compatibility. More... | |
OYAPI oyCMMapi_s *OYEXPORT | oyCMMinfo_GetApi (oyCMMinfo_s *info) |
Get the first api. More... | |
OYAPI void OYEXPORT | oyCMMinfo_SetApi (oyCMMinfo_s *info, oyCMMapi_s *first_api) |
Set the first api. More... | |
OYAPI oyIcon_s *OYEXPORT | oyCMMinfo_GetIcon (oyCMMinfo_s *info) |
Get icon. More... | |
OYAPI oyCMMinfoInit_f OYEXPORT | oyCMMinfo_GetInitF (oyCMMinfo_s *info) |
Get a init function. More... | |
OYAPI void OYEXPORT | oyCMMinfo_SetInitF (oyCMMinfo_s *info, oyCMMinfoInit_f init) |
Set a init function. More... | |
void | oyCMMinfo_Release__Members (oyCMMinfo_s_ *cmminfo) |
Custom CMMinfo destructor. More... | |
int | oyCMMinfo_Init__Members (oyCMMinfo_s_ *cmminfo) |
Custom CMMinfo constructor. More... | |
int | oyCMMinfo_Copy__Members (oyCMMinfo_s_ *dst, oyCMMinfo_s_ *src) |
Custom CMMinfo 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... | |
The CMM API resources struct to implement and set by a CMM.
typedef int(* oyCMMinfoInit_f) (oyStruct_s *library) |
optional module init function
typedef oyCMMinfoInit_f
OYAPI oyCMMinfo_s *OYEXPORT oyCMMinfo_Copy | ( | oyCMMinfo_s * | cmminfo, |
oyObject_s | object | ||
) |
copy or reference a CMMinfo object
Function oyCMMinfo_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | cmminfo | CMMinfo struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_CMM_INFO_S.
Referenced by oyCMMinfo_Copy__Members().
int oyCMMinfo_Copy__Members | ( | oyCMMinfo_s_ * | dst, |
oyCMMinfo_s_ * | src | ||
) |
Custom CMMinfo copy constructor.
Function oyCMMinfo_Copy__Members
References oyCMMinfo_Copy(), oyCMMinfo_Init__Members(), oyCMMinfo_New(), oyCMMinfo_Release(), oyCMMinfo_Release__Members(), oyOBJECT_CMM_INFO_S, oyObject_s::oyObject_Copy(), oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_Release(), oyObject_s::oyObject_SetParent(), oyObject_s::oyObject_UnRef(), and release.
OYAPI oyCMMapi_s *OYEXPORT oyCMMinfo_GetApi | ( | oyCMMinfo_s * | info | ) |
Get the first api.
Function oyCMMinfo_GetApi
The returned struct must be casted to a according API. oyCMMapi_s forms a zero terminated list accesable through oyCMMapi_s::oyCMMapi_GetNext().
OYAPI const char *OYEXPORT oyCMMinfo_GetCMM | ( | oyCMMinfo_s * | info | ) |
Get CMM signature, e.g. "lcms".
Function oyCMMinfo_GetCMM
It contains only four bytes
References oyCMMinfo_GetVersion().
Referenced by oyStruct_s::oyStruct_GetTextFromModule().
OYAPI int OYEXPORT oyCMMinfo_GetCompatibility | ( | oyCMMinfo_s * | info | ) |
Get Oyranos compatibility.
Function oyCMMinfo_GetComp
last supported Oyranos CMM API : OYRANOS_VERSION
Referenced by oyCMMinfo_GetTexts().
OYAPI oyIcon_s *OYEXPORT oyCMMinfo_GetIcon | ( | oyCMMinfo_s * | info | ) |
Get icon.
Function oyCMMinfo_GetIcon
zero terminated list of a icon pyramid
OYAPI oyCMMinfoInit_f OYEXPORT oyCMMinfo_GetInitF | ( | oyCMMinfo_s * | info | ) |
Get a init function.
Function oyCMMinfo_GetInitF
Get a init function for the actual oyCMMinfo_s.
OYAPI oyCMMGetText_f OYEXPORT oyCMMinfo_GetTextF | ( | oyCMMinfo_s * | info | ) |
Get oyCMMGetText_f function.
Function oyCMMinfo_GetTextF
OYAPI const char **OYEXPORT oyCMMinfo_GetTexts | ( | oyCMMinfo_s * | info | ) |
Get keywords for oyCMMGetText_f function.
Function oyCMMinfo_GetTexts
zero terminated list for getText
References oyCMMinfo_GetCompatibility().
OYAPI const char *OYEXPORT oyCMMinfo_GetVersion | ( | oyCMMinfo_s * | info | ) |
Get Backend Version.
Function oyCMMinfo_GetVersion
non translatable, eg "v1.17"
Referenced by oyCMMinfo_GetCMM().
int oyCMMinfo_Init__Members | ( | oyCMMinfo_s_ * | cmminfo | ) |
Custom CMMinfo constructor.
Function oyCMMinfo_Init__Members
Referenced by oyCMMinfo_Copy__Members().
OYAPI oyCMMinfo_s *OYEXPORT oyCMMinfo_New | ( | oyObject_s | object | ) |
allocate a new CMMinfo object
Function oyCMMinfo_New
References oyOBJECT_OBJECT_S.
Referenced by oyCMMinfo_Copy__Members().
OYAPI int OYEXPORT oyCMMinfo_Release | ( | oyCMMinfo_s ** | cmminfo | ) |
release and possibly deallocate a oyCMMinfo_s object
Function oyCMMinfo_Release
[in,out] | cmminfo | CMMinfo struct object |
References oyOBJECT_CMM_INFO_S.
Referenced by oyCMMinfo_Copy__Members().
void oyCMMinfo_Release__Members | ( | oyCMMinfo_s_ * | cmminfo | ) |
Custom CMMinfo destructor.
Function oyCMMinfo_Release__Members
Referenced by oyCMMinfo_Copy__Members().
OYAPI void OYEXPORT oyCMMinfo_SetApi | ( | oyCMMinfo_s * | info, |
oyCMMapi_s * | first_api | ||
) |
Set the first api.
Function oyCMMinfo_SetApi
Set a zero terminated list, which will be visible by the module loader. You can do this inside the oyCMMinfo_s init function setable by oyCMMinfo_SetInitF(). Check if oyCMMinfo_s has already an api set through oyCMMinfo_GetApi(). Append more oyCMMapi_s 's through oyCMMapi_s::oyCMMapi_SetNext().
OYAPI void OYEXPORT oyCMMinfo_SetInitF | ( | oyCMMinfo_s * | info, |
oyCMMinfoInit_f | init | ||
) |
Set a init function.
Function oyCMMinfo_SetInitF
Set a init function for the actual oyCMMinfo_s.
oyStruct_Copy_f oyCMMinfo_s::copy |
Copy function.
oyObject_s oyCMMinfo_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyCMMinfo_s::release |
Release function.
Referenced by oyCMMinfo_Copy__Members().
const oyOBJECT_e oyCMMinfo_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by oyStruct_s::oyStruct_GetTextFromModule().