Public 成员函数
def	CalculateBBoxByColor (backgroud_color)
	根据给定的背景色计算边界框。更多...

def	Clone (clip_rect)
	克隆当前位图，使用指定的裁剪矩形。更多...

def	ConvertFormat (format, icc_transform)
	将位图转换为另一种指定的DIB格式。更多...

def	ConvertToMono ()
	将位图转换为1位单色格式。更多...

def	DetectBBoxByColorDiffer (detection_size, color_differ)
	根据内容与边距之间的给定颜色差异检测内容的边界框。更多...

def	FillRect (color, rect)
	用指定颜色填充当前位图。更多...

def	Flip (is_flip_horz, is_flip_vert)
	翻转位图。更多...

def	GetBpp ()
	获取位图每像素位数。更多...

def	GetBuffer ()
	获取位图缓冲区。更多...

def	GetFormat ()
	获取位图格式。更多...

def	GetHeight ()
	获取位图高度。更多...

def	GetMask (clip_rect)
	如果位图有遮罩则获取该遮罩。更多...

def	GetPitch ()
	获取位图间距。更多...

def	GetWidth ()
	获取位图宽度。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	StretchTo (dest_width, dest_height, flag, clip_rect)
	按不同大小拉伸。更多...

def	SwapXY (is_flip_horz, is_flip_vert, clip_rect)
	交换位图的X、Y坐标。交换后，图像还可以同时翻转。更多...

def	TransformTo (matrix, flag, out_left, out_top, clip_rect)
	将当前位图（作为源位图）转换到目标位图。更多...

详细描述

位图是Foxit PDF SDK中最重要的数据结构之一。它通常用于渲染。此类可以构造一个新的位图对象（非从其他对象检索）并提供方法来获取信息或操作位图。

成员函数说明

◆ CalculateBBoxByColor()

def fsdk.Bitmap.CalculateBBoxByColor ( backgroud_color )

根据给定的背景色计算边界框。

此函数支持以下格式：
fsdk.BitmapE_DIB8bppMask 、fsdk.BitmapE_DIB8bpp 、 fsdk.BitmapE_DIBRgb 、fsdk.BitmapE_DIBRgb32 、 fsdk.BitmapE_DIBArgb 。

参数

[in] backgroud_color 有效的背景色。格式：0xAARRGGBB。

返回: 内容边界框的矩形。

◆ Clone()

def fsdk.Bitmap.Clone ( clip_rect )

克隆当前位图，使用指定的裁剪矩形。

参数

[in]

clip_rect

当前位图中的裁剪区域，用于指定要克隆的区域。

对于位图格式 fsdk.BitmapE_DIBRgb565 ，目前只支持克隆整个位图，所以此参数应始终为 null。
对于其他格式，此参数可以是 null 或有效值。如果是 null，表示克隆整个位图。如果不是 null，它指定要克隆的位图中的裁剪区域，克隆的位图将具有与裁剪区域相同的大小。

默认值：null。

返回: 作为克隆结果的新位图。

◆ ConvertFormat()

def fsdk.Bitmap.ConvertFormat	(	format,
		icc_transform
	)

将位图转换为另一种指定的DIB格式。

参数

[in]	format	新的位图格式类型。应为以下值之一： fsdk.BitmapE_DIB8bppMask 、fsdk.BitmapE_DIB8bpp 、 fsdk.BitmapE_DIBRgb 、fsdk.BitmapE_DIBRgb32 、 fsdk.BitmapE_DIBArgb 、fsdk.BitmapE_DIBRgb565 。
[in]	icc_transform	从源格式到目标格式的颜色映射上下文。可以是 null，表示不使用颜色映射。默认值：null。

返回: 转换后的位图。

◆ ConvertToMono()

def fsdk.Bitmap.ConvertToMono ( )

将位图转换为1位单色格式。

生成的单色位图使用1位像素深度格式。

返回: 作为单色结果的新位图。

注解: 保存为jpeg时无法保留1位单色格式。

◆ DetectBBoxByColorDiffer()

