![]() |
Oyranos Color Management System API |
custom pointer More...
#include <oyPointer_s.h>
Public Member Functions | |
OYAPI oyPointer_s *OYEXPORT | oyPointer_New (oyObject_s object) |
allocate a new Pointer object More... | |
OYAPI oyPointer_s *OYEXPORT | oyPointer_Copy (oyPointer_s *pointer, oyObject_s object) |
copy or reference a Pointer object More... | |
OYAPI int OYEXPORT | oyPointer_Release (oyPointer_s **pointer) |
release and possibly deallocate a oyPointer_s object More... | |
int | oyPointer_Set (oyPointer_s *cmm_ptr, const char *lib_name, const char *resource, oyPointer ptr, const char *func_name, oyPointer_release_f ptrRelease) |
set a oyPointer_s More... | |
oyPointer_s * | oyPointer_LookUpFromObject (oyStruct_s *data, const char *data_type) |
Get a module specific pointer from cache. More... | |
oyPointer_s * | oyPointer_LookUpFromText (const char *text, const char *data_type) |
Get a module specific pointer from cache. 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... | |
custom pointer
OYAPI oyPointer_s *OYEXPORT oyPointer_Copy | ( | oyPointer_s * | pointer, |
oyObject_s | object | ||
) |
copy or reference a Pointer object
Function oyPointer_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | pointer | Pointer struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_POINTER_S.
Referenced by oyCMMapi4_s::oyCMMapi4_GetBackendContext(), oyCMMapi4_s::oyCMMapi4_SetBackendContext(), oyCMMapi7_s::oyCMMapi7_GetBackendContext(), oyCMMapi7_s::oyCMMapi7_SetBackendContext(), oyCMMapiFilter_s::oyCMMapiFilter_GetBackendContext(), oyCMMapiFilter_s::oyCMMapiFilter_SetBackendContext(), oyFilterNode_s::oyFilterNode_GetContext(), and oyFilterNode_s::oyFilterNode_SetContext().
oyPointer_s * oyPointer_LookUpFromObject | ( | oyStruct_s * | data, |
const char * | data_type | ||
) |
Get a module specific pointer from cache.
The returned oyPointer_s has to be released after using by the module with oyPointer_Release(). In case the the oyPointer_s::ptr member is empty, it should be set by the requesting module.
[in] | data | object to look up |
[in] | data_type | four byte module type for this object type; The data_type shall enshure the returned oyPointer_s is specific to the calling module. |
References oyStruct_s::oy_, oyNAME_NICK, and oyPointer_LookUpFromText().
oyPointer_s * oyPointer_LookUpFromText | ( | const char * | text, |
const char * | data_type | ||
) |
Get a module specific pointer from cache.
The returned oyPointer_s has to be released after using by the module with oyPointer_Release(). In case the the oyPointer_s::ptr member is empty, it should be set by the requesting module.
[in] | text | hash text to look up |
[in] | data_type | four byte module type for this object type; The data_type shall enshure the returned oyPointer_s is specific to the calling module. |
Cache Search
References oyOBJECT_POINTER_S, oyPointer_New(), and oyPointer_Set().
Referenced by oyPointer_LookUpFromObject().
OYAPI oyPointer_s *OYEXPORT oyPointer_New | ( | oyObject_s | object | ) |
allocate a new Pointer object
Function oyPointer_New
References oyOBJECT_OBJECT_S.
Referenced by oyPointer_LookUpFromText().
OYAPI int OYEXPORT oyPointer_Release | ( | oyPointer_s ** | pointer | ) |
release and possibly deallocate a oyPointer_s object
Function oyPointer_Release
[in,out] | pointer | Pointer struct object |
References oyOBJECT_POINTER_S.
Referenced by oyCMMapi4_s::oyCMMapi4_SetBackendContext(), oyCMMapi7_s::oyCMMapi7_SetBackendContext(), oyCMMapiFilter_s::oyCMMapiFilter_SetBackendContext(), and oyFilterNode_s::oyFilterNode_SetContext().
int oyPointer_Set | ( | oyPointer_s * | cmm_ptr, |
const char * | lib_name, | ||
const char * | resource, | ||
oyPointer | ptr, | ||
const char * | func_name, | ||
oyPointer_release_f | ptrRelease | ||
) |
set a oyPointer_s
Function oyPointer_Set
Use for initialising.
Referenced by oyPointer_LookUpFromText().
oyStruct_Copy_f oyPointer_s::copy |
Copy function.
oyObject_s oyPointer_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyPointer_s::release |
Release function.
const oyOBJECT_e oyPointer_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.