fsdk.Image类 参考

Public 成员函数
def	AddFrame (bitmap)
	添加位图作为帧。（不支持的DIB格式：fsdk.BitmapE_DIBRgb565 和 fsdk.BitmapE_DIB8bppMask ） 更多...
def	GetFrameBitmap (index)
	根据索引获取帧位图。 更多...
def	GetFrameCount ()
	获取帧数。 更多...
def	GetHeight ()
	获取图像高度。 更多...
def	GetOrientation ()
	获取图像方向。 更多...
def	GetType ()
	获取图像类型。 更多...
def	GetWidth ()
	获取图像宽度。 更多...
def	GetXDPI ()
	获取X轴的DPI。 更多...
def	GetYDPI ()
	获取Y轴的DPI。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	SaveAs (file_path)
	将当前图像保存为图像文件。 更多...
def	SaveAs (file, file_extension)
	将当前图像保存为图像文件。 更多...
def	SetDPIs (x_dpi, y_dpi)
	设置X轴和Y轴的DPI。 更多...

详细描述

Foxit PDF SDK提供以下图像类型：

• BMP：位图图像格式。只支持单帧。Foxit PDF SDK支持从BMP图像文件加载图像， 获取一些基本信息，获取其位图，更改其位图并将其保存为图像文件。

• JPG：联合图像专家组图像格式。只支持单帧。Foxit PDF SDK支持从JPG图像文件加载图像， 获取一些基本信息，获取其位图，更改其位图并将其保存为图像文件。

• PNG：便携式网络图形图像格式。只支持单帧。Foxit PDF SDK支持从PNG图像文件加载图像， 获取一些基本信息，获取其位图，更改其位图并将其保存为图像文件。

• GIF：图形交换格式。支持多帧。Foxit PDF SDK支持从GIF图像文件加载图像， 获取其大小，获取其位图，更改其位图并将其保存为图像文件。

• TIF：标签图像文件格式。支持多帧。Foxit PDF SDK支持从TIF图像文件加载图像， 获取一些基本信息，获取其位图，更改其位图并将其保存为图像文件。

• JPX：JPEG-2000图像格式。只支持单帧。Foxit PDF SDK支持从JPX图像文件加载图像， 获取其大小，获取其位图，更改其位图并将其保存为图像文件。

• JBIG2：JBIG2图像格式。只支持单帧。Foxit PDF SDK支持从JBIG2图像文件加载图像， 获取其大小，并将其保存为图像文件。Foxit PDF SDK尚不支持获取其帧位图。

成员函数说明

AddFrame()

def fsdk.Image.AddFrame

(

bitmap

)

添加位图作为帧。（不支持的DIB格式：fsdk.BitmapE_DIBRgb565 和 fsdk.BitmapE_DIB8bppMask ）

目前此函数不支持类型为 fsdk.ImageE_JBIG2 或 fsdk.ImageE_Unknown 的图像。
对于支持的图像类型：

• 如果当前图像的类型为 fsdk.ImageE_TIF 、fsdk.ImageE_GIF 或 fsdk.ImageE_None ，此函数将添加新位图 作为新的最后一帧。

• 如果当前图像的类型为其他类型之一，只包含单帧， 此函数将使用新位图替换第一帧。

参数

[in]

bitmap

要添加或设置的有效位图帧。

返回

true 表示成功，false 表示失败。

GetFrameBitmap()

def fsdk.Image.GetFrameBitmap

(

index

)

根据索引获取帧位图。

目前此函数不支持类型为 fsdk.ImageE_JBIG2 的图像。 此函数只能支持获取以下格式的帧位图：
fsdk.BitmapE_DIB8bppMask 、fsdk.BitmapE_DIB8bpp 、 fsdk.BitmapE_DIBRgb 、fsdk.BitmapE_DIBRgb32 、 fsdk.BitmapE_DIBArgb 。
对于其他不支持的DIB格式，此函数将返回一个位图对象， 其函数 fsdk.Bitmap.IsEmpty 返回 true。

参数

[in]

index

帧的索引。有效范围：从0到（count-1）。 count 由函数 fsdk.Image.GetFrameCount 返回。

返回

帧位图。如果返回的位图对象的函数 fsdk.Bitmap.IsEmpty 返回值为 true，则表示该帧的DIB格式不受支持。

GetFrameCount()

def fsdk.Image.GetFrameCount

(

)

获取帧数。

目前此函数不支持类型为 fsdk.ImageE_JBIG2 的图像。

返回

帧数。

GetHeight()

def fsdk.Image.GetHeight

(

)

获取图像高度。

如果图像有多帧，通常第一帧的大小将被视为图像大小。

返回

图像高度。

GetOrientation()

def fsdk.Image.GetOrientation

(

)

获取图像方向。

此函数只支持类型为 fsdk.ImageE_JPG 和 fsdk.ImageE_TIF 的图像。

返回

图像方向。请参考从 fsdk.ImageE_OrientationNone 开始的值， 这将是其中的一个值。