def fsdk.Bitmap.DetectBBoxByColorDiffer	(	detection_size,
		color_differ
	)

根据内容与边距之间的给定颜色差异检测内容的边界框。

此函数支持以下格式：
fsdk.BitmapE_DIB8bppMask 、fsdk.BitmapE_DIB8bpp 、 fsdk.BitmapE_DIBRgb 、fsdk.BitmapE_DIBRgb32 、 fsdk.BitmapE_DIBArgb 。

参数

[in]	detection_size	用于分析背景的检测大小。
[in]	color_differ	用于检测边距的颜色差异。值应在0到255之间，建议值为64。默认值：64。

返回: 内容边界框的矩形。

◆ FillRect()

def fsdk.Bitmap.FillRect	(	color,
		rect
	)

用指定颜色填充当前位图。

对于 fsdk.BitmapE_DIBCmyk 格式的位图，用户可以填充CMYK颜色值，参数 rect 一定要传 null。

参数

[in]	color	用于填充位图的颜色值。格式：0xAARRGGBB
[in]	rect	表示位图中区域的矩形，用于指定颜色填充位置。可以是 null，表示填充整个位图。默认值：null。

返回: 无。

◆ Flip()

def fsdk.Bitmap.Flip	(	is_flip_horz,
		is_flip_vert
	)

翻转位图。

此函数支持以下格式：
fsdk.BitmapE_DIB8bppMask 、fsdk.BitmapE_DIB8bpp 、 fsdk.BitmapE_DIBRgb 、fsdk.BitmapE_DIBRgb32 、 fsdk.BitmapE_DIBArgb 。

参数

[in]	is_flip_horz	布尔值，指示是否在水平方向翻转位图： true 表示位图将在水平方向翻转， false 表示不翻转。
[in]	is_flip_vert	布尔值，指示是否在垂直方向翻转位图： true 表示位图将在垂直方向翻转， false 表示不翻转。

返回: 翻转后的新位图。

◆ GetBpp()

def fsdk.Bitmap.GetBpp ( )

获取位图每像素位数。

返回: 位图每像素位数值。

◆ GetBuffer()

def fsdk.Bitmap.GetBuffer ( )

获取位图缓冲区。

位图数据以扫描行组织，从上到下。

返回: 位图缓冲区。

◆ GetFormat()

def fsdk.Bitmap.GetFormat ( )

获取位图格式。

返回: 格式值。请参考从 fsdk.BitmapE_DIBInvalid 开始的值，返回值将是这些值之一。

◆ GetHeight()

def fsdk.Bitmap.GetHeight ( )

获取位图高度。

返回: 位图高度。

◆ GetMask()

def fsdk.Bitmap.GetMask ( clip_rect )

如果位图有遮罩则获取该遮罩。

参数

[in] clip_rect 当前位图（作为源位图）的裁剪区域。可以为 null。默认值：null。

返回: 作为遮罩位图的新位图。如果返回的位图对象的函数 fsdk.Bitmap.IsEmpty 返回值为 true，则表示当前位图没有遮罩。

◆ GetPitch()

def fsdk.Bitmap.GetPitch ( )

获取位图间距。

返回: 位图间距。

◆ GetWidth()

def fsdk.Bitmap.GetWidth ( )

获取位图宽度。

返回: 位图宽度。

◆ IsEmpty()

def fsdk.Bitmap.IsEmpty ( )

检查当前对象是否为空。

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

返回: true 表示当前对象为空，false 表示非空。

◆ StretchTo()

def fsdk.Bitmap.StretchTo	(	dest_width,
		dest_height,
		flag,
		clip_rect
	)

按不同大小拉伸。

如果参数 dest_width 或参数 dest_height 为负值，位图将被翻转。如果拉伸在下采样模式下进行，速度会比非下采样模式快得多，特别是将大位图拉伸为小位图时。可选地，可以指定结果位图坐标中的裁剪区域来限制结果位图的大小。此函数不支持以下格式：
fsdk.BitmapE_DIBCmyk 。

