![]() |
Oyranos Color Management System API |
Tell about the conversion profiles. More...
#include <oyProfiles_s.h>
Public Member Functions | |
OYAPI oyProfiles_s *OYEXPORT | oyProfiles_New (oyObject_s object) |
allocate a new Profiles object More... | |
OYAPI oyProfiles_s *OYEXPORT | oyProfiles_Copy (oyProfiles_s *profiles, oyObject_s object) |
copy or reference a Profiles object More... | |
OYAPI int OYEXPORT | oyProfiles_Release (oyProfiles_s **profiles) |
release and possibly deallocate a oyProfiles_s object More... | |
OYAPI int OYEXPORT | oyProfiles_MoveIn (oyProfiles_s *list, oyProfile_s **obj, int pos) |
add an element to a Profiles list More... | |
OYAPI int OYEXPORT | oyProfiles_ReleaseAt (oyProfiles_s *list, int pos) |
release a element from a Profiles list More... | |
OYAPI oyProfile_s *OYEXPORT | oyProfiles_Get (oyProfiles_s *list, int pos) |
get a element of a Profiles list More... | |
OYAPI int OYEXPORT | oyProfiles_Count (oyProfiles_s *list) |
count the elements in a Profiles list More... | |
OYAPI int OYEXPORT | oyProfiles_Clear (oyProfiles_s *list) |
clear the elements in a Profiles list More... | |
OYAPI int OYEXPORT | oyProfiles_Sort (oyProfiles_s *list, int32_t *rank_list) |
sort a list according to a rank_list More... | |
OYAPI oyProfiles_s *OYEXPORT | oyProfiles_Create (oyProfiles_s *patterns, oyObject_s object) |
get a list of installed profiles More... | |
OYAPI oyProfiles_s *OYEXPORT | oyProfiles_ForStd (oyPROFILE_e std_profile_class, int *current, oyObject_s object) |
Get a list of installed profiles. More... | |
int | oyProfiles_DeviceRank (oyProfiles_s *list, oyConfig_s *device, int32_t *rank_list) |
Sort a profile list according to a given device. More... | |
![]() | |
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... | |
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... | |
![]() | |
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... | |
Tell about the conversion profiles.
OYAPI int OYEXPORT oyProfiles_Clear | ( | oyProfiles_s * | list | ) |
clear the elements in a Profiles list
Function oyProfiles_Clear
[in,out] | list | the list |
References oyOBJECT_PROFILES_S, and oyStructList_s::oyStructList_Clear().
OYAPI oyProfiles_s *OYEXPORT oyProfiles_Copy | ( | oyProfiles_s * | profiles, |
oyObject_s | object | ||
) |
copy or reference a Profiles object
Function oyProfiles_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | profiles | Profiles struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_PROFILES_S.
OYAPI int OYEXPORT oyProfiles_Count | ( | oyProfiles_s * | list | ) |
count the elements in a Profiles list
Function oyProfiles_Count
[in,out] | list | the list |
References oyOBJECT_PROFILES_S, and oyStructList_s::oyStructList_Count().
Referenced by oyProfiles_Create(), and oyProfiles_DeviceRank().
OYAPI oyProfiles_s *OYEXPORT oyProfiles_Create | ( | oyProfiles_s * | patterns, |
oyObject_s | object | ||
) |
get a list of installed profiles
Function oyProfiles_Create
[in] | patterns | a list properties, e.g. classes; Only matching profiles are selected. If NULL, all profiles are accepted. |
object | the optional object |
// Put all ICC Display Class profiles in "profiles" icSignature profile_class = icSigDisplayClass; oyProfile_s * pattern = 0; oyProfiles_s * patterns = oyProfiles_New( 0 ), * profiles = 0; pattern = oyProfile_FromSignature( profile_class, oySIGNATURE_CLASS, 0 ); oyProfiles_MoveIn( patterns, &pattern, -1 ); profiles = oyProfiles_Create( patterns, 0 ); oyProfiles_Release( &patterns );
References oyProfiles_Count(), and oyProfiles_New().
int oyProfiles_DeviceRank | ( | oyProfiles_s * | list, |
oyConfig_s * | device, | ||
int32_t * | rank_list | ||
) |
Sort a profile list according to a given device.
Function oyProfiles_DeviceRank
Profiles which match the device will placed according to a rank value on top of the list followed by the zero ranked profiles.
// Get all ICC profiles, which can be used as assumed RGB profile oyProfiles_s * p_list = oyProfiles_ForStd( oyASSUMED_RGB, 0,0 ); int32_t * rank_list = (int32_t*) malloc( oyProfiles_Count(p_list) * sizeof(int32_t) ); // Sort the profiles according to eaches match to a given device oyProfiles_DeviceRank( p_list, oy_device, rank_list ); n = oyProfiles_Count( p_list ); for(i = 0; i < n; ++i) { temp_prof = oyProfiles_Get( p_list, i ); // Show the rank value, the profile internal and file names on the command line printf("%d %d: \"%s\" %s\n", rank_list[i], i, oyProfile_GetText( temp_prof, oyNAME_DESCRIPTION ), oyProfile_GetFileName(temp_prof, 0)); oyProfile_Release( &temp_prof ); }
[in,out] | list | the to be sorted profile list |
[in] | device | filter pattern |
[in,out] | rank_list | list of rank levels for the profile list |
References oyConfig_s::oyConfig_Compare(), oyConfig_s::oyConfig_FindString(), oyConfig_s::oyConfig_FromRegistration(), oyOBJECT_PROFILES_S, oyOptions_s::oyOptions_Clear(), oyOptions_s::oyOptions_Count(), oyProfile_s::oyProfile_GetDevice(), oyProfile_s::oyProfile_GetFileName(), oyProfile_s::oyProfile_Release(), oyProfiles_Count(), oyProfiles_Get(), and oyStructList_s::oyStructList_Sort().
OYAPI oyProfiles_s *OYEXPORT oyProfiles_ForStd | ( | oyPROFILE_e | std_profile_class, |
int * | current, | ||
oyObject_s | object | ||
) |
Get a list of installed profiles.
Function oyProfiles_ForStd
Allow for a special case with oyDEFAULT_PROFILE_START in the color_space argument, to select all possible standard color profiles, e.g. for typical color conversions.
oyASSUMED_WEB will result in exactly one profile added as long as it is available in the file paths.
[in] | std_profile_class | standard profile class, e.g. oyEDITING_RGB |
[out] | current | get the color_space profile position |
object | a optional object |
// Get all ICC profiles, which can be used as assumed RGB profile oyPROFILE_e type = oyEDITING_RGB; int current = 0, size, i; oyProfile_s * temp_prof = 0; oyProfiles_s * iccs = 0; iccs = oyProfiles_ForStd( type, ¤t, 0 ); size = oyProfiles_Count(iccs); for( i = 0; i < size; ++i) { temp_prof = oyProfiles_Get( iccs, i ); // Show the profile internal and file names on the command line printf("%s %d: \"%s\" %s\n", i == current ? "*":" ", i, oyProfile_GetText( temp_prof, oyNAME_DESCRIPTION ), oyProfile_GetFileName(temp_prof, -1)); oyProfile_Release( &temp_prof ); }
References oyASSUMED_CMYK, oyASSUMED_GRAY, oyASSUMED_LAB, oyASSUMED_RGB, oyASSUMED_WEB, oyASSUMED_XYZ, oyEDITING_CMYK, oyEDITING_GRAY, oyEDITING_LAB, oyEDITING_RGB, oyEDITING_XYZ, oyGetDefaultProfileName(), oyProfile_s::oyProfile_FromSignature(), oyProfile_s::oyProfile_FromStd(), oyPROFILE_PROOF, oyProfile_s::oyProfile_SetSignature(), oyProfiles_MoveIn(), oyProfiles_New(), oySIGNATURE_CLASS, and oySIGNATURE_COLOR_SPACE.
OYAPI oyProfile_s *OYEXPORT oyProfiles_Get | ( | oyProfiles_s * | list, |
int | pos | ||
) |
get a element of a Profiles list
Function oyProfiles_Get
[in,out] | list | the list |
pos | position |
References oyOBJECT_PROFILE_S, oyOBJECT_PROFILES_S, and oyStructList_s::oyStructList_GetRefType().
Referenced by oyProfiles_DeviceRank().
OYAPI int OYEXPORT oyProfiles_MoveIn | ( | oyProfiles_s * | list, |
oyProfile_s ** | obj, | ||
int | pos | ||
) |
add an element to a Profiles list
Function oyProfiles_MoveIn
[in] | list | list |
[in,out] | obj | list element |
pos | position |
References oyOBJECT_PROFILE_S, oyOBJECT_PROFILES_S, oyStructList_s::oyStructList_Create(), oyStructList_s::oyStructList_MoveIn(), and oyProfile_s::type_.
Referenced by oyProfiles_ForStd().
OYAPI oyProfiles_s *OYEXPORT oyProfiles_New | ( | oyObject_s | object | ) |
allocate a new Profiles object
Function oyProfiles_New
References oyOBJECT_OBJECT_S.
Referenced by oyProfiles_Create(), and oyProfiles_ForStd().
OYAPI int OYEXPORT oyProfiles_Release | ( | oyProfiles_s ** | profiles | ) |
release and possibly deallocate a oyProfiles_s object
Function oyProfiles_Release
[in,out] | profiles | Profiles struct object |
References oyOBJECT_PROFILES_S.
OYAPI int OYEXPORT oyProfiles_ReleaseAt | ( | oyProfiles_s * | list, |
int | pos | ||
) |
release a element from a Profiles list
Function oyProfiles_ReleaseAt
[in,out] | list | the list |
pos | position |
References oyOBJECT_PROFILES_S, oyStructList_s::oyStructList_GetParentObjType(), and oyStructList_s::oyStructList_ReleaseAt().
OYAPI int OYEXPORT oyProfiles_Sort | ( | oyProfiles_s * | list, |
int32_t * | rank_list | ||
) |
sort a list according to a rank_list
Function oyProfiles_Sort
References oyOBJECT_PROFILES_S, and oyStructList_s::oyStructList_Sort().
oyStruct_Copy_f oyProfiles_s::copy |
Copy function.
oyObject_s oyProfiles_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyProfiles_s::release |
Release function.
const oyOBJECT_e oyProfiles_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.