GetType()

def fsdk.Image.GetType

(

)

获取图像类型。

如果当前图像是新图像（不是从任何图像文件构造的），其类型为 fsdk.ImageE_None 。

返回

图像类型。请参考从 fsdk.ImageE_Unknown 开始的值， 这将是其中的一个值。

GetWidth()

def fsdk.Image.GetWidth

(

)

获取图像宽度。

如果图像有多帧，通常第一帧的大小将被视为图像大小。

返回

图像宽度。

GetXDPI()

def fsdk.Image.GetXDPI

(

)

获取X轴的DPI。

目前此函数不支持类型为 fsdk.ImageE_JPX 、 fsdk.ImageE_GIF 、fsdk.ImageE_JBIG2 或 fsdk.ImageE_WEBP 的图像。
对于新图像（不是从任何图像文件构造的），X轴的默认DPI为96。

返回

X轴的DPI值。

GetYDPI()

def fsdk.Image.GetYDPI

(

)

获取Y轴的DPI。

目前此函数不支持类型为 fsdk.ImageE_JPX 、 fsdk.ImageE_GIF 、fsdk.ImageE_JBIG2 或 fsdk.ImageE_WEBP 的图像。
对于新图像（不是从任何图像文件构造的），Y轴的默认DPI为96。

返回

Y轴的DPI值。

IsEmpty()

def fsdk.Image.IsEmpty

(

)

检查当前对象是否为空。

当前对象为空时，表示当前对象无用。

返回

true 表示当前对象为空，false 表示不为空。

SaveAs() [1/2]

def fsdk.Image.SaveAs

(

file_path

)

将当前图像保存为图像文件。

如果当前图像的类型为 fsdk.ImageE_TIF 、fsdk.ImageE_GIF 或 fsdk.ImageE_None ，且保存的图像文件类型不支持多帧， 则只有当前图像的第一帧会被保存到图像文件中。
如果保存的图像文件类型为 fsdk.ImageE_WEBP ，当前图像的位图格式 应为 fsdk.BitmapE_DIBRgb 、 或 。
对于图像对象（不是从任何图像文件构造的），请确保在使用此函数之前 至少向图像对象添加一个有效的帧位图； 否则此函数将失败。

参数

[in]

file_path

保存的图像文件的完整路径。不应为空字符串。 目前此函数支持以下扩展名： .bmp、.jpg、.jpeg、.png、.tif、.tiff、.jpx、.jp2。

返回

true 表示成功，false 表示失败。

注解

此函数不支持将当前图像对象保存回用于构造当前图像对象的图像文件。 为了实现这一点，建议用户按以下步骤操作：
假设当前图像对象是从名为"org.bmp"的图像文件构造的。

1. 使用当前函数将当前图像对象保存到临时文件。这里，此临时文件 命名为"temp.tmp"。

2. 确保当前图像对象已析构。

3. 删除"org.bmp"并将"temp.tmp"重命名为"org.bmp"。

SaveAs() [2/2]

def fsdk.Image.SaveAs	(		file,
			file_extension
	)

将当前图像保存为图像文件。

如果当前图像的类型为 fsdk.ImageE_TIF 、fsdk.ImageE_GIF 或 fsdk.ImageE_None ，且保存的图像文件类型不支持多帧， 则只有当前图像的第一帧会被保存到图像文件中。
如果保存的图像文件类型为 fsdk.ImageE_WEBP ，当前图像的位图格式 应为 fsdk.BitmapE_DIBRgb 、 或 。
对于图像对象（不是从任何图像文件构造的），请确保在使用此函数之前 至少向图像对象添加一个有效的帧位图； 否则此函数将失败。

参数

[in]	file	用户实现的 fsdk.StreamCallback 对象，用于保存图像文件。
[in]	file_extension	保存的图像文件的完整路径。不应为空字符串。 目前此函数支持以下扩展名： .bmp、.jpg、.jpeg、.png、.tif、.tiff、.jpx、.jp2。

返回

true 表示成功，false 表示失败。

注解

此函数不支持将当前图像对象保存回用于构造当前图像对象的图像文件。 为了实现这一点，建议用户按以下步骤操作：
假设当前图像对象是从名为"org.bmp"的图像文件构造的。

1. 使用当前函数将当前图像对象保存到临时文件。这里，此临时文件 命名为"temp.tmp"。

2. 确保当前图像对象已析构。

3. 删除"org.bmp"并将"temp.tmp"重命名为"org.bmp"。

SetDPIs()

def fsdk.Image.SetDPIs	(		x_dpi,
			y_dpi
	)

设置X轴和Y轴的DPI。

目前此函数不支持类型为 fsdk.ImageE_JPX 、 fsdk.ImageE_GIF 、fsdk.ImageE_JBIG2 或 fsdk.ImageE_WEBP 的图像。

参数

[in]	x_dpi	X轴的DPI。应大于0。
[in]	y_dpi	Y轴的DPI。应大于0。

返回

None。