Foxit PDF SDK
foxit::addon::optimization::ImageSettings类 参考
类 foxit::addon::optimization::ImageSettings 继承关系图:
foxit::Base

Public 类型

enum  ImageCompressMode {
  e_ImageCompressHigh = 10003, e_ImageCompressjpeg = 10005, e_ImageCompressjpeg2000 = 10006, e_ImageCompressRetain = 10007,
  e_ImageCompressZip = 10009
}
 用于彩色或灰度图像的压缩模式枚举。 更多...
 
enum  ImageCompressQuality {
  e_ImageCompressQualityMinimum = 1, e_ImageCompressQualityLow = 2, e_ImageCompressQualityMedium = 3, e_ImageCompressQualityHigh = 4,
  e_ImageCompressQualityMaximum = 5, e_ImageCompressQualityLossless = 6
}
 用于彩色或灰度图像的有损压缩质量枚举。 更多...
 
enum  StretchMode {
  e_StretchDefault = -1, e_StretchOff = 0x00, e_StretchInterpol = 0x20, e_StretchDownsample = 0x04,
  e_StretchBicubic = 0x80, e_StretchNoSmooth = 0x100
}
 拉伸模式的枚举。 更多...
 

Public 成员函数

 ImageSettings ()
 构造函数。 更多...
 
 ImageSettings (const ImageSettings &other)
 构造函数,使用另一个图像设置对象。 更多...
 
 ~ImageSettings ()
 析构函数。
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const ImageSettings &other) const
 不等于操作符。 更多...
 
ImageSettingsoperator= (const ImageSettings &other)
 赋值操作符。 更多...
 
bool operator== (const ImageSettings &other) const
 等于操作符。 更多...
 
void SetBackgroundDownScale (int32 down_scale)
 设置有损压缩模式的背景降采样值,用于优化PDF文档中的彩色图像。 更多...
 
void SetCompressionMode (ImageCompressMode mode)
 设置用于优化PDF文档中彩色/灰度图像的压缩模式。 更多...
 
void SetForegroundDownScale (int32 down_scale)
 设置有损压缩模式的前景降采样值,用于优化PDF文档中的彩色图像。 更多...
 
void SetImageDPI (int32 dpi)
 设置DPI值作为压缩PDF文档中彩色/灰度图像的目标压缩值。 更多...
 
void SetImageDPILimit (int dpi_limit)
 设置彩色/灰度图像的下限DPI值,以决定是否在PDF文档中压缩图像。 更多...
 
void SetQuality (ImageCompressQuality quality)
 设置有损压缩模式的质量,用于优化PDF文档中的彩色/灰度图像。 更多...
 
void SetStretchMode (StretchMode mode)
 设置用于优化PDF文档中彩色/灰度图像的拉伸模式。 更多...
 
void SetTextSensitivity (int32 text_sensitivity)
 设置有损压缩模式的文本敏感度,用于优化PDF文档中的彩色图像。 更多...
 
void SetTileSize (int size)
 设置JPEG2000压缩模式的瓦片大小,用于优化PDF文档中的彩色/灰度图像。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类表示彩色和灰度图像的降采样/重压缩设置。 此类对象可以设置到 OptimizerSettings 类,然后用于优化PDF文档。

参见
OptimizerSettings

成员枚举类型说明

◆ ImageCompressMode

用于彩色或灰度图像的压缩模式枚举。

此枚举的值应单独使用。

枚举值
e_ImageCompressHigh 

压缩模式:高压缩。

e_ImageCompressjpeg 

压缩模式:JPEG。

e_ImageCompressjpeg2000 

压缩模式:JPEG2000。

e_ImageCompressRetain 

压缩模式:保持原样,即不压缩。

e_ImageCompressZip 

压缩模式:ZIP。

◆ ImageCompressQuality

用于彩色或灰度图像的有损压缩质量枚举。

此枚举的值应单独使用。

枚举值
e_ImageCompressQualityMinimum 

压缩质量:最小。

e_ImageCompressQualityLow 

