Oyranos Color Management System API
Data Structures | Typedefs | Functions
oyStruct_s.h File Reference
#include <oyranos_object.h>
#include <oyranos_core.h>

Data Structures

struct  oyStruct_s
 Oyranos base structure. More...
 

Typedefs

typedef oyStruct_s *(* oyStruct_Copy_f) (oyStruct_s *, oyPointer)
 reference a object or with second argument present do a copy More...
 
typedef int(* oyStruct_Release_f) (oyStruct_s **)
 release object More...
 
typedef oyPointer(* oyStruct_LockCreate_f) (oyStruct_s *obj)
 create a lock object More...
 

Functions

void oyThreadLockingSet (oyStruct_LockCreate_f createLockFunc, oyLockRelease_f releaseLockFunc, oyLock_f lockFunc, oyUnLock_f unlockFunc)
 set locking functions for threaded applications More...
 
int oyThreadLockingReady (void)
 tell if thread locking is ready More...
 
OYAPI oyAlloc_f OYEXPORT oyStruct_GetAllocator (oyStruct_s *obj)
 get the memory allocator of a object More...
 
OYAPI oyDeAlloc_f OYEXPORT oyStruct_GetDeAllocator (oyStruct_s *obj)
 get the memory allocator of a object More...
 
OYAPI int OYEXPORT oyStruct_CheckType (oyStruct_s *obj, oyOBJECT_e type)
 check if the object is a class or is inherited of a class More...
 
OYAPI oyPointer OYEXPORT oyStruct_Allocate (oyStruct_s *st, size_t size)
 let a object allocate some memory More...
 

Detailed Description

[Template file inheritance graph] +– oyStruct_s.template.h

Oyranos is an open source Color Management System

Copyright:
2004-2014 (C) Kai-Uwe Behrmann
Author
Kai-Uwe Behrmann ku.b@.nosp@m.gmx..nosp@m.de
License:
new BSD - see: http://www.opensource.org/licenses/bsd-license.php
Date
2014/02/04

Typedef Documentation

typedef oyStruct_s*(* oyStruct_Copy_f) (oyStruct_s *, oyPointer)

reference a object or with second argument present do a copy

typedef oyPointer(* oyStruct_LockCreate_f) (oyStruct_s *obj)

create a lock object

typedef int(* oyStruct_Release_f) (oyStruct_s **)

release object

Function Documentation

OYAPI oyPointer OYEXPORT oyStruct_Allocate ( oyStruct_s st,
size_t  size 
)

let a object allocate some memory

Function oyStruct_Allocate

Version
Oyranos: 0.1.10
Since
2008/12/00 (Oyranos: 0.1.10)
Date
2008/12/00

References oyStruct_s::oy_.

OYAPI int OYEXPORT oyStruct_CheckType ( oyStruct_s obj,
oyOBJECT_e  type 
)

check if the object is a class or is inherited of a class

Function oyStruct_CheckType

Version
Oyranos: 0.3.0
Date
2011/02/15
Since
2011/02/02 (Oyranos: 0.3.0)

References oyObjectInfoStatic_s::inheritance, oyStruct_s::oy_, oyOBJECT_INFO_STATIC_S, oyOBJECT_OBJECT_S, oyStruct_GetInfo(), and oyStruct_s::type_.

OYAPI oyAlloc_f OYEXPORT oyStruct_GetAllocator ( oyStruct_s obj)

get the memory allocator of a object

Function oyStruct_GetAllocator

Version
Oyranos: 0.3.0
Date
2011/01/30
Since
2011/01/30 (Oyranos: 0.3.0)

References oyStruct_s::oy_, and oyStruct_s::type_.

OYAPI oyDeAlloc_f OYEXPORT oyStruct_GetDeAllocator ( oyStruct_s obj)

get the memory allocator of a object

Function oyStruct_GetDeAllocator

Version
Oyranos: 0.3.0
Date
2011/01/30
Since
2011/01/30 (Oyranos: 0.3.0)

References oyStruct_s::oy_, and oyStruct_s::type_.

int oyThreadLockingReady ( void  )

tell if thread locking is ready

Version
Oyranos: 0.9.5
Date
2014/02/04
Since
2014/02/04 (Oyranos: 0.9.5)
void oyThreadLockingSet ( oyStruct_LockCreate_f  createLockFunc,
oyLockRelease_f  releaseLockFunc,
oyLock_f  lockFunc,
oyUnLock_f  unlockFunc 
)

set locking functions for threaded applications

Function: oyThreadLockingSet

Since
Oyranos: version 0.1.8
Date
14 january 2008 (API 0.1.8)