Aurelon Open API 8.1.1
Loading...
Searching...
No Matches
AOI_ColorSpace_Indexed Class Reference

Indexed colors. More...

Inherits AOI_ColorSpace.

Public Member Functions

uint32_t GetColorCount () const
 
AOI_ColorSpacePtr GetBase () const
 
void GetColor (uint32_t, uint16_t *) const
 
uint32_t GetType () const
 
AOI_ColorSpaceEnum Space () const
 
uint32_t NrOfComponents () const
 
const char * ChannelName (uint32_t) const
 
void GetCIELab (const uint16_t *src, float *out) const
 

Detailed Description

Indexed colors.

Definition at line 100 of file AOI_ColorSpace.h.

Member Function Documentation

◆ ChannelName()

const char * AOI_ColorSpace::ChannelName ( uint32_t channel) const
inherited

Returns the channel name of the requested channel of the colorspace. Thus "Red" for channel 0 of RGB.

Parameters
channelIndex of the channel. Must be less than NrOfComponents
Returns
Name of the channel.
See also
NrOfComponents

Definition at line 133 of file AOI_ColorSpace.cpp.

◆ GetBase()

AOI_ColorSpacePtr AOI_ColorSpace_Indexed::GetBase ( ) const

Returns the colorspace of the colors defined in the colortable of this indexed colorspace object.

Returns
Colorspace of the colortable.
See also
GetColorCount, GetColor

Definition at line 368 of file AOI_ColorSpace.cpp.

◆ GetCIELab()

void AOI_ColorSpace::GetCIELab ( const uint16_t * src,
float * out ) const
inherited

Retrieve the CIELab color of the given channel values. The channel values are converted to CIELab D50. The conversion follows the rules as explained in the PDF colorflow diagram. When no suiteable conversion to CIELab is available default conversions will be used. For example calling this method on a AOI_ColorSpace_DeviceRGB instance will invoke the build-in generic RGB to CIELab convertor.

Parameters
srcInput channels 16 bits encoded. The number of channels must match the colorspace channel count
outReceives the resulting L, a, b values. L [0,100], a <-128,127], b <-128,127]

Definition at line 149 of file AOI_ColorSpace.cpp.

◆ GetColor()

void AOI_ColorSpace_Indexed::GetColor ( uint32_t index,
uint16_t * color ) const

Retrieves the channel values at the given index in colortable of this indexed colorspace object. The channel values are to be used with the colorspace gotten from GetBase.

Parameters
indexIndex in the colortable [0,GetColorCount>
colorChannel array to hold the channel values 16 bits encoded.
See also
GetBase, GetColorCount

Definition at line 382 of file AOI_ColorSpace.cpp.

◆ GetColorCount()

uint32_t AOI_ColorSpace_Indexed::GetColorCount ( ) const

Returns the number of colors defined in the colortable of this indexed colorspace object.

Returns
Number of colors of the colortable.
See also
GetBase, GetColor

Definition at line 356 of file AOI_ColorSpace.cpp.

◆ GetType()

uint32_t AOI_ColorSpace::GetType ( ) const
inherited

Class type of the colorspace. The return value is the type identifier of the colorspace class like AOI_ColorSpace_DeviceCMYK::Type for DeviceCMYK. This value is used to identify the colorspace type like CMYK, RGB, ICC, etc.

Returns
Colorspace class type.

Definition at line 97 of file AOI_ColorSpace.cpp.

◆ NrOfComponents()

uint32_t AOI_ColorSpace::NrOfComponents ( ) const
inherited

Returns the number of channels that is used by this colorspace. Thus 3 channels for RGB and 4 for CMYK etc.

Returns
Number of channels used by the colorspace.

Definition at line 120 of file AOI_ColorSpace.cpp.

◆ Space()

AOI_ColorSpaceEnum AOI_ColorSpace::Space ( ) const
inherited

Colorspace used by the colorspace object. Multiple colorspace objects might return the same colorspace. For example DeviceRGB, CalibratedRGB and a RGB ICC profile all return AOI_RGBSpace.

Returns
Colorspace used by the object.

Definition at line 109 of file AOI_ColorSpace.cpp.


The documentation for this class was generated from the following files: