Foxit PDF SDK
fsdk.Color Class Reference

Public Member Functions

def ConvertToCMYK (intent)
 Convert to a CMYK color.
More...
 
def ConvertToRGB (intent)
 Convert to a RGB color.
More...
 
def GetColorSpace ()
 Get the color space that current color belongs to.
More...
 
def GetValue ()
 Get component value array.
More...
 
def IsEmpty ()
 Check whether current object is empty or not.
More...
 
def SetValue (component_array)
 Set component value array.
More...
 

Detailed Description

This class represents a color.

Member Function Documentation

◆ ConvertToCMYK()

def fsdk.Color.ConvertToCMYK (   intent)

Convert to a CMYK color.

Parameters
[in]intent(Reserved) Rendering intent used for color conversion.
Returns
Converted color. If the return value of function fsdk.Color.IsEmpty for the returned color is true, that means the conversion failed.

◆ ConvertToRGB()

def fsdk.Color.ConvertToRGB (   intent)

Convert to a RGB color.

Parameters
[in]intent(Reserved) Rendering intent used for color conversion.
Returns
Converted color. If the return value of function fsdk.Color.IsEmpty for the returned color is true, that means the conversion failed.

◆ GetColorSpace()

def fsdk.Color.GetColorSpace ( )

Get the color space that current color belongs to.

Returns
Color space object.

◆ GetValue()

def fsdk.Color.GetValue ( )

Get component value array.

The count of components depends on the color space that current color belongs to. User can get the color space object by function fsdk.Color.GetColorSpace , and then get the count of componets by function fsdk.ColorSpace.GetComponentCount .

Returns
A component value array. Each component value would be in the range from 0.0 to 1.0.

◆ IsEmpty()

def fsdk.Color.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.

◆ SetValue()

def fsdk.Color.SetValue (   component_array)

Set component value array.

The count of components depends on the color space that current color belongs to. User can get the color space object by function fsdk.Color.GetColorSpace , and then get the count of componets by function fsdk.ColorSpace.GetComponentCount .

Parameters
[in]component_arrayA component value array. The count of components in this array should match the count of components of the color space that current color belongs to. Valid range of each component value: from 0.0 to 1.0.
Returns
None.