oyCMMapi4_s Struct Reference

Context creator. More...

#include <oyCMMapi4_s.h>

Inheritance diagram for oyCMMapi4_s:

Collaboration diagram for oyCMMapi4_s:

Public Types
typedef oyPointer(*	oyCMMFilterNode_ContextToMem_f )(oyFilterNode_s *node, size_t *size, oyAlloc_f allocateFunc)
	store a CMM filter context into a memory blob
typedef char *(*	oyCMMFilterNode_GetText_f )(oyFilterNode_s *node, oyNAME_e type, oyAlloc_f allocateFunc)
	describe a CMM filter context

Public Member Functions
OYAPI oyCMMapi4_s *OYEXPORT	oyCMMapi4_New (oyObject_s object)
	allocate a new CMMapi4 object
OYAPI oyCMMapi4_s *OYEXPORT	oyCMMapi4_Copy (oyCMMapi4_s *cmmapi4, oyObject_s object)
	copy or reference a CMMapi4 object
OYAPI int OYEXPORT	oyCMMapi4_Release (oyCMMapi4_s **cmmapi4)
	release and possibly deallocate a oyCMMapi4_s object
void	oyCMMapi4_Release__Members (oyCMMapi4_s_ *cmmapi4)
	Custom CMMapi4 destructor.
int	oyCMMapi4_Init__Members (oyCMMapi4_s_ *cmmapi4)
	Custom CMMapi4 constructor.
int	oyCMMapi4_Copy__Members (oyCMMapi4_s_ *dst, oyCMMapi4_s_ *src)
	Custom CMMapi4 copy constructor.
Public Member Functions inherited from oyCMMapiFilter_s
OYAPI oyCMMapiFilter_s *OYEXPORT	oyCMMapiFilter_New (oyObject_s object)
	allocate a new CMMapiFilter object
OYAPI oyCMMapiFilter_s *OYEXPORT	oyCMMapiFilter_Copy (oyCMMapiFilter_s *cmmapifilter, oyObject_s object)
	copy or reference a CMMapiFilter object
OYAPI int OYEXPORT	oyCMMapiFilter_Release (oyCMMapiFilter_s **cmmapifilter)
	release and possibly deallocate a oyCMMapiFilter_s object
void	oyCMMapiFilter_Release__Members (oyCMMapiFilter_s_ *cmmapifilter)
	Custom CMMapiFilter destructor.
int	oyCMMapiFilter_Init__Members (oyCMMapiFilter_s_ *cmmapifilter)
	Custom CMMapiFilter constructor.
int	oyCMMapiFilter_Copy__Members (oyCMMapiFilter_s_ *dst, oyCMMapiFilter_s_ *src)
	Custom CMMapiFilter copy constructor.
Public Member Functions inherited from oyCMMapi_s
OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_New (oyObject_s object)
	allocate a new CMMapi object
OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_Copy (oyCMMapi_s *cmmapi, oyObject_s object)
	copy or reference a CMMapi object
OYAPI int OYEXPORT	oyCMMapi_Release (oyCMMapi_s **cmmapi)
	release and possibly deallocate a oyCMMapi_s object
void	oyCMMapi_Release__Members (oyCMMapi_s_ *cmmapi)
	Custom CMMapi destructor.
int	oyCMMapi_Init__Members (oyCMMapi_s_ *cmmapi)
	Custom CMMapi constructor.
int	oyCMMapi_Copy__Members (oyCMMapi_s_ *dst, oyCMMapi_s_ *src)
	Custom CMMapi copy constructor.
Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get a text dump

Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyCMMapiFilter_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyCMMapi_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyStruct_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release

Detailed Description

Context creator.

Member Function Documentation

OYAPI oyCMMapi4_s *OYEXPORT oyCMMapi4_Copy	(	oyCMMapi4_s *	cmmapi4,
		oyObject_s	object
	)

copy or reference a CMMapi4 object

Function oyCMMapi4_Copy

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

Parameters

[in]	cmmapi4	CMMapi4 struct object
	object	NULL - means reference, the optional object triffers a real copy

References oyOBJECT_CMM_API4_S.

int oyCMMapi4_Copy__Members	(	oyCMMapi4_s_ *	dst,
		oyCMMapi4_s_ *	src
	)

Custom CMMapi4 copy constructor.

Function oyCMMapi4_Copy__Members

int oyCMMapi4_Init__Members

(

oyCMMapi4_s_ *

cmmapi4

)

Custom CMMapi4 constructor.

Function oyCMMapi4_Init__Members

OYAPI oyCMMapi4_s *OYEXPORT oyCMMapi4_New

(

oyObject_s

object

)

allocate a new CMMapi4 object

Function oyCMMapi4_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyCMMapi4_Release

(

oyCMMapi4_s **

cmmapi4

)

release and possibly deallocate a oyCMMapi4_s object

Function oyCMMapi4_Release

Parameters

[in,out]

cmmapi4

CMMapi4 struct object

References oyOBJECT_CMM_API4_S.

void oyCMMapi4_Release__Members

(

oyCMMapi4_s_ *

cmmapi4

)

Custom CMMapi4 destructor.

Function oyCMMapi4_Release__Members

Field Documentation

oyStruct_Copy_f oyCMMapi4_s::copy

copy function

oyStruct_Release_f oyCMMapi4_s::release

release function