![]() |
Oyranos Colour Management System API |
A data blob object. More...
#include <oyBlob_s.h>
Public Member Functions | |
OYAPI oyBlob_s *OYEXPORT | oyBlob_New (oyObject_s object) |
allocate a new Blob object More... | |
OYAPI oyBlob_s *OYEXPORT | oyBlob_Copy (oyBlob_s *blob, oyObject_s object) |
copy or reference a Blob object More... | |
OYAPI int OYEXPORT | oyBlob_Release (oyBlob_s **blob) |
release and possibly deallocate a oyBlob_s object More... | |
int | oyBlob_SetFromData (oyBlob_s *blob, oyPointer ptr, size_t size, const char *type) |
set value from a data blob More... | |
int | oyBlob_SetFromStatic (oyBlob_s *blob, const oyPointer ptr, size_t size, const char *type) |
set value from a data blob More... | |
oyPointer | oyBlob_GetPointer (oyBlob_s *blob) |
get value from a data blob More... | |
size_t | oyBlob_GetSize (oyBlob_s *blob) |
get size from a data blob More... | |
const char * | oyBlob_GetType (oyBlob_s *blob) |
get type from a data blob More... | |
oyBlob_s * | oyFilterGraph_ToBlob (oyFilterGraph_s *graph, int node_pos, oyObject_s object) |
Node context to binary blob. More... | |
![]() | |
const char * | oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get a text dump More... | |
Data Fields | |
oyStruct_Copy_f | copy |
oyStruct_Release_f | release |
![]() | |
oyStruct_Copy_f | copy |
oyStruct_Release_f | release |
A data blob object.
OYAPI oyBlob_s *OYEXPORT oyBlob_Copy | ( | oyBlob_s * | blob, |
oyObject_s | object | ||
) |
copy or reference a Blob object
Function oyBlob_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | blob | Blob struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_BLOB_S.
oyPointer oyBlob_GetPointer | ( | oyBlob_s * | blob | ) |
get value from a data blob
Function oyBlob_GetPointer
[in] | blob | the data blob |
References oyOBJECT_BLOB_S.
Referenced by oyProfileTag_s::oyProfileTag_GetText(), and oyValue_u::oyValueEqual().
size_t oyBlob_GetSize | ( | oyBlob_s * | blob | ) |
get size from a data blob
Function oyBlob_GetSize
[in] | blob | the data blob |
References oyOBJECT_BLOB_S.
Referenced by oyProfileTag_s::oyProfileTag_GetText().
const char * oyBlob_GetType | ( | oyBlob_s * | blob | ) |
get type from a data blob
Function oyBlob_GetType
[in] | blob | the data blob |
References oyOBJECT_BLOB_S.
OYAPI oyBlob_s *OYEXPORT oyBlob_New | ( | oyObject_s | object | ) |
allocate a new Blob object
Function oyBlob_New
References oyOBJECT_OBJECT_S.
Referenced by oyFilterGraph_ToBlob(), and oyOption_s::oyOption_SetFromData().
OYAPI int OYEXPORT oyBlob_Release | ( | oyBlob_s ** | blob | ) |
release and possibly deallocate a oyBlob_s object
Function oyBlob_Release
[in,out] | blob | Blob struct object |
References oyOBJECT_BLOB_S.
int oyBlob_SetFromData | ( | oyBlob_s * | blob, |
oyPointer | ptr, | ||
size_t | size, | ||
const char * | type | ||
) |
set value from a data blob
Function oyBlob_SetFromData
[in] | blob | the data blob |
[in] | ptr | copy the data into the blob object |
[in] | size | data size; 0 means the pointer is not owned by the object. |
[in] | type | data type; assuming 8 byte with typical 4 byte content |
References oyOBJECT_BLOB_S.
Referenced by oyFilterNode_s::oyFilterNode_SetContext_(), and oyOption_s::oyOption_SetFromData().
int oyBlob_SetFromStatic | ( | oyBlob_s * | blob, |
const oyPointer | ptr, | ||
size_t | size, | ||
const char * | type | ||
) |
set value from a data blob
Function oyBlob_SetFromStatic
[in] | blob | the data blob |
[in] | ptr | move the data into the blob object |
[in] | size | data size |
[in] | type | data type; assuming 8 byte with typical 4 byte content |
References oyOBJECT_BLOB_S.
oyBlob_s * oyFilterGraph_ToBlob | ( | oyFilterGraph_s * | graph, |
int | node_pos, | ||
oyObject_s | object | ||
) |
Node context to binary blob.
Function oyFilterGraph_ToBlob
Typical a context from a CMM will be returned.
graph | graph object |
node_pos | node position in the graph |
object | the optional object |
References oyBlob_New(), oyFilterNode_s::oyFilterNode_Release(), oyFilterNode_s::oyFilterNode_SetContext_(), oyFilterNodes_s::oyFilterNodes_Get(), and oyOBJECT_FILTER_GRAPH_S.
oyStruct_Copy_f oyBlob_s::copy |
copy function
oyStruct_Release_f oyBlob_s::release |
release function