Foxit PDF SDK
foxit.common.Renderer Class Reference
Inheritance diagram for foxit.common.Renderer:
foxit.common.Base

Public Types

enum  ColorMode { ColorMode.e_ColorModeNormal = 0, ColorMode.e_ColorModeMappingGray = 1, ColorMode.e_ColorModeMapping = 2 }
 Enumeration for rendering color mode.
More...
 
enum  ContentFlag { ContentFlag.e_RenderPage = 0x01, ContentFlag.e_RenderAnnot = 0x02 }
 Enumeration for rendering content flags.
More...
 

Public Member Functions

 Renderer (Bitmap bitmap, bool is_rgb_order)
 Constructor, with bitmap.
More...
 
 Renderer (Renderer other)
 Constructor, with another renderer object.
More...
 
void EnableForPrint (bool is_render_for_print)
 Set the flag to decide whether to do rendering in print mode.
More...
 
bool IsEmpty ()
 Check whether current object is empty or not.
More...
 
bool RenderAnnot (Annot annot, Matrix2D matrix)
 Render a specified annotation.
More...
 
bool RenderFormControls (PDFPage page, Matrix2D matrix)
 Render form controls.
More...
 
bool RenderGraphicsObject (GraphicsObject graphics_object, PDFPage page, Matrix2D matrix)
 Render a graphics object.
More...
 
void SetClearType (bool is_clear_type)
 Set the flag to decide whether to use ClearType-like anti-aliasing to render text objects.
More...
 
void SetClipPathFill (Path clip_path, Matrix2D matrix, FillMode fill_mode)
 Set clipping path using filled region.
More...
 
void SetClipPathStroke (Path clip_path, Matrix2D matrix, GraphState graph_state)
 Set clipping path using stroked region.
More...
 
void SetClipRect (RectI clip_rect)
 Set the clipping rectangle which will be used in following rendering progress.
More...
 
void SetColorMode (Renderer.ColorMode color_mode)
 Set color mode.
More...
 
void SetForceDownSample (bool is_to_force_down_sample)
 Set the flag to decide whether to use down-sampling for image stretching.
More...
 
void SetForceHalftone (bool is_to_force_halftone)
 Set the flag to decide whether to use halftone for image stretching.
More...
 
void SetJPEGDownSample (bool is_jepg_down_sample)
 Set the flag to decide whether to use down-sampling for jpeg image.
More...
 
void SetJPXDownSample (bool is_jpx_down_sample)
 Set the flag to decide whether to use down-sampling for jpx image.
More...
 
void SetLayerContext (LayerContext layer_context)
 Set layer context to render context handle.
More...
 
void SetMappingModeColors (uint background_color, uint foreground_color)
 Set background color and foreground color when color mode is foxit.common.Renderer.ColorMode.e_ColorModeMappingGray or foxit.common.Renderer.ColorMode.e_ColorModeMapping .
More...
 
void SetPrintTextAsGraphic (bool is_to_print_text_graphic)
 Set the flag to decide whether to print text as path or bitmap.
More...
 
void SetPrintTextAsImage (bool is_to_print_text_image)
 Set the flag to decide whether to print text as image.
More...
 
void SetRenderAnnotAppearanceType (Annot.AppearanceType ap_type)
 Set the annotation's appearance type for rendering.
More...
 
void SetRenderAnnotsForThumbnail (bool is_render_annots_for_thumbnail)
 Set rendering flag to decide whether to render annotations in thumbnail mode or not.
More...
 
void SetRenderContentFlags (int render_content_flags)
 Set rendering flag to decide what content will be rendered.
More...
 
void SetRenderEnhanceThinLines (bool is_render_enhance_thin_lines)
 Set the flag to decide whether to enhance thin lines.
More...
 
void SetRenderFormField (bool is_render_formfield)
 Set the flag to decide whether to render form fields (except signature fields).
More...
 
void SetRenderImageAntiAliasing (bool is_render_image_antialiasing)
 Set the flag to decide whether to draw image anti-aliasing.
