Foxit PDF SDK
|
Public Member Functions | |
AddFrame (bitmap) | |
Add a bitmap as a frame. (Unsupported DIB formats: FSDK.Bitmap.e_DIBRgb565 and FSDK.Bitmap.e_DIB8bppMask) More... | |
constructor () | |
Constructor. More... | |
constructor (buffer, ength) | |
Constructor, from a memory buffer. More... | |
constructor (file_read) | |
Constructor, with a file read callback object. More... | |
constructor (path) | |
Constructor, from an existing image file path. More... | |
GetFrameBitmap (index) | |
Get a frame bitmap, specified by index. More... | |
GetFrameCount () | |
Get frame count. More... | |
GetHeight () | |
Get image height. More... | |
GetType () | |
Get image type. More... | |
GetWidth () | |
Get image width. More... | |
GetXDPI () | |
Get DPI for X-axis. More... | |
GetYDPI () | |
Get DPI for Y-axis. More... | |
IsEmpty () | |
Check whether current object is empty or not. More... | |
SaveAs (file, file_extension) | |
Save current image as an image file. More... | |
SaveAs (file_path) | |
Save current image as an image file. More... | |
SetDPIs (x_dpi, y_dpi) | |
Set DPI for X-axis and Y-axis. More... | |
Static Public Attributes | |
static | e_BMP |
Image type is BMP. | |
static | e_GIF |
Image type is GIF. | |
static | e_JBIG2 |
Image type is JBIG2. More... | |
static | e_JPG |
Image type is JPG or JPEG. | |
static | e_JPX |
Image type is JPX or JPEG-2000. | |
static | e_None |
Not have image type yet. More... | |
static | e_PNG |
Image type is PNG. | |
static | e_TIF |
Image type is TIF or TIFF. | |
static | e_Unknown |
Enumeration for image type. More... | |
Foxit PDF SDK offers following image types:
FSDK.Image.AddFrame | ( | bitmap | ) |
Add a bitmap as a frame. (Unsupported DIB formats: FSDK.Bitmap.e_DIBRgb565 and FSDK.Bitmap.e_DIB8bppMask)
Currently, this function does not support an image with type FSDK.Image.e_JBIG2, or FSDK.Image.e_Unknown .
For supporting image types:
[in] | bitmap | A valid bitmap as a frame to be added or set. |
FSDK.Image.constructor | ( | ) |
Constructor.
This constructor is to construct a new image object (without any data). The image type of this constructed image object would be FSDK.Image.e_None.
FSDK.Image.constructor | ( | buffer | , |
ength | |||
) |
Constructor, from a memory buffer.
[in] | buffer | A memory buffer. The image file data should be fully loaded in this memory buffer. It should not be null. |
[in] | length | The size of memory buffer. It should be above 0. |
FSDK.Image.constructor | ( | file_read | ) |
Constructor, with a file read callback object.
[in] | file_read | A FSDK.FileReaderCallback object which is implemented by user to load an image file. It should not be null. |
FSDK.Image.constructor | ( | path | ) |
Constructor, from an existing image file path.
[in] | path | A full path of an existing image file. It should not be an empty string. |
FSDK.Image.GetFrameBitmap | ( | index | ) |
Get a frame bitmap, specified by index.
Currently, this function does not support an image with type FSDK.Image.e_JBIG2. This function can only support to get a frame bitmap which is in following formats:
FSDK.Bitmap.e_DIB8bppMask, FSDK.Bitmap.e_DIB8bpp, FSDK.Bitmap.e_DIBRgb, FSDK.Bitmap.e_DIBRgb32, FSDK.Bitmap.e_DIBArgb.
For other unsupported DIB format, this function will return a bitmap object which's function FSDK.Bitmap.IsEmpty returns true.
[in] | index | Index of the frame. Valid range: from 0 to (count-1). count is returned by function FSDK.Image.GetFrameCount. |
FSDK.Image.GetFrameCount | ( | ) |
Get frame count.
Currently, this function does not support an image with type FSDK.Image.e_JBIG2.
FSDK.Image.GetHeight | ( | ) |
Get image height.
If the image has multiple frames, usually the first frame's size will be treated as the image size.
FSDK.Image.GetType | ( | ) |
Get image type.
If current image is a new image (not constructed from any image file), its type would be FSDK.Image.e_None.
FSDK.Image.GetWidth | ( | ) |
Get image width.
If the image has multiple frames, usually the first frame's size will be treated as the image size.
FSDK.Image.GetXDPI | ( | ) |
Get DPI for X-axis.
Currently, this function does not support an image with type FSDK.Image.e_JPX, FSDK.Image.e_GIF or FSDK.Image.e_JBIG2.
For a new image (not constructed from any image file), the default DPI for X-axis is 96.
FSDK.Image.GetYDPI | ( | ) |
Get DPI for Y-axis.
Currently, this function does not support an image with type FSDK.Image.e_JPX, FSDK.Image.e_GIF or FSDK.Image.e_JBIG2.
For a new image (not constructed from any image file), the default DPI for Y-axis is 96.
FSDK.Image.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
FSDK.Image.SaveAs | ( | file | , |
file_extension | |||
) |
Save current image as an image file.
If the type of current image is FSDK.Image.e_TIF, FSDK.Image.e_GIF or FSDK.Image.e_None, and the saved image file type does not support multiply frames, only the first frame of current image will be saved to the image file.
For an image object (not constructed from any image file), please ensure to add at least one valid frame bitmap to the image object before using this function; otherwise this function will fail.
[in] | file | A FSDK.StreamCallback object which is implemented by user to save image file. |
[in] | file_extension | A full path of the saved image file. It should not be an empty string. Currently, this function supports following extension names: .bmp, .jpg, .jpeg, .png, .tif, .tiff, .jpx, .jp2. |
FSDK.Image.SaveAs | ( | file_path | ) |
Save current image as an image file.
If the type of current image is FSDK.Image.e_TIF, FSDK.Image.e_GIF or FSDK.Image.e_None, and the saved image file type does not support multiply frames, only the first frame of current image will be saved to the image file.
For an image object (not constructed from any image file), please ensure to add at least one valid frame bitmap to the image object before using this function; otherwise this function will fail.
[in] | file_path | A full path of the saved image file. It should not be an empty string. Currently, this function supports following extension names: .bmp, .jpg, .jpeg, .png, .tif, .tiff, .jpx, .jp2. |
FSDK.Image.SetDPIs | ( | x_dpi | , |
y_dpi | |||
) |
Set DPI for X-axis and Y-axis.
Currently, this function does not support an image with type FSDK.Image.e_JPX, FSDK.Image.e_GIF, or FSDK.Image.e_JBIG2.
[in] | x_dpi | DPI for X-axis. It should be above 0. |
[in] | y_dpi | DPI for Y-axis. It should be above 0. |
|
static |
Image type is JBIG2.
|
static |
Not have image type yet.
|
static |
Enumeration for image type.
Values of this enumeration should be used alone.
Unknown image type.