Named Colour API
[Alpha API's]

Collaboration diagram for Named Colour API:

Data Structures
struct	oyNamedColours_s
	list of colour patchesData management on library side. User can control memory management at creation time. More...
struct	oyNamedColour_s
	colour patch with meta informationsData management on library side. User can control memory management at creation time. More...
Functions
oyNamedColour_s *	oyNamedColour_s::oyNamedColour_Create (const double chan, const char blob, int blob_len, oyProfile_s *ref, oyObject_s object)
	manage complex oyNamedColour_s inside Oyranos
oyNamedColour_s *	oyNamedColour_s::oyNamedColour_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 oyNamedColour_s struct
oyNamedColour_s *	oyNamedColour_s::oyNamedColour_Copy (oyNamedColour_s *colour, oyObject_s object)
	copy
int	oyNamedColour_s::oyNamedColour_Release (oyNamedColour_s **obj)
	release correctly
oyProfile_s *	oyNamedColour_s::oyNamedColour_GetSpaceRef (oyNamedColour_s *colour)
	get a colour space reference
void	oyNamedColour_s::oyNamedColour_SetChannels (oyNamedColour_s colour, const double channels, uint32_t flags)
	set colour channels
int	oyNamedColour_s::oyNamedColour_GetColour (oyNamedColour_s colour, oyProfile_s profile, oyPointer buf, oyDATATYPE_e buf_type, uint32_t flags)
	convert a named colour to a standard colour space
int	oyNamedColour_s::oyNamedColour_SetColourStd (oyNamedColour_s *colour, oyPROFILE_e colour_space, oyPointer channels, oyDATATYPE_e channels_type, uint32_t flags)
	set colour channels
const double *	oyNamedColour_s::oyNamedColour_GetChannelsConst (oyNamedColour_s colour, uint32_t flags)
	get colour channels
const double *	oyNamedColour_s::oyNamedColour_GetXYZConst (oyNamedColour_s *colour)
	get XYZ channels
int	oyNamedColour_s::oyNamedColour_GetColourStd (oyNamedColour_s colour, oyPROFILE_e colour_space, oyPointer buf, oyDATATYPE_e buf_type, uint32_t flags)
	convert a named colour to a standard colour space
const oyChar *	oyNamedColour_s::oyNamedColour_GetName (oyNamedColour_s *s, oyNAME_e type, uint32_t flags)
	get colour channels
oyNamedColours_s *	oyNamedColours_s::oyNamedColours_New (oyObject_s object)
	create a list object for oyNamedColour_s
oyNamedColours_s *	oyNamedColours_s::oyNamedColours_Copy (oyNamedColours_s *colours, oyObject_s obj)
	Copy.
int	oyNamedColours_s::oyNamedColours_Release (oyNamedColours_s **obj)
	release and probably free a named colour object
int	oyNamedColours_s::oyNamedColours_Count (oyNamedColours_s *obj)
	count in oyNamedColours_s
oyNamedColour_s *	oyNamedColours_s::oyNamedColours_Get (oyNamedColours_s *obj, int position)
	obtain a referenced patch from the list
oyNamedColours_s *	oyNamedColours_s::oyNamedColours_MoveIn (oyNamedColours_s list, oyNamedColour_s *obj, int pos)
	add a patch to the colours list
int	oyNamedColours_s::oyNamedColours_ReleaseAt (oyNamedColours_s *obj, int position)
	release a patch from the list

Detailed Description

Named Colour API's.

Function Documentation

oyNamedColour_s * oyNamedColour_Copy	(	oyNamedColour_s *	colour,
		oyObject_s	object
	)			`[related, inherited]`

copy

Parameters:

`[in]`	colour	address of Oyranos colour struct
`[in]`	object	the optional base object

Returns:: copy

Since:: Oyranos: version 0.1.8

Date:: october 2007 (API 0.1.8)

References oyNamedColour_s::blob_, oyNamedColour_s::blob_len_, oyNamedColour_s::channels_, oyNamedColour_s::oyNamedColour_Create(), and oyNamedColour_s::profile_.

Referenced by oyNamedColour_s::oyNamedColour_Create().

oyNamedColour_s * oyNamedColour_Create	(	const double *	chan,
		const char *	blob,
		int	blob_len,
		oyProfile_s *	ref,
		oyObject_s	object
	)			`[related, inherited]`

manage complex oyNamedColour_s inside Oyranos

Since:: Oyranos: version 0.1.8

Date:: october 2007 (API 0.1.8)

Parameters:

`[in]`	chan	pointer to channel data with a number of elements specified in sig or channels_n
`[in]`	blob	CGATS or other reference data
`[in]`	blob_len	length of the data blob
`[in]`	ref	possibly a ICC profile, allowed abreviations are 'sRGB' 'XYZ' 'Lab'(D50)
	object	the optional object

References oyCopyColour(), oyNamedColour_s::oyNamedColour_Copy(), oyNamedColour_s::oyNamedColour_Release(), oyOBJECT_NAMED_COLOUR_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), oyProfile_s::oyProfile_Copy(), oyProfile_s::oyProfile_GetChannelsCount(), and oyNamedColour_s::release.

Referenced by oyNamedColour_s::oyNamedColour_Copy(), and oyNamedColour_s::oyNamedColour_CreateWithName().

oyNamedColour_s * oyNamedColour_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
	)			`[related, inherited]`

create a oyNamedColour_s struct

Function: oyNamedColour_CreateWithName

Since:: Oyranos: version 0.1.8

Date:: 22 december 2007 (API 0.1.8)

Parameters:

