Foxit PDF SDK

构造函数 | 所有成员列表
FSBitmap类 参考
类 FSBitmap 继承关系图:

## 构造函数
(FSRectI *) | - calculateBBoxByColor:
| 根据给定的背景色计算边界框。 更多...
(FSBitmap *) | - clone:
| 克隆当前位图，使用指定的裁剪矩形。 更多...
(FSBitmap *) | - convertFormat:icc_transform:
| 将位图转换为另一种指定的DIB格式。 更多...
(FSBitmap *) | - convertToMono
| 将位图转换为1位单色格式。 更多...
(FSRectI *) | - detectBBoxByColorDiffer:color_differ:
| 根据内容与边距之间的给定颜色差异检测内容的边界框。 更多...
(void) | - fillRect:rect:
| 用指定颜色填充当前位图。 更多...
(FSBitmap *) | - flip:is_flip_vert:
| 翻转位图。 更多...
(int) | - getBpp
| 获取位图每像素位数。 更多...
(NSData *) | - getBuffer
| 获取位图缓冲区。 更多...
(FSBitmapDIBFormat) | - getFormat
| 获取位图格式。 更多...
(int) | - getHeight
| 获取位图高度。 更多...
(FSBitmap *) | - getMask:
| 如果位图有遮罩则获取该遮罩。 更多...
(int) | - getPitch
| 获取位图间距。 更多...
(int) | - getWidth
| 获取位图宽度。 更多...
(id) | - init
| 构造函数，作为空位图对象。
(id) | - initWithOther:
| 使用另一个位图对象的构造函数。 更多...
(id) | - initWithWidth:height:format:buffer:pitch:
| 带参数的构造函数。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(FSBitmap *) | - stretchTo:dest_height:flag:clip_rect:
| 按不同大小拉伸。 更多...
(FSBitmap *) | - swapXY:is_flip_vert:clip_rect:
| 交换位图的X、Y坐标。交换后，图像还可以同时翻转。 更多...
(FSBitmap *) | - transformTo:flag:out_left:out_top:clip_rect:
| 将当前位图（作为源位图）转换到目标位图。 更多...

## 详细描述

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

## 函数文档

## ◆ calculateBBoxByColor:()

- (FSRectI *) calculateBBoxByColor: |  | (unsigned int) | backgroud_color |

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

此函数支持以下格式：
FSBitmapDIB8bppMask、FSBitmapDIB8bpp、 FSBitmapDIBRgb、FSBitmapDIBRgb32、 FSBitmapDIBArgb。

参数

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

返回
  内容边界框的矩形。

## ◆ clone:()

- (FSBitmap *) clone: |  | (FSRectI*) | clip_rect |

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

参数

  [in] | clip_rect | 当前位图中的裁剪区域，用于指定要克隆的区域。 对于位图格式 FSBitmapDIBRgb565， 目前只支持克隆整个位图，所以此参数应始终为 nil。 对于其他格式，此参数可以是 nil 或有效值。如果是 nil， 表示克隆整个位图。如果不是 nil，它指定 要克隆的位图中的裁剪区域，克隆的位图将 具有与裁剪区域相同的大小。 默认值：nil。

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

## ◆ convertFormat:icc_transform:()

- (FSBitmap *) convertFormat: |  | (FSBitmapDIBFormat) | format
icc_transform: |  | (NSData *) | icc_transform

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

参数

  [in] | format | 新的位图格式类型。应为以下值之一： FSBitmapDIB8bppMask、FSBitmapDIB8bpp、 FSBitmapDIBRgb、FSBitmapDIBRgb32、 FSBitmapDIBArgb、FSBitmapDIBRgb565。
  [in] | icc_transform | 从源格式到目标格式的颜色映射上下文。 可以是 nil，表示不使用颜色映射。 默认值：nil。

返回
  转换后的位图。

## ◆ convertToMono()

- (FSBitmap *) convertToMono |  |  |

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

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

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

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

## ◆ detectBBoxByColorDiffer:color_differ:()

- (FSRectI *) detectBBoxByColorDiffer: |  | (int) | detection_size
color_differ: |  | (int) | color_differ

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

此函数支持以下格式：
FSBitmapDIB8bppMask、FSBitmapDIB8bpp、 FSBitmapDIBRgb、FSBitmapDIBRgb32、 FSBitmapDIBArgb。

参数

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

返回
  内容边界框的矩形。

## ◆ fillRect:rect:()

- (void) fillRect: |  | (unsigned int) | color
rect: |  | (FSRectI*) | rect

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

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

参数

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

返回
  无。

## ◆ flip:is_flip_vert:()

- (FSBitmap *) flip: |  | (BOOL) | is_flip_horz
is_flip_vert: |  | (BOOL) | is_flip_vert

翻转位图。