More...
 
void SetRenderPathAntiAliasing (bool is_render_path_antialiasing)
 Set the flag to decide whether to draw path anti-aliasing.
More...
 
void SetRenderPathThinLine (bool is_render_path_thin_line)
 Set the flag to decide whether to draw path as thin line.
More...
 
void SetRenderSignature (bool is_render_signature)
 Set the flag to decide whether to render signatures or not.
More...
 
void SetRenderTextAntiAliasing (bool is_render_text_antialiasing)
 Set the flag to decide whether to draw text anti-aliasing.
More...
 
Progressive StartQuickRender (PDFPage page, Matrix2D matrix, PauseCallback pause)
 Start to quickly render a PDF page, mainly for thumbnail purpose.
More...
 
Progressive StartRender (PDFPage page, Matrix2D matrix, PauseCallback pause)
 Start to render a PDF page.
More...
 
Progressive StartRenderBitmap (Bitmap bitmap, Matrix2D matrix, RectI clip_rect, int interpolation, PauseCallback pause)
 Start to render a bitmap.
More...
 
Progressive StartRenderReflowPage (ReflowPage reflow_page, Matrix2D matrix, PauseCallback pause)
 Start to render a reflow page.
More...
 
Progressive StartRenderXFAPage (XFAPage xfa_page_view, Matrix2D matrix, bool is_highlight, PauseCallback pause)
 Start to render an XFA page.
More...
 

Detailed Description

PDF renderer is a graphics engine and is used to render page to a bitmap or a platform device context. This class can be constructed with a bitmap, or a device object. It offers functions to set rendering options/flags, and do rendering. In this class, there are several ways to do rendering:

Widget annotation is always associated with form field and form control in Foxit PDF SDK. For how to render widget annotations, here is a recommended flow:


See also
foxit.pdf.interform.Filler

Member Enumeration Documentation

◆ ColorMode

Enumeration for rendering color mode.

Values of this enumeration should be used alone.

Enumerator
e_ColorModeNormal 

Normal color mode.

e_ColorModeMappingGray 

Map gray/white/black color value to background/foreground; for other colors, no change.

e_ColorModeMapping 

Map a color value to the color range defined by a background color and a foreground color.

◆ ContentFlag

Enumeration for rendering content flags.

Values of this enumeration can be used alone or in combination.

Enumerator
e_RenderPage 

If set, page content will be rendered.

e_RenderAnnot 

If set, annotations will be rendered.

Constructor & Destructor Documentation

◆ Renderer() [1/2]

foxit.common.Renderer.Renderer ( Bitmap  bitmap,
bool  is_rgb_order 
)
inline

Constructor, with bitmap.

The input bitmap is treated as an independent device and all the content rendered by the renderer would appear in the bitmap.

Parameters
[in]bitmapA bitmap used for rendering. User should ensure the bitmap to keep valid until the end of life cycle of current renderer object.
[in]is_rgb_ordertrue means Foxit PDF SDK needs to use RGB byte-order (Red is in the lowest order) when rendering.
false means Foxit PDF SDK needs to use BGR byte-order (Blue is in the lowest order) when rendering.

◆ Renderer() [2/2]

foxit.common.Renderer.Renderer ( Renderer  other)
inline

Constructor, with another renderer object.

Parameters
[in]otherAnother renderer object.

Member Function Documentation

◆ EnableForPrint()

void foxit.common.Renderer.EnableForPrint ( bool  is_render_for_print)
inline

Set the flag to decide whether to do rendering in print mode.

Please ensure this rendering flag is set as expected when current renderer is to used for printing. For rendering annotations, if this flag is set to be true, Foxit PDF SDK will only render annotations which have annotation flag foxit.pdf.annots.Annot.Flags.e_FlagPrint .
If this function is not called for current renderer object yet, default value false will be used.

Parameters
[in]is_render_for_printtrue means to render in print mode, while false means to render not in print mode.
Returns
None.

◆ IsEmpty()

