类 FSImage 继承关系图:

构造函数
(BOOL)	- addFrame:
	添加位图作为帧。（不支持的DIB格式： FSBitmapDIBRgb565 和 FSBitmapDIB8bppMask ）更多...

(FSBitmap *)	- getFrameBitmap:
	根据索引获取帧位图。更多...

(int)	- getFrameCount
	获取帧数。更多...

(int)	- getHeight
	获取图像高度。更多...

(FSImageOrientation)	- getOrientation
	获取图像方向。更多...

(FSImageType)	- getType
	获取图像类型。更多...

(int)	- getWidth
	获取图像宽度。更多...

(int)	- getXDPI
	获取X轴的DPI。更多...

(int)	- getYDPI
	获取Y轴的DPI。更多...

(id)	- init
	构造函数。更多...

(id)	- initWithBuffer:
	构造函数，从内存缓冲区。更多...

(id)	- initWithFile_read:
	构造函数，使用文件读取回调对象。更多...

(id)	- initWithOther:
	构造函数，使用另一个图像对象。更多...

(id)	- initWithPath:
	构造函数，从现有图像文件路径。更多...

(BOOL)	- isEmpty
	检查当前对象是否为空。更多...

(BOOL)	- saveAs:
	将当前图像保存为图像文件。更多...

(BOOL)	- saveAsWithStreamCallback:file_extension:
	将当前图像保存为图像文件。更多...

(void)	- setDPIs: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:()

- (BOOL) addFrame: (FSBitmap*) bitmap

添加位图作为帧。（不支持的DIB格式： FSBitmapDIBRgb565 和 FSBitmapDIB8bppMask ）

目前此函数不支持类型为 FSImageJBIG2 或 FSImageUnknown 的图像。
对于支持的图像类型：

如果当前图像的类型为 FSImageTIF 、 FSImageGIF 或 FSImageNone ，此函数将添加新位图作为新的最后一帧。
如果当前图像的类型为其他类型之一，只包含单帧，此函数将使用新位图替换第一帧。

参数

[in] bitmap 要添加或设置的有效位图帧。

返回: YES 表示成功，NO 表示失败。

◆ getFrameBitmap:()

- (FSBitmap *) getFrameBitmap: (int) index

根据索引获取帧位图。

目前此函数不支持类型为 FSImageJBIG2 的图像。此函数只能支持获取以下格式的帧位图：
FSBitmapDIB8bppMask 、 FSBitmapDIB8bpp 、 FSBitmapDIBRgb 、 FSBitmapDIBRgb32 、 FSBitmapDIBArgb 。
对于其他不支持的DIB格式，此函数将返回一个位图对象，其函数 FSBitmap::isEmpty 返回 YES。

参数

[in] index 帧的索引。有效范围：从0到（count-1）。 count 由函数 FSImage::getFrameCount 返回。

返回: 帧位图。如果返回的位图对象的函数 FSBitmap::isEmpty 返回值为 YES，则表示该帧的DIB格式不受支持。

◆ getFrameCount()

- (int) getFrameCount

获取帧数。

目前此函数不支持类型为 FSImageJBIG2 的图像。

返回: 帧数。

◆ getHeight()

- (int) getHeight

获取图像高度。

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

返回: 图像高度。

◆ getOrientation()

- (FSImageOrientation) getOrientation

获取图像方向。

此函数只支持类型为 FSImageJPG 和 FSImageTIF 的图像。

返回: 图像方向。请参考从 FSImageOrientationNone 开始的值，这将是其中的一个值。

◆ getType()

- (FSImageType) getType

获取图像类型。

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

返回: 图像类型。请参考从 FSImageUnknown 开始的值，这将是其中的一个值。

◆ getWidth()

- (int) getWidth

获取图像宽度。

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

返回: 图像宽度。

◆ getXDPI()

- (int) getXDPI

获取X轴的DPI。

目前此函数不支持类型为 FSImageJPX 、 FSImageGIF 、 FSImageJBIG2 或 FSImageWEBP 的图像。
对于新图像（不是从任何图像文件构造的），X轴的默认DPI为96。

返回: X轴的DPI值。

◆ getYDPI()

- (int) getYDPI

获取Y轴的DPI。

目前此函数不支持类型为 FSImageJPX 、 FSImageGIF 、 FSImageJBIG2 或 FSImageWEBP 的图像。
对于新图像（不是从任何图像文件构造的），Y轴的默认DPI为96。

返回: Y轴的DPI值。

◆ init()

- (id) init

构造函数。

此构造函数用于构造一个新的图像对象（不包含任何数据）。此构造的图像对象的图像类型为 FSImageNone 。

◆ initWithBuffer:()

- (id) initWithBuffer: (NSData *) buffer

构造函数，从内存缓冲区。

参数

[in] buffer 内存缓冲区。图像文件数据应完全加载到此内存缓冲区中。不应为 nil。

◆ initWithFile_read:()

- (id) initWithFile_read: (id<FSFileReaderCallback>) file_read

构造函数，使用文件读取回调对象。

参数

[in] file_read 用户实现的 FSFileReaderCallback 对象，用于加载图像文件。不应为 nil。

◆ initWithOther:()

- (id) initWithOther: (FSImage*) other

构造函数，使用另一个图像对象。

参数

[in] other 另一个图像对象。

◆ initWithPath:()

- (id) initWithPath: (NSString *) path

构造函数，从现有图像文件路径。

参数

[in] path 现有图像文件的完整路径。不应为空字符串。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

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

返回: YES 表示当前对象为空，NO 表示不为空。

◆ saveAs:()

- (BOOL) saveAs: (NSString *) file_path

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

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

参数

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

返回: YES 表示成功，NO 表示失败。

注解

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

使用当前函数将当前图像对象保存到临时文件。这里，此临时文件命名为"temp.tmp"。
确保当前图像对象已析构。
删除"org.bmp"并将"temp.tmp"重命名为"org.bmp"。

◆ saveAsWithStreamCallback:file_extension:()

- (BOOL) saveAsWithStreamCallback:	(id<FSFileStreamCallback>)	file
file_extension:	(NSString *)	file_extension

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

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

参数

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

返回: YES 表示成功，NO 表示失败。

注解

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

使用当前函数将当前图像对象保存到临时文件。这里，此临时文件命名为"temp.tmp"。
确保当前图像对象已析构。
删除"org.bmp"并将"temp.tmp"重命名为"org.bmp"。

◆ setDPIs:y_dpi:()

- (void) setDPIs:	(int)	x_dpi
y_dpi:	(int)	y_dpi

设置X轴和Y轴的DPI。

目前此函数不支持类型为 FSImageJPX 、 FSImageGIF 、 FSImageJBIG2 或 FSImageWEBP 的图像。

参数

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

返回: None。