压缩质量:低。

e_ImageCompressQualityMedium 

压缩质量:中等。

e_ImageCompressQualityHigh 

压缩质量:高。

e_ImageCompressQualityMaximum 

压缩质量:最大。

e_ImageCompressQualityLossless 

压缩质量:无损,仅适用于JPEG2000压缩模式。

◆ StretchMode

拉伸模式的枚举。

此枚举的值应单独使用。

枚举值
e_StretchDefault 

当设置此值时,表示进行默认拉伸。

e_StretchOff 

当设置此值时,表示不进行拉伸。

e_StretchInterpol 

当设置此值时,表示进行缩放插值。

e_StretchDownsample 

当设置此值时,表示在缩小或旋转时不进行半色调处理。

e_StretchBicubic 

当设置此值时,表示进行双三次插值缩放。

e_StretchNoSmooth 

当设置此值时,表示拉伸时不进行任何插值。

构造及析构函数说明

◆ ImageSettings() [1/2]

foxit::addon::optimization::ImageSettings::ImageSettings ( )

构造函数。

此构造函数用于构造具有默认设置选项的彩色/灰度图像设置对象。 用户也可以调用此类中的"set"方法来更改这些设置选项。 有关默认值的更多详细信息,请参考这些"set"方法的注释。

◆ ImageSettings() [2/2]

foxit::addon::optimization::ImageSettings::ImageSettings ( const ImageSettings other)

构造函数,使用另一个图像设置对象。

参数
[in]other另一个图像设置对象。

成员函数说明

◆ IsEmpty()

bool foxit::addon::optimization::ImageSettings::IsEmpty ( ) const

检查当前对象是否为空。

当当前对象为空时,意味着当前对象无用。

返回
true 表示当前对象为空,而 false 表示不为空。

◆ operator !=()

bool foxit::addon::optimization::ImageSettings::operator != ( const ImageSettings other) const

不等于操作符。

参数
[in]other另一个图像设置对象。此函数将检查当前对象是否不等于此对象。
返回
true 表示不相等,而 false 表示相等。

◆ operator=()

ImageSettings& foxit::addon::optimization::ImageSettings::operator= ( const ImageSettings other)

赋值操作符。

参数
[in]other另一个图像设置对象,其值将被分配给当前对象。
返回
对当前对象本身的引用。

◆ operator==()

bool foxit::addon::optimization::ImageSettings::operator== ( const ImageSettings other) const

等于操作符。

参数
[in]other另一个图像设置对象。此函数将检查当前对象是否等于此对象。
返回
true 表示相等,而 false 表示不相等。

◆ SetBackgroundDownScale()

void foxit::addon::optimization::ImageSettings::SetBackgroundDownScale ( int32  down_scale)

设置有损压缩模式的背景降采样值,用于优化PDF文档中的彩色图像。

此函数用于降低背景图像的分辨率。

参数
[in]down_scale有损压缩模式的背景降采样值。应该大于0。 如果值为1,则不降低背景分辨率。 如果值大于1,值越高,背景分辨率越低。 如果不调用此函数来设置此选项,那么将使用3作为此选项的默认值。
返回
无。

◆ SetCompressionMode()

void foxit::addon::optimization::ImageSettings::SetCompressionMode ( ImageCompressMode  mode)

设置用于优化PDF文档中彩色/灰度图像的压缩模式。

对于新构造的对象,如果不调用此函数来设置选项, 那么将使用 ImageSettings::e_ImageCompressjpeg 作为此选项的默认值。

参数
[in]mode图像压缩模式。请参考从 ImageSettings::e_ImageCompressHigh 开始的值, 并且应该是这些值中的一个。
返回
无。

◆ SetForegroundDownScale()

void foxit::addon::optimization::ImageSettings::SetForegroundDownScale ( int32  down_scale)

设置有损压缩模式的前景降采样值,用于优化PDF文档中的彩色图像。

此函数用于降低前景图像的分辨率。