此函数支持以下格式：
FSBitmapDIB8bppMask、FSBitmapDIB8bpp、 FSBitmapDIBRgb、FSBitmapDIBRgb32、 FSBitmapDIBArgb。

参数

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

返回
  翻转后的新位图。

## ◆ getBpp()

- (int) getBpp |  |  |

获取位图每像素位数。

返回
  位图每像素位数值。

## ◆ getBuffer()

- (NSData *) getBuffer |  |  |

获取位图缓冲区。

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

返回
  位图缓冲区。

## ◆ getFormat()

- (FSBitmapDIBFormat) getFormat |  |  |

获取位图格式。

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

## ◆ getHeight()

- (int) getHeight |  |  |

获取位图高度。

返回
  位图高度。

## ◆ getMask:()

- (FSBitmap *) getMask: |  | (FSRectI*) | clip_rect |

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

参数

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

返回
  作为遮罩位图的新位图。如果返回的位图对象的函数 FSBitmap::isEmpty 返回值为 YES，则表示当前位图没有遮罩。

## ◆ getPitch()

- (int) getPitch |  |  |

获取位图间距。

返回
  位图间距。

## ◆ getWidth()

- (int) getWidth |  |  |

获取位图宽度。

返回
  位图宽度。

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSBitmap*) | other |

使用另一个位图对象的构造函数。

参数

  [in] | other | 另一个位图对象。

## ◆ initWithWidth:height:format:buffer:pitch:()

- (id) initWithWidth: |  | (int) | width
height: |  | (int) | height
format: |  | (FSBitmapDIBFormat) | format
buffer: |  | (NSData *) | buffer
pitch: |  | (int) | pitch

带参数的构造函数。

如果参数 buffer 不是 nil，它应该由应用程序初始化； 如果参数 buffer 是 nil，Foxit PDF SDK将在内部分配并 初始化像素缓冲区。
建议应用程序使用与Foxit PDF SDK内部使用的相同颜色来 初始化位图的像素缓冲区：

- 对于没有Alpha通道的位图，用0xFFFFFFFF初始化像素缓冲区。
- 对于有Alpha通道的位图，用0x00000000初始化像素缓冲区。

此外，加载图像有大小限制。图像大小应满足条件： width * height * (bits per pixel / 8) < 0x40000000（表示1 GB）。 图像大小是指图像的实际数据大小，而不是图像文件的大小。

参数

  [in] | width | 位图宽度，以像素为单位。应大于0。
  [in] | height | 位图高度，以像素为单位。应大于0。
  [in] | format | 位图格式类型。请参考从 FSBitmapDIBRgb 开始的值， 应为这些值之一，除了 FSBitmapDIBInvalid。
  [in] | buffer | 指定位图数据的缓冲区。 如果不是 nil，此函数将使用参数 buffer 来初始化位图。在这种情况下，请不要在参数 bitmap 的生命周期结束之前释放参数 buffer。 如果是 nil，将在内部创建新的位图缓冲区。 默认值：nil。
  [in] | pitch | 每个扫描行的字节数。仅当参数 buffer 不是 nil 时有用。如果此值为0，则假定4字节对齐。默认值：0。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

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

## ◆ stretchTo:dest_height:flag:clip_rect:()

- (FSBitmap *) stretchTo: |  | (int) | dest_width
dest_height: |  | (int) | dest_height
flag: |  | (FSBitmapInterpolationFlag) | flag
clip_rect: |  | (FSRectI*) | clip_rect

按不同大小拉伸。

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

参数

  [in] | dest_width | 目标位图的宽度。
  [in] | dest_height | 目标位图的高度。
  [in] | flag | 拉伸标志，应为 FSBitmapDownsample 或 FSBitmapQuadratic 值。
  [in] | clip_rect | 目标位图的裁剪区域。可以为 nil。 默认值：nil。

返回
  拉伸后的新位图。

## ◆ swapXY:is_flip_vert:clip_rect:()

- (FSBitmap *) swapXY: |  | (BOOL) | is_flip_horz
is_flip_vert: |  | (BOOL) | is_flip_vert
clip_rect: |  | (FSRectI*) | clip_rect

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

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

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

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

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

如果参数 is_flip_horz = YES，参数 is_flip_vert = NO：

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

如果参数 is_flip_horz = NO，参数 is_flip_vert = YES：

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

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

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

参数

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

返回
  交换后的新位图。

## ◆ transformTo:flag:out_left:out_top:clip_rect:()

- (FSBitmap *) transformTo: |  | (FSMatrix2D*) | matrix
flag: |  | (FSBitmapInterpolationFlag) | flag
out_left: |  | (int *) | out_left
out_top: |  | (int *) | out_top
clip_rect: |  | (FSRectI*) | clip_rect

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

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

参数

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

返回
  转换后的新位图。