Oyranos Colour Management System API
Functions

Profile Handling API

Functions

int oyCheckProfile (const char *filename, const char *coloursig)
 check an file if it is a profile
int oyCheckProfileMem (const void *mem, size_t size, const char *coloursig)
 check an memory block if it is a profile
size_t oyGetProfileSize (const char *profilename)
 get the profiles size
void * oyGetProfileBlock (const char *profilename, size_t *size, oyAlloc_f allocate_func)
 obtain an memory block in the responsibility of the user
char * oyGetPathFromProfileName (const char *profile_name, oyAlloc_f allocate_func)

Detailed Description

Functions to handle profiles.


Function Documentation

int oyCheckProfile ( const char *  filename,
const char *  coloursig 
)

check an file if it is a profile

Parameters:
filenamethe filename to check
coloursigcolour space signature as described in the ICC specification
Returns:
true/false
int oyCheckProfileMem ( const void *  mem,
size_t  size,
const char *  coloursig 
)

check an memory block if it is a profile

Parameters:
memthe memory containing the profile
sizethe size of the memory block
coloursigcurrently ignored
Returns:
true/false
char* oyGetPathFromProfileName ( const char *  profile_name,
oyAlloc_f  allocate_func 
)

Find out where in the Oyranos search path the specified profile resides.

Deprecated:
This function will be substituded by oyProfile_GetFileName.
Parameters:
profile_namethe filename find in the Oyranos search path
allocate_funcuser provided function for allocating the string memory
Returns:
the path name where the profile was found in the Oyranos search path
void* oyGetProfileBlock ( const char *  profilename,
size_t *  size,
oyAlloc_f  allocate_func 
)

obtain an memory block in the responsibility of the user

Please note the size parameter is sensible. Eighter set it to zero or to the size obtained with oyGetProfileSize to get the full data or specify the size you want to get a partitial profile.
This feature is useful for instance to get only the headers of many profiles.

Parameters:
profilenamespecifies the profile
[in]sizedesired size, or zero for a complete copy
[out]sizethe size of the returned block
allocate_functhe users memory allocation function
Returns:
the profile block in memory allocated by oyAlloc_f
size_t oyGetProfileSize ( const char *  profilename)

get the profiles size

Parameters:
profilenamespecifies the profile
Returns:
size