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 | StretchMode { 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 setting 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 image DPI used for optimizing color/gray images in a PDF document. More... | |
void | SetQuality (int32 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 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 calling "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 setting object.
[in] | other | Another ImageSettings 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 result image setting 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 result image setting object, whose value would be assigned to current object. |
bool foxit::addon::optimization::ImageSettings::operator== | ( | const ImageSettings & | other | ) | const |
Equal operator.
[in] | other | Another result ImageSettings 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 deault 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 image DPI 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 150 as the deault value of this option.
[in] | dpi | DPI value. |
void foxit::addon::optimization::ImageSettings::SetQuality | ( | int32 | 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 2 as the deault value of this option.
[in] | quality | Quality value for lossy compression modes. Valid range: from 1 to 5. 5 means lossless (if possible). |
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 deault 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. |