参数

[in]	dest_width	目标位图的宽度。
[in]	dest_height	目标位图的高度。
[in]	flag	拉伸标志，应为 fsdk.BitmapE_Downsample 或 fsdk.BitmapE_Quadratic 值。
[in]	clip_rect	目标位图的裁剪区域。可以为 null。默认值：null。

返回: 拉伸后的新位图。

◆ SwapXY()

def fsdk.Bitmap.SwapXY	(	is_flip_horz,
		is_flip_vert,
		clip_rect
	)

交换位图的X、Y坐标。交换后，图像还可以同时翻转。

此函数支持以下格式：
fsdk.BitmapE_DIB8bppMask 、fsdk.BitmapE_DIB8bpp 、 fsdk.BitmapE_DIBRgb 、fsdk.BitmapE_DIBRgb32 、 fsdk.BitmapE_DIBArgb 。可选地，可以指定一个裁剪区域（在目标位图坐标系中）来限制结果的大小。
假设原始图像有以下4个像素：

         +---+---+
         | 1 | 2 |
         +---+---+
         | 3 | 4 |
         +---+---+

那么，根据参数 is_flip_horz 和 is_flip_vert，结果如下：如果参数 is_flip_horz = false，参数 is_flip_vert = false：

         +---+---+
         | 1 | 3 |
         +---+---+
         | 2 | 4 |
         +---+---+

如果参数 is_flip_horz = true，参数 is_flip_vert = false：

         +---+---+
         | 3 | 1 |
         +---+---+
         | 4 | 2 |
         +---+---+

如果参数 is_flip_horz = false，参数 is_flip_vert = true：

         +---+---+
         | 2 | 4 |
         +---+---+
         | 1 | 3 |
         +---+---+

如果参数 is_flip_horz = true，参数 is_flip_vert = true：

         +---+---+
         | 4 | 2 |
         +---+---+
         | 3 | 1 |
         +---+---+

参数

[in]	is_flip_horz	布尔值，指示是否在水平方向翻转位图： true 表示位图将在水平方向翻转， false 表示不翻转。
[in]	is_flip_vert	布尔值，指示是否在垂直方向翻转位图： true 表示位图将在垂直方向翻转， false 表示不翻转。
[in]	clip_rect	目标位图的裁剪区域。可以为 null，表示整个位图。默认值：null。

返回: 交换后的新位图。

◆ TransformTo()

def fsdk.Bitmap.TransformTo	(	matrix,
		flag,
		out_left,
		out_top,
		clip_rect
	)

将当前位图（作为源位图）转换到目标位图。

返回的位图尺寸始终与矩阵的尺寸匹配。如果转换在下采样模式下进行，速度会比非下采样模式快得多，特别是将大图像转换为小图像时。可选地，可以指定结果位图坐标中的裁剪区域来限制结果位图的大小。结果位图左上角的位置（在目标坐标系中）也会一并返回。此函数不支持以下格式：
fsdk.BitmapE_DIBCmyk 。

参数

[in]	matrix	变换矩阵。
[in]	flag	变换标志。应为 fsdk.BitmapE_Downsample 或 fsdk.BitmapE_Quadratic 值。
[out]	out_left	输出参数，接收结果位图左上角在目标坐标系中的x坐标。
[out]	out_top	输出参数，接收结果位图左上角在目标坐标系中的y坐标。
[in]	clip_rect	目标位图的裁剪区域。可以为 null。默认值：null。

返回: 转换后的新位图。

Public 成员函数

详细描述

成员函数说明

◆ CalculateBBoxByColor()

◆ Clone()

◆ ConvertFormat()

◆ ConvertToMono()

◆ DetectBBoxByColorDiffer()

◆ FillRect()

◆ Flip()

◆ GetBpp()

◆ GetBuffer()

◆ GetFormat()

◆ GetHeight()

◆ GetMask()

◆ GetPitch()

◆ GetWidth()

◆ IsEmpty()

◆ StretchTo()

◆ SwapXY()

◆ TransformTo()