bool foxit.common.Renderer.IsEmpty ( )
inline

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.

◆ RenderAnnot()

bool foxit.common.Renderer.RenderAnnot ( Annot  annot,
Matrix2D  matrix 
)
inline

Render a specified annotation.

When this function is called, rendering flag (set by function Renderer.SetRenderContentFlags or by default) will be ignored.

Parameters
[in]annotAn annotation object to be rendered. If input annot is a pop-up annotation, this function will not render it and will return false.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function pdf.PDFPage.GetDisplayMatrix .
Returns
true means success, while false means failure.

◆ RenderFormControls()

bool foxit.common.Renderer.RenderFormControls ( PDFPage  page,
Matrix2D  matrix 
)
inline

Render form controls.

When this function is called, rendering flag (set by function Renderer.SetRenderContentFlags or by default) will be ignored.

Parameters
[in]pageA valid PDF page. If input page is invalid, this function do nothing and return false directly.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function pdf.PDFPage.GetDisplayMatrix .
Returns
true means success, while false means failure.

◆ RenderGraphicsObject()

bool foxit.common.Renderer.RenderGraphicsObject ( GraphicsObject  graphics_object,
PDFPage  page,
Matrix2D  matrix 
)
inline

Render a graphics object.

When this function is called, rendering flag (set by function Renderer.SetRenderContentFlags or by default) will be ignored.

Parameters
[in]graphics_objectA valid PDF graphics object to be rendered.
[in]pageA valid PDF page. Parameter graphics_object belongs to this PDF page.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function pdf.PDFPage.GetDisplayMatrix .
Returns
true means success, while false means failure.

◆ SetClearType()

void foxit.common.Renderer.SetClearType ( bool  is_clear_type)
inline

Set the flag to decide whether to use ClearType-like anti-aliasing to render text objects.

If this function is not called, default value true will be used.

Parameters
[in]is_clear_typetrue means to use ClearType-like anti-aliasing to render text objects. false means not to use ClearType-like anti-aliasing to render text objects.
Returns
None.

◆ SetClipPathFill()

void foxit.common.Renderer.SetClipPathFill ( Path  clip_path,
Matrix2D  matrix,
FillMode  fill_mode 
)
inline

Set clipping path using filled region.

Parameters
[in]clip_pathA clipping path.
[in]matrixThe transformation matrix used for clipping.
[in]fill_modeFill mode. It should be value or .
Returns
None.

◆ SetClipPathStroke()

void foxit.common.Renderer.SetClipPathStroke ( Path  clip_path,
Matrix2D  matrix,
GraphState  graph_state 
)
inline

Set clipping path using stroked region.

Parameters
[in]clip_pathA clipping path.
[in]matrixThe transformation matrix used for clipping.
[in]graph_stateA valid graph state, for pen attributes. If this is null, Foxit PDF SDK will use a graph state object with default constructor.
Returns
None.

◆ SetClipRect()

void foxit.common.Renderer.SetClipRect ( RectI  clip_rect)
inline

Set the clipping rectangle which will be used in following rendering progress.

Parameters
[in]clip_rectA clipping rectangle. If it is null, that means not to use clipping rectangle in following rendering progress.
Returns
None.

◆ SetColorMode()

void foxit.common.Renderer.SetColorMode ( Renderer.ColorMode  color_mode)
inline

Set color mode.

If this function is not called, default value foxit.common.Renderer.ColorMode.e_ColorModeNormal will be used.

Parameters
[in]color_modeColor mode value. It should be one of following values:
Returns
None.

◆ SetForceDownSample()

void foxit.common.Renderer.SetForceDownSample ( bool  is_to_force_down_sample)
inline

Set the flag to decide whether to use down-sampling for image stretching.

If this function is not called, default value false will be used.

Parameters
[in]is_to_force_down_sampletrue means to use down-sampling for image stretching. false means not to use down-sampling for image stretching.
Returns
None.

◆ SetForceHalftone()

void foxit.common.Renderer.SetForceHalftone ( bool  is_to_force_halftone)
inline

