Foxit PDF SDK
|
Public Types | |
enum | DIBFormat { DIBFormat.e_DIBInvalid = 0, DIBFormat.e_DIB1bpp = 0x001, DIBFormat.e_DIBRgb = 0x018, DIBFormat.e_DIBRgb32 = 0x020, DIBFormat.e_DIBArgb = 0x220, DIBFormat.e_DIBCmyk = 0x420, DIBFormat.e_DIB8bppMask = 0x108, DIBFormat.e_DIB8bpp = 0x008, DIBFormat.e_DIB8bppGray = 0x1008, DIBFormat.e_DIBAbgr = 0x222, DIBFormat.e_DIBRgb565 = 0x565 } |
Enumeration for DIB format. More... | |
enum | InterpolationFlag { InterpolationFlag.e_Downsample = 0x01, InterpolationFlag.e_Quadratic = 0x02, InterpolationFlag.e_Bicubic = 0x04 } |
Enumeration for bitmap interpolation flags. More... | |
Public Member Functions | |
Bitmap (int width, int height, Bitmap.DIBFormat format) | |
Constructor, with parameters. More... | |
Bitmap (int width, int height, Bitmap.DIBFormat format, System.IntPtr buffer, int pitch) | |
Constructor, with parameters. More... | |
Bitmap (Bitmap other) | |
Constructor, with another bitmap object. More... | |
Bitmap () | |
Constructor, as an empty bitmap object. | |
RectI | CalculateBBoxByColor (uint backgroud_color) |
Calculate the bounding box according to the given background color. More... | |
Bitmap | Clone (RectI clip_rect) |
Clone current bitmap, with specified clip rectangle. More... | |
Bitmap | ConvertFormat (Bitmap.DIBFormat format, global::System.IntPtr icc_transform) |
Convert a bitmap to another specified DIB format. More... | |
RectI | DetectBBoxByColorDiffer (int detection_size, int color_differ) |
Detect the bounding box of content according to the given color difference between content and margin. More... | |
void | FillRect (uint color, RectI rect) |
Fill current bitmap with a specified color. More... | |
Bitmap | Flip (bool is_flip_horz, bool is_flip_vert) |
Flip bitmap. More... | |
int | GetBpp () |
Get bitmap bits-per-pixel. More... | |
System.IntPtr | GetBuffer () |
Get bitmap buffer. More... | |
Bitmap.DIBFormat | GetFormat () |
Get bitmap format. More... | |
int | GetHeight () |
Get bitmap height. More... | |
Bitmap | GetMask (RectI clip_rect) |
Get the mask if bitmap has mask. More... | |
int | GetPitch () |
Get bitmap pitch. More... | |
int | GetWidth () |
Get bitmap width. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
Bitmap | StretchTo (int dest_width, int dest_height, Bitmap.InterpolationFlag flag, RectI clip_rect) |
Stretch with different size. More... | |
Bitmap | SwapXY (bool is_flip_horz, bool is_flip_vert, RectI clip_rect) |
Swap X,Y coordinations of the bitmap. After being swapped, the image can also be flipped at the same time. More... | |
Bitmap | TransformTo (Matrix2D matrix, Bitmap.InterpolationFlag flag, ref int out_left, ref int out_top, RectI 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.
|
strong |
Enumeration for DIB format.
Values of this enumeration should be used alone.
|
strong |
Enumeration for bitmap interpolation flags.
Values of this enumeration can be used alone or in combination.
|
inline |
Constructor, with parameters.
[in] | width | Width of bitmap, in pixels. This should be above 0. |
[in] | height | Height of bitmap, in pixels. This should be above 0. |
[in] | format | Bitmap format type. Please refer to values starting from foxit.common.Bitmap.DIBFormat.e_DIBRgb and this should be one of these values except foxit.common.Bitmap.DIBFormat.e_DIBInvalid . |
|
inline |
Constructor, with parameters.
If parameter buffer is not null, it should be initialized by application; if parameter buffer is null, Foxit PDF SDK will allocate and initialize the pixels buffer internally.
Application is suggested to use the same colors as Foxit PDF SDK uses internally to initialize bitmap's pixel buffer:
For the bitmap without alpha channel, initialize the pixels buffer with 0xFFFFFFFF.
For the bitmap with alpha channel, initialize the pixels buffer with 0x00000000.
Additionally, there is a size limit for loading images. The image size should meet the condition: width * height * (bits per pixel / 8) < 0x40000000 (indicating 1 GB). Image size refers to the actual data size of the image and not the size of the image file.
[in] | width | Width of bitmap, in pixels. This should be above 0. |
[in] | height | Height of bitmap, in pixels. This should be above 0. |
[in] | format | Bitmap format type. Please refer to values starting from foxit.common.Bitmap.DIBFormat.e_DIBRgb and this should be one of these values except foxit.common.Bitmap.DIBFormat.e_DIBInvalid . |
[in] | buffer | A buffer that specifies bitmap data. If it is not null, this function will use the parameter buffer to initialize a bitmap. In this case, please do not free the parameter buffer before the life-cycle of parameter bitmap ends. If it is null, a new bitmap buffer will be created internally. |
[in] | pitch | The number of bytes for each scan line. This is useful only when parameter buffer is not null. If this value is 0, 4-byte alignment is assumed. |
|
inline |
Constructor, with another bitmap object.
[in] | other | Another bitmap object. |
|
inline |
Calculate the bounding box according to the given background color.
This function can support the following formats:
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask , foxit.common.Bitmap.DIBFormat.e_DIB8bpp , foxit.common.Bitmap.DIBFormat.e_DIBRgb , foxit.common.Bitmap.DIBFormat.e_DIBRgb32 , foxit.common.Bitmap.DIBFormat.e_DIBArgb .
[in] | backgroud_color | A valid background color. Format: 0xAARRGGBB. |
Clone current bitmap, with specified clip rectangle.
[in] | clip_rect | The clipping region in current bitmap to specify the region to be cloned.
|
|
inline |
Convert a bitmap to another specified DIB format.
[in] | format | New bitmap format type. It should be one of following values: foxit.common.Bitmap.DIBFormat.e_DIB8bppMask , foxit.common.Bitmap.DIBFormat.e_DIB8bpp , foxit.common.Bitmap.DIBFormat.e_DIBRgb , foxit.common.Bitmap.DIBFormat.e_DIBRgb32 , foxit.common.Bitmap.DIBFormat.e_DIBArgb . foxit.common.Bitmap.DIBFormat.e_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. |
|
inline |
Detect the bounding box of content according to the given color difference between content and margin.
This function can support the following formats:
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask , foxit.common.Bitmap.DIBFormat.e_DIB8bpp , foxit.common.Bitmap.DIBFormat.e_DIBRgb , foxit.common.Bitmap.DIBFormat.e_DIBRgb32 , foxit.common.Bitmap.DIBFormat.e_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. |
|
inline |
Fill current bitmap with a specified color.
This function can not support the following format:
foxit.common.Bitmap.DIBFormat.e_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. |
|
inline |
Flip bitmap.
This function can support following formats:
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask , foxit.common.Bitmap.DIBFormat.e_DIB8bpp , foxit.common.Bitmap.DIBFormat.e_DIBRgb , foxit.common.Bitmap.DIBFormat.e_DIBRgb32 , foxit.common.Bitmap.DIBFormat.e_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. |
|
inline |
Get bitmap bits-per-pixel.
|
inline |
Get bitmap buffer.
Bitmap data are organized in scan-lines, from top to down.
|
inline |
Get bitmap format.
|
inline |
Get bitmap height.
Get the mask if bitmap has mask.
[in] | clip_rect | The clipping region of current bitmap (as source bitmap). It can be null. |
|
inline |
Get bitmap pitch.
|
inline |
Get bitmap width.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
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:
foxit.common.Bitmap.DIBFormat.e_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 foxit.common.Bitmap.InterpolationFlag.e_Downsample or foxit.common.Bitmap.InterpolationFlag.e_Quadratic . |
[in] | clip_rect | The clipping region of destination bitmap. It can be null. |
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:
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask , foxit.common.Bitmap.DIBFormat.e_DIB8bpp , foxit.common.Bitmap.DIBFormat.e_DIBRgb , foxit.common.Bitmap.DIBFormat.e_DIBRgb32 , foxit.common.Bitmap.DIBFormat.e_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. |
|
inline |
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:
foxit.common.Bitmap.DIBFormat.e_DIBCmyk .
[in] | matrix | The transformation matrix. |
[in] | flag | Transform flag. It should be value foxit.common.Bitmap.InterpolationFlag.e_Downsample or foxit.common.Bitmap.InterpolationFlag.e_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. |