oyBlob_s Struct Reference
Description: C source code API documentation for the Oyranos project.
Keywords: Oyranos,Color Management,Color Management,ICC,CMS,C,doxygen,API,documentation

| Oyranos Color Management System API - Version 0.9.6

Public Member Functions | Data Fields
oyBlob_s Struct Reference
Miscellaneous » Values Handling

A data blob object. More...

`#include <oyBlob_s.h>`

Inheritance diagram for oyBlob_s:
Collaboration diagram for oyBlob_s:

## Public Member Functions
OYAPI oyBlob_s *OYEXPORT | oyBlob_New (oyObject_s object)
| allocate a new Blob object More...
| oyBlob_Copy
| 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...
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...
| oyStruct_RegisterStaticMessageFunc
| register a function for verbosity More...
| oyStruct_GetInfo
| 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...
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

A data blob object.

Version
  Oyranos: 0.2.1

Since
  2009/01/06 (Oyranos: 0.1.9)

Date
  2011/01/19

Examples:
  image_display.cpp.

## Member Function Documentation

## ◆ oyBlob_Copy()

oyBlob_Copy

Copy or Reference a Blob object.

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

Parameters

  [in] | blob | Blob struct object
  | object | NULL - means reference, the optional object triggers a real copy

## ◆ oyBlob_GetPointer()

oyPointer oyBlob_GetPointer | ( | oyBlob_s * | blob | ) |

get value from a data blob

Function oyBlob_GetPointer

Parameters

  [in] | blob | the data blob

Returns
  the data pointer

Version
  Oyranos: 0.2.1

Since
  2011/01/17 (Oyranos: 0.2.1)

Date
  2011/01/17

References oyOBJECT_BLOB_S.

Referenced by oyFilterNode_s::oyFilterNode_ToBlob(), and oyValue_u::oyValueEqual().

## ◆ oyBlob_GetSize()

size_t oyBlob_GetSize | ( | oyBlob_s * | blob | ) |

get size from a data blob

Function oyBlob_GetSize

Parameters

  [in] | blob | the data blob

Returns
  the data size

Version
  Oyranos: 0.2.1

Since
  2011/01/17 (Oyranos: 0.2.1)

Date
  2011/01/17

References oyOBJECT_BLOB_S.

Referenced by oyFilterNode_s::oyFilterNode_ToBlob().

## ◆ oyBlob_GetType()

const char * oyBlob_GetType | ( | oyBlob_s * | blob | ) |

get type from a data blob

Function oyBlob_GetType

Parameters

  [in] | blob | the data blob

Returns
  the data type

Version
  Oyranos: 0.2.1

Since
  2011/01/17 (Oyranos: 0.2.1)

Date
  2011/01/17

References oyOBJECT_BLOB_S.

## ◆ oyBlob_New()

OYAPI oyBlob_s *OYEXPORT oyBlob_New | ( | oyObject_s | object | ) |

allocate a new Blob object

Function oyBlob_New

References oyOBJECT_OBJECT_S.

Referenced by oyFilterNode_s::oyFilterNode_ToBlob().

## ◆ oyBlob_Release()

OYAPI int OYEXPORT oyBlob_Release | ( | oyBlob_s ** | blob | ) |

release and possibly deallocate a oyBlob_s object

Function oyBlob_Release

Parameters

  [in,out] | blob | Blob struct object

References oyOBJECT_BLOB_S.

Referenced by oyFilterNode_s::oyFilterNode_ToBlob().

## ◆ oyBlob_SetFromData()

int oyBlob_SetFromData | ( | oyBlob_s * | blob,
|  | oyPointer | ptr,
|  | size_t | size,
|  | const char * | type
| ) |  |

set value from a data blob

Function oyBlob_SetFromData

Parameters

  [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

Returns
  0 - success, 1 - error

Version
  Oyranos: 0.1.10

Since
  2009/01/06 (Oyranos: 0.1.10)

Date
  2009/06/12

References oy_, and oyOBJECT_BLOB_S.

## ◆ oyBlob_SetFromStatic()

int oyBlob_SetFromStatic | ( | oyBlob_s * | blob,
|  | const oyPointer | ptr,
|  | size_t | size,
|  | const char * | type
| ) |  |

set value from a data blob

Function oyBlob_SetFromStatic

Parameters

  [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

Returns
  0 - success, 1 - error

Version
  Oyranos: 0.1.10

Since
  2009/07/26 (Oyranos: 0.1.10)

Date
  2009/07/26

References oy_, and oyOBJECT_BLOB_S.

## Field Documentation

## ◆ copy

oyStruct_Copy_f oyBlob_s::copy

Copy function.

## ◆ oy_

oyObject_s oyBlob_s::oy_

Oyranos internal object.

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

Referenced by oyBlob_SetFromData(), and oyBlob_SetFromStatic().

## ◆ release

oyStruct_Release_f oyBlob_s::release

Release function.

## ◆ type_

const oyOBJECT_e oyBlob_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.