Set the flag to decide whether to use halftone for image stretching.

If this function is not called, default value true will be used.

Parameters
[in]is_to_force_halftonetrue means to use halftone for image stretching. false means not to use halftone for image stretching.
Returns
None.

◆ SetJPEGDownSample()

void foxit.common.Renderer.SetJPEGDownSample ( bool  is_jepg_down_sample)
inline

Set the flag to decide whether to use down-sampling for jpeg image.

Whether to use down-sampling for jpeg image or not will affect rendering result for a PDF page. When current function is called successfully, user should called function pdf.PDFPage.ClearRenderCache for a PDF page (which has been rendered at least once) before rendering the PDF page again.
If this function is not called, default value true will be used.

Parameters
[in]is_jepg_down_sampletrue means to use down-sampling for jpeg image. false means not to use down-sampling for jpeg image.
Returns
None.

◆ SetJPXDownSample()

void foxit.common.Renderer.SetJPXDownSample ( bool  is_jpx_down_sample)
inline

Set the flag to decide whether to use down-sampling for jpx image.

Whether to use down-sampling for jpx image or not will affect rendering result for a PDF page. When current function is called successfully, user should called function pdf.PDFPage.ClearRenderCache for a PDF page (which has been rendered at least once) before rendering the PDF page again.
If this function is not called, default value true will be used.

Parameters
[in]is_jpx_down_sampletrue means to use down-sampling for jpx image. false means not to use down-sampling for jpx image.
Returns
None.

◆ SetLayerContext()

void foxit.common.Renderer.SetLayerContext ( LayerContext  layer_context)
inline

Set layer context to render context handle.

In order to render one layer when PDF page's contents is rendered on a rendering context, user should call this function to set the layer context to render context.

Parameters
[in]layer_contextA layer context object.
Returns
None.

◆ SetMappingModeColors()

void foxit.common.Renderer.SetMappingModeColors ( uint  background_color,
uint  foreground_color 
)
inline

Set background color and foreground color when color mode is foxit.common.Renderer.ColorMode.e_ColorModeMappingGray or foxit.common.Renderer.ColorMode.e_ColorModeMapping .

Parameters
[in]background_colorThe background color. Format: 0xAARRGGBB.
[in]foreground_colorThe foreground color. Format: 0xAARRGGBB.
Returns
None.

◆ SetPrintTextAsGraphic()

void foxit.common.Renderer.SetPrintTextAsGraphic ( bool  is_to_print_text_graphic)
inline

Set the flag to decide whether to print text as path or bitmap.

When this flag is true, Foxit PDF SDK will render text in different way: if font size is greater than 50, print text as path; otherwise, print text as bitmap.
If this function is not called, default value false will be used.

Parameters
[in]is_to_print_text_graphictrue means to print text as path or bitmap. false means not to print text as path or bitmap.
Returns
None.

◆ SetPrintTextAsImage()

void foxit.common.Renderer.SetPrintTextAsImage ( bool  is_to_print_text_image)
inline

Set the flag to decide whether to print text as image.

If this function is not called, default value false will be used.

Parameters
[in]is_to_print_text_imagetrue means to print text as image. false means not to print text as image.
Returns
None.

◆ SetRenderAnnotAppearanceType()

void foxit.common.Renderer.SetRenderAnnotAppearanceType ( Annot.AppearanceType  ap_type)
inline

Set the annotation's appearance type for rendering.

Parameters
[in]ap_typeType of annotation's appearance. Please refer to values starting from foxit.pdf.annots.Annot.AppearanceType.e_AppearanceTypeNormal and this should be one of these values.
Returns
None.

◆ SetRenderAnnotsForThumbnail()

void foxit.common.Renderer.SetRenderAnnotsForThumbnail ( bool  is_render_annots_for_thumbnail)
inline

Set rendering flag to decide whether to render annotations in thumbnail mode or not.

