![]() |
Oyranos Color Management System API |
Single Color object. More...
#include <oyNamedColor_s.h>
Public Member Functions | |
OYAPI oyNamedColor_s *OYEXPORT | oyNamedColor_New (oyObject_s object) |
allocate a new NamedColor object More... | |
OYAPI oyNamedColor_s *OYEXPORT | oyNamedColor_Copy (oyNamedColor_s *namedcolor, oyObject_s object) |
copy or reference a NamedColor object More... | |
OYAPI int OYEXPORT | oyNamedColor_Release (oyNamedColor_s **namedcolor) |
release and possibly deallocate a oyNamedColor_s object More... | |
oyNamedColor_s * | oyNamedColor_Create (const double *chan, const char *blob, int blob_len, oyProfile_s *ref, oyObject_s object) |
manage complex oyNamedColor_s inside Oyranos More... | |
oyNamedColor_s * | oyNamedColor_CreateWithName (const char *nick, const char *name, const char *description, const double *chan, const double *XYZ, const char *blob, int blob_len, oyProfile_s *profile_ref, oyObject_s object) |
create a oyNamedColor_s struct More... | |
oyProfile_s * | oyNamedColor_GetSpaceRef (oyNamedColor_s *color) |
get a color space reference More... | |
void | oyNamedColor_SetChannels (oyNamedColor_s *color, const double *channels, uint32_t flags) |
set color channels More... | |
int | oyNamedColor_GetColor (oyNamedColor_s *color, oyProfile_s *profile, oyPointer buf, oyDATATYPE_e buf_type, uint32_t flags, oyOptions_s *options) |
convert a named color to a standard color space More... | |
int | oyNamedColor_SetColorStd (oyNamedColor_s *color, oyPROFILE_e color_space, oyPointer channels, oyDATATYPE_e channels_type, uint32_t flags, oyOptions_s *options) |
set color channels More... | |
const double * | oyNamedColor_GetChannelsConst (oyNamedColor_s *color, uint32_t *flags) |
get color channels More... | |
const double * | oyNamedColor_GetXYZConst (oyNamedColor_s *color) |
get XYZ channels More... | |
int | oyNamedColor_GetColorStd (oyNamedColor_s *color, oyPROFILE_e color_space, oyPointer buf, oyDATATYPE_e buf_type, uint32_t *flags, oyOptions_s *options) |
convert a named color to a standard color space More... | |
const char * | oyNamedColor_GetName (oyNamedColor_s *color, oyNAME_e type, uint32_t flags) |
get color channels 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... | |
Single Color object.
OYAPI oyNamedColor_s *OYEXPORT oyNamedColor_Copy | ( | oyNamedColor_s * | namedcolor, |
oyObject_s | object | ||
) |
copy or reference a NamedColor object
Function oyNamedColor_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | namedcolor | NamedColor struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_NAMED_COLOR_S.
oyNamedColor_s * oyNamedColor_Create | ( | const double * | chan, |
const char * | blob, | ||
int | blob_len, | ||
oyProfile_s * | ref, | ||
oyObject_s | object | ||
) |
manage complex oyNamedColor_s inside Oyranos
[in] | chan | pointer to channel data with a number of elements specified in sig or channels_n, optional |
[in] | blob | CGATS or other reference data, optional |
[in] | blob_len | length of the data blob |
[in] | ref | possibly a ICC profile |
object | the optional object |
References oyNamedColor_New(), oyProfile_s::oyProfile_Copy(), and oyProfile_s::oyProfile_GetChannelsCount().
oyNamedColor_s * oyNamedColor_CreateWithName | ( | const char * | nick, |
const char * | name, | ||
const char * | description, | ||
const double * | chan, | ||
const double * | XYZ, | ||
const char * | blob, | ||
int | blob_len, | ||
oyProfile_s * | profile_ref, | ||
oyObject_s | object | ||
) |
create a oyNamedColor_s struct
Function: oyNamedColor_CreateWithName
[in] | nick | very short, only a few letters |
[in] | name | of the color |
[in] | description | description |
[in] | chan | pointer to channel data with a number of elements specified in sig or channels_n |
[in] | XYZ | reference values |
[in] | blob | CGATS or other reference data |
[in] | blob_len | length of the data blob |
[in] | profile_ref | profile |
[in] | object | memory management |
const double * oyNamedColor_GetChannelsConst | ( | oyNamedColor_s * | color, |
uint32_t * | flags | ||
) |
get color channels
Function: oyNamedColor_GetChannelsConst
[in] | color | Oyranos color struct pointer |
[in] | flags | reserved |
int oyNamedColor_GetColor | ( | oyNamedColor_s * | color, |
oyProfile_s * | profile, | ||
oyPointer | buf, | ||
oyDATATYPE_e | buf_type, | ||
uint32_t | flags, | ||
oyOptions_s * | options | ||
) |
convert a named color to a standard color space
Function: oyNamedColor_GetColor
References oyEDITING_XYZ, and oyProfile_s::oyProfile_FromStd().
int oyNamedColor_GetColorStd | ( | oyNamedColor_s * | color, |
oyPROFILE_e | color_space, | ||
oyPointer | buf, | ||
oyDATATYPE_e | buf_type, | ||
uint32_t * | flags, | ||
oyOptions_s * | options | ||
) |
convert a named color to a standard color space
Function: oyNamedColor_GetColorStd
References oyDOUBLE, and oyEDITING_LAB.
const char * oyNamedColor_GetName | ( | oyNamedColor_s * | color, |
oyNAME_e | type, | ||
uint32_t | flags | ||
) |
get color channels
Function: oyNamedColor_GetName
Referenced by oyNamedColors_s::oyNamedColors_GetColorName().
oyProfile_s * oyNamedColor_GetSpaceRef | ( | oyNamedColor_s * | color | ) |
get a color space reference
Function: oyNamedColor_GetSpaceRef
References oyProfile_s::oyProfile_Copy().
const double * oyNamedColor_GetXYZConst | ( | oyNamedColor_s * | color | ) |
get XYZ channels
Function: oyNamedColor_GetXYZConst
[in] | color | Oyranos color struct pointer |
OYAPI oyNamedColor_s *OYEXPORT oyNamedColor_New | ( | oyObject_s | object | ) |
allocate a new NamedColor object
Function oyNamedColor_New
References oyOBJECT_OBJECT_S.
Referenced by oyNamedColor_Create().
OYAPI int OYEXPORT oyNamedColor_Release | ( | oyNamedColor_s ** | namedcolor | ) |
release and possibly deallocate a oyNamedColor_s object
Function oyNamedColor_Release
[in,out] | namedcolor | NamedColor struct object |
References oyOBJECT_NAMED_COLOR_S.
void oyNamedColor_SetChannels | ( | oyNamedColor_s * | color, |
const double * | channels, | ||
uint32_t | flags | ||
) |
set color channels
Function: oyNamedColor_SetChannels
[in] | color | Oyranos color struct pointer |
[in] | channels | pointer to channel data |
[in] | flags | reserved |
References oyProfile_s::oyProfile_GetChannelsCount().
int oyNamedColor_SetColorStd | ( | oyNamedColor_s * | color, |
oyPROFILE_e | color_space, | ||
oyPointer | channels, | ||
oyDATATYPE_e | channels_type, | ||
uint32_t | flags, | ||
oyOptions_s * | options | ||
) |
set color channels
Function: oyNamedColor_SetColorStd
[in] | color | Oyranos color struct pointer |
[in] | color_space | Oyranos standard color space |
[in] | channels | pointer to channel data |
[in] | channels_type | data type |
[in] | flags | reserved for future use |
[in] | options | for filter node creation |
References oyDOUBLE, and oyEDITING_LAB.
oyStruct_Copy_f oyNamedColor_s::copy |
Copy function.
oyObject_s oyNamedColor_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyNamedColor_s::release |
Release function.
const oyOBJECT_e oyNamedColor_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by oyNamedColors_s::oyNamedColors_MoveIn().