Foxit PDF SDK
fsdk.ColorSpace Class Reference

Public Member Functions

def ConvertColor (color)
 Convert input color to the color in current color space.
More...
 
def GetColorSpaceType ()
 Get color space type.
More...
 
def GetComponentCount ()
 Get the count of components.
More...
 
def GetComponentNames ()
 Get a string array which represents the name of colorant for Separation color space, or names specifying the individual color components for DeviceN color space.
More...
 
def IsEmpty ()
 Check whether current object is empty or not.
More...
 
def IsSpotColorSpace ()
 Check whether current color space object is a spot color space or not.
More...
 

Detailed Description

This class represents color space. User can use this class to covert colors.

Member Function Documentation

◆ ConvertColor()

def fsdk.ColorSpace.ConvertColor (   color)

Convert input color to the color in current color space.

Convert input R/G/B component values to a color in current color space.

Convert input C/M/Y/K component values to a color object in current color space.

Parameters
[in]colorInput color, which is to be converted to current color space.
Returns
Converted color. If the return value of function fsdk.Color.IsEmpty for the returned color is true, that means the conversion failed.
Parameters
[in]c_valueC component value. Valid range: from 0 to 255.
[in]m_valueM component value. Valid range: from 0 to 255.
[in]y_valueY component value. Valid range: from 0 to 255.
[in]k_valueK component value. Valid range: from 0 to 255.
Returns
Converted color. If the return value of function fsdk.Color.IsEmpty for the returned color is true, that means the conversion failed.
Parameters
[in]r_valueR component value. Valid range: from 0 to 255.
[in]g_valueG component value. Valid range: from 0 to 255.
[in]b_valueB component value. Valid range: from 0 to 255.
Returns
Converted color. If the return value of function fsdk.Color.IsEmpty for the returned color is true, that means the conversion failed.

◆ GetColorSpaceType()

def fsdk.ColorSpace.GetColorSpaceType ( )

Get color space type.

Returns
Color space type. Please refer to values starting from fsdk.E_ColorSpaceInvalid and this would be one of these values.

◆ GetComponentCount()

def fsdk.ColorSpace.GetComponentCount ( )

Get the count of components.

For different color space type, the count of components are not the same.

Returns
Count of components.

◆ GetComponentNames()

def fsdk.ColorSpace.GetComponentNames ( )

Get a string array which represents the name of colorant for Separation color space, or names specifying the individual color components for DeviceN color space.

This function is only available when current color space type is fsdk.E_ColorSpaceSeparation or fsdk.E_ColorSpaceDeviceN . For other color space type, this function will return an empty string array.

Returns
A string array of name(s).
  • For Separation color space, the count of returned array will be only one and the string specifies the name of colorant.
  • For DeviceN color space, there can be several strings in returned array and they specify the individual color components.

◆ IsEmpty()

def fsdk.ColorSpace.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ IsSpotColorSpace()

def fsdk.ColorSpace.IsSpotColorSpace ( )

Check whether current color space object is a spot color space or not.

Returns
true means current object is spot color space, while false means not.