This class is used to render an OFD page to a bitmap. Please ensure FSDK.Library.InitializeOFDEngine has been called successfully before using this class.
- See also
- FSDK.Library
◆ constructor()
FSDK.OFDRenderer.constructor |
( |
bitmap |
| ) |
|
Constructor, with a bitmap object.
- Parameters
-
[in] | bitmap | A bitmap object. It should not be an empty bitmap. |
◆ IsEmpty()
FSDK.OFDRenderer.IsEmpty |
( |
| ) |
|
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means current object is empty, while false means not.
◆ Release()
FSDK.OFDRenderer.Release |
( |
| ) |
|
Release current OFD renderer object.
Please call this function before FSDK.Library.ReleaseOFDEngine to release current OFD renderer object.
- Returns
- None.
◆ SetColorMode()
FSDK.OFDRenderer.SetColorMode |
( |
color_mode |
| ) |
|
Set the color mode.
- Parameters
-
- Returns
- None.
◆ SetContentFlag()
FSDK.OFDRenderer.SetContentFlag |
( |
content_flag |
| ) |
|
Set the content flag.
- Parameters
-
- Returns
- None.
◆ StartRender()
FSDK.OFDRenderer.StartRender |
( |
page |
, |
|
|
matrix |
|
|
) |
| |
Start to render an OFD page.
This function is used to start to render an OFD page.
- Parameters
-
[in] | page | An OFD page object. It should not be an empty object. |
[in] | matrix | A matrix for rendering the page, which is usually returned by function FSDK.OFDPage.GetDisplayMatrix. |
- Returns
- A progressive object. Please check the rate of current progress by function FSDK.Progressive.GetRateOfProgress. If the rate is not 100 yet, call function FSDK.Progressive.Continue to continue the progress until the progress is finished.
◆ e_ColorModeNormal
FSDK.OFDRenderer.e_ColorModeNormal |
|
static |
Enumeration for rendering color mode.
Values of this enumeration should be used alone.
Normal color mode.
◆ e_ContentFlagAllContent
FSDK.OFDRenderer.e_ContentFlagAllContent |
|
static |
Enumeration for OFD rendering content flags.
Values of this enumeration can be used alone or in combination.
If set, all content will be rendered. This value should be used alone.