In thumbnail mode, the flags of annotations, "NoZoom" and "NoRotate", will be ignored. This rendering flag is available only when flag foxit.common.Renderer.ContentFlag.e_RenderAnnot is used for rendering or function Renderer.RenderAnnot is called. Please refer to function Renderer.SetRenderContentFlags about setting flag foxit.common.Renderer.ContentFlag.e_RenderAnnot .
If this function is not called, default value false will be used when this rendering flag is available.

Parameters
[in]is_render_annots_for_thumbnailtrue means to render annotations in thumbnail mode. false means not to render annotations in thumbnail mode.
Returns
None.

◆ SetRenderContentFlags()

void foxit.common.Renderer.SetRenderContentFlags ( int  render_content_flags)
inline

Set rendering flag to decide what content will be rendered.

If this function is not called, default value (foxit.common.Renderer.ContentFlag.e_RenderPage | foxit.common.Renderer.ContentFlag.e_RenderAnnot ) will be used.

Parameters
[in]render_content_flagsRendering content flags. Please refer to values starting from foxit.common.Renderer.ContentFlag.e_RenderPage and this should be one or a combination of these values.
Returns
None.

◆ SetRenderEnhanceThinLines()

void foxit.common.Renderer.SetRenderEnhanceThinLines ( bool  is_render_enhance_thin_lines)
inline

Set the flag to decide whether to enhance thin lines.

If this function is not called, default value false will be used.

Parameters
[in]is_render_enhance_thin_linestrue means to draw zero width lines with a thicker path so they are more visible than the default single pixel.
false means to draw zero width lines with a single pixel width.
Returns
None.

◆ SetRenderFormField()

void foxit.common.Renderer.SetRenderFormField ( bool  is_render_formfield)
inline

Set the flag to decide whether to render form fields (except signature fields).

If this function is not called, default value true will be used when this flag is available.

Parameters
[in]is_render_formfieldtrue means to render form fields (except signature fields). false means not to render form fields (except signature fields).
Returns
None.

◆ SetRenderImageAntiAliasing()

void foxit.common.Renderer.SetRenderImageAntiAliasing ( bool  is_render_image_antialiasing)
inline

Set the flag to decide whether to draw image anti-aliasing.

If this function is not called, default value true will be used.

Parameters
[in]is_render_image_antialiasingtrue means to draw image anti-aliasing, and the effect would be similar to values defined in enum class InterpolationFlag. false means to draw image aliasing.
Returns
None.

◆ SetRenderPathAntiAliasing()

void foxit.common.Renderer.SetRenderPathAntiAliasing ( bool  is_render_path_antialiasing)
inline

Set the flag to decide whether to draw path anti-aliasing.

If this function is not called, default value true will be used.

Parameters
[in]is_render_path_antialiasingtrue means to draw path anti-aliasing. false means to draw path aliasing.
Returns
None.

◆ SetRenderPathThinLine()

void foxit.common.Renderer.SetRenderPathThinLine ( bool  is_render_path_thin_line)
inline

Set the flag to decide whether to draw path as thin line.

If this function is not called, default value false will be used.

Parameters
[in]is_render_path_thin_linetrue means to draw path as thin line. false means not to draw path as thin line.
Returns
None.

◆ SetRenderSignature()

void foxit.common.Renderer.SetRenderSignature ( bool  is_render_signature)
inline

Set the flag to decide whether to render signatures or not.

If this function is not called, default value true will be used when this flag is available.

Parameters
[in]is_render_signaturetrue means to render signatures. false means not to render signatures.
Returns
None.

◆ SetRenderTextAntiAliasing()

void foxit.common.Renderer.SetRenderTextAntiAliasing ( bool  is_render_text_antialiasing)
inline

Set the flag to decide whether to draw text anti-aliasing.

If this function is not called, default value true will be used.

Parameters
[in]is_render_text_antialiasingtrue means to draw text anti-aliasing. false means to draw text aliasing.
Returns
None.

◆ StartQuickRender()

Progressive foxit.common.Renderer.StartQuickRender ( PDFPage  page,
Matrix2D  matrix,
PauseCallback  pause 
)
inline