参数
[in]down_scale有损压缩模式的前景降采样值。应该大于0。 如果值为1,则不降低前景分辨率。 如果值大于1,值越高,前景分辨率越低。 如果不调用此函数来设置此选项,那么将使用3作为此选项的默认值。
返回
无。

◆ SetImageDPI()

void foxit::addon::optimization::ImageSettings::SetImageDPI ( int32  dpi)

设置DPI值作为压缩PDF文档中彩色/灰度图像的目标压缩值。

当图像可以被压缩时,此图像的分辨率将被压缩到当前函数设置的DPI值。
对于新构造的对象,如果不调用此函数来设置选项, 则表示使用150作为此选项的默认值。

参数
[in]dpi设置为目标压缩DPI值的DPI值。
返回
无返回值。

◆ SetImageDPILimit()

void foxit::addon::optimization::ImageSettings::SetImageDPILimit ( int  dpi_limit)

设置彩色/灰度图像的下限DPI值,以决定是否在PDF文档中压缩图像。

如果PDF文档中图像的分辨率高于下限DPI值,则此图像将被压缩到 由函数 ImageSettings::SetImageDPI 设置的目标压缩DPI值。
对于新构造的对象,如果不调用此函数来设置选项, 那么将使用一个DPI值(目标压缩DPI值的1.5倍)作为 此选项的默认值。

参数
[in]dpi_limit作为下限的DPI值。此值应该是正数。建议范围: 大于目标压缩DPI值(通过函数 ImageSettings::SetImageDPI 设置), 最大值是目标压缩DPI值的10倍。
如果输入值不大于目标压缩DPI值,将使用比目标压缩DPI值多1的DPI值。
如果输入值大于最大值,将使用最大值。
返回
无。

◆ SetQuality()

void foxit::addon::optimization::ImageSettings::SetQuality ( ImageCompressQuality  quality)

设置有损压缩模式的质量,用于优化PDF文档中的彩色/灰度图像。

对于新构造的对象,如果不调用此函数来设置此选项, 那么将使用 ImageSettings::e_ImageCompressQualityMinimum 作为 此选项的默认值。

参数
[in]quality有损压缩模式的质量值。请参考从 ImageSettings::e_ImageCompressQualityMinimum 开始的值,应该是这些值中的一个。
返回
无。

◆ SetStretchMode()

void foxit::addon::optimization::ImageSettings::SetStretchMode ( StretchMode  mode)

设置用于优化PDF文档中彩色/灰度图像的拉伸模式。

对于新构造的对象,如果不调用此函数来设置此选项, 则表示使用 ImageSettings::e_StretchBicubic 作为此选项的默认值。

参数
[in]mode拉伸模式。请参考从 ImageSettings::e_StretchOff 开始的值, 这应该是这些值中的一个。
返回
无返回值。

◆ SetTextSensitivity()

void foxit::addon::optimization::ImageSettings::SetTextSensitivity ( int32  text_sensitivity)

设置有损压缩模式的文本敏感度,用于优化PDF文档中的彩色图像。

此函数影响将图像分割为前景(通常是文本)和背景。 如果不调用此函数来设置此选项,那么将使用60作为此选项的默认值。

参数
[in]text_sensitivity文本敏感度值。较高的敏感度值 会使更多内容在前景中表示。此值在处理低对比度文档 以及背景中包含图案、图像或颜色的文档时特别重要。 相反,对于具有高对比度、清晰明亮背景和锐利暗色符号的 简单文本文档,影响较小。 有效值:从0到100。
返回
无。

◆ SetTileSize()

void foxit::addon::optimization::ImageSettings::SetTileSize ( int  size)

设置JPEG2000压缩模式的瓦片大小,用于优化PDF文档中的彩色/灰度图像。

对于新构造的对象,如果不调用此函数来设置此选项, 那么将使用256作为此选项的默认值。

参数
[in]size瓦片的大小,此值只能在128到2048之间。
注解
此方法仅在 ImageSettings::e_ImageCompressjpeg2000 压缩模式下有效。
返回
无。