|
Foxit PDF SDK
|
Public Member Functions | |
| def | CalculateBBoxByColor (backgroud_color) |
| Calculate the bounding box according to the given background color. More... | |
| def | Clone (clip_rect) |
| Clone current bitmap, with specified clip rectangle. More... | |
| def | ConvertFormat (format, icc_transform) |
| Convert a bitmap to another specified DIB format. More... | |
| def | ConvertToMono () |
| Converts bitmap to 1-bit monochrome format. More... | |
| def | DetectBBoxByColorDiffer (detection_size, color_differ) |
| Detect the bounding box of content according to the given color difference between content and margin. More... | |
| def | FillRect (color, rect) |
| Fill current bitmap with a specified color. More... | |
| def | Flip (is_flip_horz, is_flip_vert) |
| Flip bitmap. More... | |
| def | GetBpp () |
| Get bitmap bits-per-pixel. More... | |
| def | GetBuffer () |
| Get bitmap buffer. More... | |
| def | GetFormat () |
| Get bitmap format. More... | |
| def | GetHeight () |
| Get bitmap height. More... | |
| def | GetMask (clip_rect) |
| Get the mask if bitmap has mask. More... | |
| def | GetPitch () |
| Get bitmap pitch. More... | |
| def | GetWidth () |
| Get bitmap width. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | StretchTo (dest_width, dest_height, flag, clip_rect) |
| Stretch with different size. More... | |
| def | SwapXY (is_flip_horz, is_flip_vert, clip_rect) |
| Swap X,Y coordinations of the bitmap. After being swapped, the image can also be flipped at the same time. More... | |
| def | TransformTo (matrix, flag, out_left, out_top, clip_rect) |
| Transform current bitmap (as source bitmap) into destination one. More... | |
Bitmap is one of most important data structures in Foxit PDF SDK. It is commonly used for rendering. This class can construct a new bitmap object (not retrieved from other object) and offer methods to get information or operate the bitmap.
| def fsdk.Bitmap.CalculateBBoxByColor | ( | backgroud_color | ) |
Calculate the bounding box according to the given background color.
This function can support the following formats:
fsdk.BitmapE_DIB8bppMask , fsdk.BitmapE_DIB8bpp , fsdk.BitmapE_DIBRgb , fsdk.BitmapE_DIBRgb32 , fsdk.BitmapE_DIBArgb .
| [in] | backgroud_color | A valid background color. Format: 0xAARRGGBB. |
| def fsdk.Bitmap.Clone | ( | clip_rect | ) |
Clone current bitmap, with specified clip rectangle.
| [in] | clip_rect | The clipping region in current bitmap to specify the region to be cloned.
|
| def fsdk.Bitmap.ConvertFormat | ( | format, | |
| icc_transform | |||
| ) |
Convert a bitmap to another specified DIB format.
| [in] | format | New bitmap format type. It should be one of following values: fsdk.BitmapE_DIB8bppMask , fsdk.BitmapE_DIB8bpp , fsdk.BitmapE_DIBRgb , fsdk.BitmapE_DIBRgb32 , fsdk.BitmapE_DIBArgb . fsdk.BitmapE_DIBRgb565 . |
| [in] | icc_transform | The color mapping context for source format to destination format. It can be null, which means not use the color mapping. Default value: null. |
| def fsdk.Bitmap.ConvertToMono | ( | ) |
Converts bitmap to 1-bit monochrome format.
The resulting monochrome bitmap uses 1-bit pixel depth format.
| def fsdk.Bitmap.DetectBBoxByColorDiffer | ( | detection_size, | |
| color_differ | |||
| ) |
Detect the bounding box of content according to the given color difference between content and margin.
This function can support the following formats:
fsdk.BitmapE_DIB8bppMask , fsdk.BitmapE_DIB8bpp , fsdk.BitmapE_DIBRgb , fsdk.BitmapE_DIBRgb32 , fsdk.BitmapE_DIBArgb .
| [in] | detection_size | Detection size to analyze background. |
| [in] | color_differ | Color difference used to detect margin. The value should be between 0 and 255, and the suggested value is 64. Default value: 64. |
| def fsdk.Bitmap.FillRect | ( | color, | |
| rect | |||
| ) |
Fill current bitmap with a specified color.
This function can not support the following format:
fsdk.BitmapE_DIBCmyk .
| [in] | color | A color value which is used to fill bitmap. Format: 0xAARRGGBB |
| [in] | rect | A rectangle that represents a region in bitmap to specify where the color will be filled. This can be null, which means to fill the whole bitmap. Default value: null. |
| def fsdk.Bitmap.Flip | ( | is_flip_horz, | |
| is_flip_vert | |||
| ) |
Flip bitmap.
This function can support following formats:
fsdk.BitmapE_DIB8bppMask , fsdk.BitmapE_DIB8bpp , fsdk.BitmapE_DIBRgb , fsdk.BitmapE_DIBRgb32 , fsdk.BitmapE_DIBArgb .
| [in] | is_flip_horz | A boolean value to indicate whether to flip bitmap in horizontal direction: true means a bitmap will be flipped in horizontal direction, and false means not. |
| [in] | is_flip_vert | A boolean value to indicate whether to flip bitmap in vertical direction. true means a bitmap will be flipped in vertical direction, and false means not. |
| def fsdk.Bitmap.GetBpp | ( | ) |
Get bitmap bits-per-pixel.
| def fsdk.Bitmap.GetBuffer | ( | ) |
Get bitmap buffer.
Bitmap data are organized in scan-lines, from top to down.
| def fsdk.Bitmap.GetFormat | ( | ) |
Get bitmap format.
| def fsdk.Bitmap.GetHeight | ( | ) |
Get bitmap height.
| def fsdk.Bitmap.GetMask | ( | clip_rect | ) |
Get the mask if bitmap has mask.
| [in] | clip_rect | The clipping region of current bitmap (as source bitmap). It can be null. Default value: null. |
| def fsdk.Bitmap.GetPitch | ( | ) |
Get bitmap pitch.
| def fsdk.Bitmap.GetWidth | ( | ) |
Get bitmap width.
| def fsdk.Bitmap.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.Bitmap.StretchTo | ( | dest_width, | |
| dest_height, | |||
| flag, | |||
| clip_rect | |||
| ) |
Stretch with different size.
If parameter dest_width or parameter dest_height is negative, the bitmap will be flipped. If the stretching is to be done in down-sample mode, that would be much faster than not to be done in down-sample mode, especially when stretching big bitmaps into small ones. Optionally a clipping region in result bitmap coordinate can be specified to limit the size of result bitmap. This function can not support the following format:
fsdk.BitmapE_DIBCmyk .
| [in] | dest_width | The width of the destination bitmap. |
| [in] | dest_height | The height of the destination bitmap. |
| [in] | flag | Stretch flag, It should be value fsdk.BitmapE_Downsample or fsdk.BitmapE_Quadratic . |
| [in] | clip_rect | The clipping region of destination bitmap. It can be null. Default value: null. |
| def fsdk.Bitmap.SwapXY | ( | is_flip_horz, | |
| is_flip_vert, | |||
| clip_rect | |||
| ) |
Swap X,Y coordinations of the bitmap. After being swapped, the image can also be flipped at the same time.
This function can support following formats:
fsdk.BitmapE_DIB8bppMask , fsdk.BitmapE_DIB8bpp , fsdk.BitmapE_DIBRgb , fsdk.BitmapE_DIBRgb32 , fsdk.BitmapE_DIBArgb . Optionally a clipping region (in destination bitmap coordinate) can be specified to limit the size of result.
Suppose the original image has the following 4 pixels:
+---+---+
| 1 | 2 |
+---+---+
| 3 | 4 |
+---+---+
Then, depends on parameter is_flip_horz and is_flip_vert, the result would look like: if parameter is_flip_horz = false, parameter is_flip_vert = false:
+---+---+
| 1 | 3 |
+---+---+
| 2 | 4 |
+---+---+
if parameter is_flip_horz = true, parameter is_flip_vert = false:
+---+---+
| 3 | 1 |
+---+---+
| 4 | 2 |
+---+---+
if parameter is_flip_horz = false, parameter is_flip_vert = true:
+---+---+
| 2 | 4 |
+---+---+
| 1 | 3 |
+---+---+
if parameter is_flip_horz = true, parameter is_flip_vert = true:
+---+---+
| 4 | 2 |
+---+---+
| 3 | 1 |
+---+---+
| [in] | is_flip_horz | A boolean value to indicate whether to flip bitmap in horizontal direction: true means the bitmap will be flipped in horizontal direction, and false means not. |
| [in] | is_flip_vert | A boolean value to indicate whether to flip bitmap in vertical direction: true means the bitmap will be flipped in vertical direction, and false means not. |
| [in] | clip_rect | The clipping region of destination bitmap. This can be null, which means the whole bitmap. Default value: null. |
| def fsdk.Bitmap.TransformTo | ( | matrix, | |
| flag, | |||
| out_left, | |||
| out_top, | |||
| clip_rect | |||
| ) |
Transform current bitmap (as source bitmap) into destination one.
The dimension of returned bitmap always match the dimension of the matrix. If the transformation is to be done in down- sample mode, that would be much faster than not to be done in down-sample mode, especially when transforming big images into small ones. Optionally a clipping region in result bitmap coordinate can be specified to limit the size of result bitmap. The position of left-top corner (in destination coordinate) of the result bitmap would be returned as well. This function can not support the following format:
fsdk.BitmapE_DIBCmyk .
| [in] | matrix | The transformation matrix. |
| [in] | flag | Transform flag. It should be value fsdk.BitmapE_Downsample or fsdk.BitmapE_Quadratic . |
| [out] | out_left | Output parameter that receives x-coordinate of the left-top corner of the result bitmap in destination coordinate. |
| [out] | out_top | Output parameter that receives y-coordinate of the left-top corner of the result bitmap in destination coordinate. |
| [in] | clip_rect | The clipping region of destination bitmap. It can be null. Default value: null. |