Start to quickly render a PDF page, mainly for thumbnail purpose.

This function is mainly used for render a page for thumbnail purpose. The rendered content will not be completed: all the annotations will be ignored, event if flag foxit.common.Renderer.ContentFlag.e_RenderAnnot is set by function Renderer.SetRenderContentFlags ; text content will become blurred and will be replace by pixel point.
It may still take a long time to do this quick rendering when page has complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]pageA valid PDF page. It should have been parsed.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function pdf.PDFPage.GetDisplayMatrix .
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function Progressive.GetRateOfProgress . If the rate is not 100 yet, call function Progressive.Continue to continue the progress until the progress is finished.

◆ StartRender()

Progressive foxit.common.Renderer.StartRender ( PDFPage  page,
Matrix2D  matrix,
PauseCallback  pause 
)
inline

Start to render a PDF page.

It may take a long time to render a PDF page with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.
Widget annotation is always associated with form field and form control in Foxit PDF SDK. For how to render widget annotations, here is a recommended flow:


Parameters
[in]pageA valid PDF page. If only to render annotations (that means only foxit.common.Renderer.ContentFlag.e_RenderAnnot is set by function Renderer.SetRenderContentFlags ), there is no need to parse the input page; otherwise the input page should have been parsed.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function pdf.PDFPage.GetDisplayMatrix .
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function Progressive.GetRateOfProgress . If the rate is not 100 yet, call function Progressive.Continue to continue the progress until the progress is finished.

◆ StartRenderBitmap()

Progressive foxit.common.Renderer.StartRenderBitmap ( Bitmap  bitmap,
Matrix2D  matrix,
RectI  clip_rect,
int  interpolation,
PauseCallback  pause 
)
inline

Start to render a bitmap.

It may take a long time to render a bitmap with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]bitmapA valid bitmap. User should ensure the bitmap to keep valid until current rendering process is finished.
[in]matrixThe transformation matrix used for rendering. This matrix is used as image matrix:
assume that h is image height, w is image width, and then matrix [w 0 0 h 0 0] will produce an identical image.
[in]clip_rectClip rectangle for the rendering device. This can be null.
[in]interpolationBitmap interpolation flags. Please refer to values starting from foxit.common.Bitmap.InterpolationFlag.e_Downsample and this can be one or a combination of these values. If not specify any flag, please use 0.
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function Progressive.GetRateOfProgress . If the rate is not 100 yet, call function Progressive.Continue to continue the progress until the progress is finished.

◆ StartRenderReflowPage()

Progressive foxit.common.Renderer.StartRenderReflowPage ( ReflowPage  reflow_page,
Matrix2D  matrix,
PauseCallback  pause 
)
inline

Start to render a reflow page.

It may take a long time to render a reflow page with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]reflow_pageA valid reflow page. It should have been parsed.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function pdf.ReflowPage.GetDisplayMatrix .
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function Progressive.GetRateOfProgress . If the rate is not 100 yet, call function Progressive.Continue to continue the progress until the progress is finished.

◆ StartRenderXFAPage()

Progressive foxit.common.Renderer.StartRenderXFAPage ( XFAPage  xfa_page_view,
Matrix2D  matrix,
bool  is_highlight,
PauseCallback  pause 
)
inline

Start to render an XFA page.

It will take a long time to render an XFA page with complex or large contents, so Foxit PDF SDK uses a progressive process to do this.

Parameters
[in]xfa_page_viewA valid XFA page.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function addon.xfa.XFAPage.GetDisplayMatrix .
[in]is_highlighttrue means to highlight XFA widgets, and false means not to highlight XFA widgets.
[in]pausePause callback object which decides if the rendering process needs to be paused. This can be null which means not to pause during the rendering process. If this is not null, it should be a valid pause object implemented by user.
Returns
A progressive object. Please check the rate of current progress by function Progressive.GetRateOfProgress . If the rate is not 100 yet, call function Progressive.Continue to continue the progress until the progress is finished.