Foxit PDF SDK
|
Public Types | |
enum | ImageCompressMode { e_ImageCompressHigh = 10003, e_ImageCompressjpeg = 10005, e_ImageCompressjpeg2000 = 10006, e_ImageCompressRetain = 10007 } |
Enumeration for compression mode used for color or gray image. More... | |
enum | ImageCompressQuality { e_ImageCompressQualityMinimum = 1, e_ImageCompressQualityLow = 2, e_ImageCompressQualityMedium = 3, e_ImageCompressQualityHigh = 4, e_ImageCompressQualityMaximum = 5 } |
Enumeration for loss compression quality used for color or gray image. More... | |
enum | StretchMode { e_StretchDefault = -1, e_StretchOff = 0x00, e_StretchInterpol = 0x20, e_StretchDownsample = 0x04, e_StretchBicubic = 0x80, e_StretchNoSmooth = 0x100 } |
Enumeration for stretch mode. More... | |
Public Member Functions | |
ImageSettings () | |
Constructor. More... | |
ImageSettings (const ImageSettings &other) | |
Constructor, with another image settings object. More... | |
~ImageSettings () | |
Destructor. | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator != (const ImageSettings &other) const |
Not equal operator. More... | |
ImageSettings & | operator= (const ImageSettings &other) |
Assign operator. More... | |
bool | operator== (const ImageSettings &other) const |
Equal operator. More... | |
void | SetCompressionMode (ImageCompressMode mode) |
Set compression mode used for optimizing color/gray images in a PDF document. More... | |
void | SetImageDPI (int32 dpi) |
Set the DPI value as the target compressed value for compressing color/gray images in a PDF document. More... | |
void | SetImageDPILimit (int dpi_limit) |
Set the lower limit DPI value for the color/gray image to decide if the image is to be compressed in a PDF document. More... | |
void | SetQuality (ImageCompressQuality quality) |
Set the quality for lossy compression modes, used for optimizing color/gray images in a PDF document. More... | |
void | SetStretchMode (StretchMode mode) |
Set stretch mode used for optimizing color/gray images in a PDF document. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class represents downsampling/recompression settings for color and grayscale images. This class object can be set to class OptimizerSettings and then be used to optimize a PDF document.
Enumeration for compression mode used for color or gray image.
Values of this enumeration should be used alone.
Enumeration for loss compression quality used for color or gray image.
Values of this enumeration should be used alone.
Enumeration for stretch mode.
Values of this enumeration should be used alone.
foxit::addon::optimization::ImageSettings::ImageSettings | ( | ) |
Constructor.
This constructor is to construct a color/gray image settings object with default setting options. User can also call "set" methods in this class to change these setting options. Please refer to comment of these "set" methods for more details about default values.
foxit::addon::optimization::ImageSettings::ImageSettings | ( | const ImageSettings & | other | ) |
Constructor, with another image settings object.
[in] | other | Another image settings object. |
bool foxit::addon::optimization::ImageSettings::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::addon::optimization::ImageSettings::operator != | ( | const ImageSettings & | other | ) | const |
Not equal operator.
[in] | other | Another image settings object. This function will check if current object is not equal to this one. |
ImageSettings& foxit::addon::optimization::ImageSettings::operator= | ( | const ImageSettings & | other | ) |
Assign operator.
[in] | other | Another image settings object, whose value would be assigned to current object. |
bool foxit::addon::optimization::ImageSettings::operator== | ( | const ImageSettings & | other | ) | const |
Equal operator.
[in] | other | Another image settings object. This function will check if current object is equal to this one. |
void foxit::addon::optimization::ImageSettings::SetCompressionMode | ( | ImageCompressMode | mode | ) |
Set compression mode used for optimizing color/gray images in a PDF document.
For a newly constructed object, if this function is not called to set option, that means to use ImageSettings::e_ImageCompressjpeg as the default value of this option.
[in] | mode | Image compression mode. Please refer to values starting from ImageSettings::e_ImageCompressHigh and this should be one of these values. |
void foxit::addon::optimization::ImageSettings::SetImageDPI | ( | int32 | dpi | ) |
Set the DPI value as the target compressed value for compressing color/gray images in a PDF document.
When an image can be compressed, the resolution of this image will be compressed to the DPI value set by current function.
For a newly constructed object, if this function is not called to set option, that means to use 150 as the default value of this option.
[in] | dpi | DPI value which is set to be the target compressed DPI value. |
void foxit::addon::optimization::ImageSettings::SetImageDPILimit | ( | int | dpi_limit | ) |
Set the lower limit DPI value for the color/gray image to decide if the image is to be compressed in a PDF document.
If the resolution of an image in the PDF document is above the lower limit DPI value, this image will be compressed to the target compressed DPI value which is set by function ImageSettings::SetImageDPI.
For a newly constructed object, if this function is not called to set option, that means a DPI value (which is 1.5 times of target compressed DPI value) will be used as the default value of this option.
[in] | dpi_limit | DPI value as the lower limit. This value should be a positive number. Suggested range: bigger than target compressed DPI value (set by function ImageSettings::SetImageDPI) and the maximum value is 10 times of target compressed DPI value. If input value is not bigger than the target compressed DPI value, a DPI value which is one more than the target compressed DPI value will be used instead. If input value is bigger than the maximum value, the maximum value value will be used instead. |
void foxit::addon::optimization::ImageSettings::SetQuality | ( | ImageCompressQuality | quality | ) |
Set the quality for lossy compression modes, used for optimizing color/gray images in a PDF document.
For a newly constructed object, if this function is not called to set this option, that means to use ImageSettings::e_ImageCompressQualityMinimum as the default value of this option.
[in] | quality | Quality value for lossy compression modes. Please refer to values starting from ImageSettings::e_ImageCompressQualityMinimum and this should be one of these values. |
void foxit::addon::optimization::ImageSettings::SetStretchMode | ( | StretchMode | mode | ) |
Set stretch mode used for optimizing color/gray images in a PDF document.
For a newly constructed object, if this function is not called to set this option, that means to use ImageSettings::e_StretchBicubic as the default value of this option.
[in] | mode | Stretch mode. Please refer to values starting from ImageSettings::e_StretchOff and this should be one of these values. |