`[in]`	nick	very short, only a few letters
`[in]`	name	of the colour
`[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

Returns:: a oyNamedColour_s

References oyCopyColour(), oyNamedColour_s::oyNamedColour_Create(), oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_Release(), oyObject_s::oyObject_SetNames(), and oyNamedColour_s::XYZ_.

const double * oyNamedColour_GetChannelsConst	(	oyNamedColour_s *	colour,
		uint32_t *	flags
	)			`[related, inherited]`

get colour channels

Function: oyNamedColour_GetChannelsConst

Parameters:

`[in]`	colour	Oyranos colour struct pointer
`[in]`	flags	reserved

Returns:: pointer channels

Since:: Oyranos: version 0.1.8

Date:: october 2007 (API 0.1.8)

References oyNamedColour_s::channels_.

int oyNamedColour_GetColour	(	oyNamedColour_s *	colour,
		oyProfile_s *	profile,
		oyPointer	buf,
		oyDATATYPE_e	buf_type,
		uint32_t	flags
	)			`[related, inherited]`

convert a named colour to a standard colour space

Function: oyNamedColour_GetColour

Since:: Oyranos: version 0.1.8

Date:: 23 december 2007 (API 0.1.8)

References oyNamedColour_s::channels_, oyDOUBLE, oyEDITING_XYZ, oyProfile_s::oyProfile_FromStd(), oyProfile_s::oyProfile_Release(), oyNamedColour_s::profile_, and oyNamedColour_s::XYZ_.

Referenced by oyNamedColour_s::oyNamedColour_GetColourStd().

int oyNamedColour_GetColourStd	(	oyNamedColour_s *	colour,
		oyPROFILE_e	colour_space,
		oyPointer	buf,
		oyDATATYPE_e	buf_type,
		uint32_t *	flags
	)			`[related, inherited]`

convert a named colour to a standard colour space

Function: oyNamedColour_GetColourStd

Since:: Oyranos: version 0.1.8

Date:: 23 december 2007 (API 0.1.8)

References oyCopyColour(), oyDOUBLE, oyEDITING_LAB, oyEDITING_XYZ, oyNamedColour_s::oyNamedColour_GetColour(), oyProfile_s::oyProfile_FromStd(), oyProfile_s::oyProfile_Release(), oyXYZ2Lab(), and oyNamedColour_s::XYZ_.

Referenced by oyNamedColour_s::oyNamedColour_GetName().

const oyChar * oyNamedColour_GetName	(	oyNamedColour_s *	s,
		oyNAME_e	type,
		uint32_t	flags
	)			`[related, inherited]`

get colour channels

Function: oyNamedColour_GetName

Since:: Oyranos: version 0.1.8

Date:: 22 december 2007 (API 0.1.8)

References oyNamedColour_s::channels_, oyNamedColour_s::oy_, oyDOUBLE, oyEDITING_LAB, oyNAME_DESCRIPTION, oyNAME_NAME, oyNAME_NICK, oyNamedColour_s::oyNamedColour_GetColourStd(), oyObject_s::oyObject_GetName(), oyObject_s::oyObject_SetName(), oyProfile_s::oyProfile_GetSignature(), and oyNamedColour_s::profile_.

oyProfile_s * oyNamedColour_GetSpaceRef ( oyNamedColour_s * colour ) [related, inherited]

get a colour space reference

Function: oyNamedColour_GetSpaceRef

Since:: Oyranos: version 0.1.8

Date:: 23 december 2007 (API 0.1.8)

References oyProfile_s::oyProfile_Copy(), and oyNamedColour_s::profile_.

const double * oyNamedColour_GetXYZConst ( oyNamedColour_s * colour ) [related, inherited]

get XYZ channels

Function: oyNamedColour_GetiXYZConst

Parameters:

[in] colour Oyranos colour struct pointer

Returns:: pointer XYZ channels

Version:: Oyranos: 0.1.8

Date:: 2008/02/18

Since:: 2008/02/18 (Oyranos: 0.1.8)

References oyNamedColour_s::XYZ_.

int oyNamedColour_Release ( oyNamedColour_s ** obj ) [related, inherited]

release correctly

set pointer to zero

Parameters:

[in] obj address of Oyranos colour struct pointer

Since:: Oyranos: version 0.1.8

Date:: october 2007 (API 0.1.8)

References oyNamedColour_s::blob_, oyNamedColour_s::blob_len_, oyNamedColour_s::channels_, oyNamedColour_s::oy_, oyOBJECT_NAMED_COLOUR_S, oyObject_s::oyObject_Release(), oyProfile_s::oyProfile_Release(), oyNamedColour_s::profile_, and oyNamedColour_s::type_.

Referenced by oyNamedColour_s::oyNamedColour_Create().

void oyNamedColour_SetChannels	(	oyNamedColour_s *	colour,
		const double *	channels,
		uint32_t	flags
	)			`[related, inherited]`

set colour channels

Function: oyNamedColour_SetChannels

Parameters:

`[in]`	colour	Oyranos colour struct pointer
`[in]`	channels	pointer to channel data
`[in]`	flags	reserved

Since:: Oyranos: version 0.1.8

Date:: october 2007 (API 0.1.8)

References oyNamedColour_s::channels_, oyProfile_s::oyProfile_GetChannelsCount(), and oyNamedColour_s::profile_.

int oyNamedColour_SetColourStd	(	oyNamedColour_s *	colour,
		oyPROFILE_e	colour_space,
		oyPointer	channels,
		oyDATATYPE_e	channels_type,
		uint32_t	flags
	)			`[related, inherited]`

set colour channels

Function: oyNamedColour_SetColourStd

Parameters:

`[in]`	colour	Oyranos colour struct pointer
`[in]`	colour_space	Oyranos standard colour space
`[in]`	channels	pointer to channel data
`[in]`	channels_type	data type
`[in]`	flags	reserved for future use