Public 成员函数
	ClearClips ()
	清除由函数 FSDK.Renderer.SetClipRect 设置的裁剪矩形更多...

	constructor (bitmap, is_rgb_order)
	带有位图的构造函数。更多...

	EnableForPrint (is_render_for_print)
	设置标志以决定是否以打印模式进行渲染。更多...

	IsEmpty ()

	RenderAnnot (annot, matrix)
	渲染指定的注释。更多...

	RenderFormControls (page, matrix)
	渲染表单控件。更多...

	RenderGraphicsObject (graphics_object, page, matrix)
	渲染图形对象。更多...

	SetClearType (is_clear_type)
	设置标志以决定是否使用类似 ClearType 的抗锯齿来渲染文本对象。更多...

	SetClipPathFill (clip_path, matrix, fill_mode)
	使用填充区域设置裁剪路径。更多...

	SetClipPathStroke (clip_path, matrix, graph_state)
	使用描边区域设置裁剪路径。更多...

	SetClipRect (clip_rect)
	设置将在后续渲染进度中使用的裁剪矩形更多...

	SetColorMode (color_mode)
	设置颜色模式。更多...

	SetForceDownSample (is_to_force_down_sample)
	设置标志以决定是否对图像拉伸使用降采样。更多...

	SetForceHalftone (is_to_force_halftone)
	设置标志以决定是否对图像拉伸使用半色调。更多...

	SetForegroundColor (foreground_color)
	当颜色模式为 FSDK.Renderer.e_ColorModeForeground 时设置文本、路径或两者的前景颜色。更多...

	SetForegroundColorMode (foreground_color_mode)
	当颜色模式为 FSDK.Renderer.e_ColorModeForeground 时设置渲染前景颜色模式。更多...

	SetJPEGDownSample (is_jepg_down_sample)
	设置标志以决定是否对 jpeg 图像使用降采样。更多...

	SetJPXDownSample (is_jpx_down_sample)
	设置标志以决定是否对 jpx 图像使用降采样。更多...

	SetLayerContext (layer_context)
	将图层上下文设置到渲染上下文句柄。更多...

	SetMappingModeColors (background_color, foreground_color)
	当颜色模式为 FSDK.Renderer.e_ColorModeMappingGray 或 FSDK.Renderer.e_ColorModeMapping 时设置背景颜色和前景颜色。更多...

	SetOverprint (is_to_enable_overprint)
	设置标志以决定是否启用叠印。更多...

	SetPrintTextAsGraphic (is_to_print_text_graphic)
	设置标志以决定是否将文本打印为路径或位图。更多...

	SetPrintTextAsImage (is_to_print_text_image)
	设置标志以决定是否将文本打印为图像。更多...

	SetRenderAnnotAppearanceType (ap_type)
	设置用于渲染的注释外观类型。更多...

	SetRenderAnnotsForThumbnail (is_render_annots_for_thumbnail)
	设置渲染标志以决定是否以缩略图模式渲染注释。更多...

	SetRenderContentFlags (render_content_flags)
	设置渲染标志以决定将渲染什么内容。更多...

	SetRenderEnhanceThinLines (is_render_enhance_thin_lines)
	设置标志以决定是否增强细线。更多...

	SetRenderFormField (is_render_formfield)
	设置标志以决定是否渲染表单域（签名域除外）。更多...

	SetRenderImageAntiAliasing (is_render_image_antialiasing)
	设置标志以决定是否绘制图像抗锯齿。更多...

	SetRenderLayer (is_render_one_layer)
	设置标志以决定是渲染一个图层还是所有可用图层。更多...

	SetRenderPathAntiAliasing (is_render_path_antialiasing)
	设置标志以决定是否绘制路径抗锯齿。更多...

	SetRenderPathFullCovered (is_render_path_full_covered)
	可应用于填充模式的特殊标志。更多...

	SetRenderPathThinLine (is_render_path_thin_line)
	设置标志以决定是否将路径绘制为细线。更多...

	SetRenderSignature (is_render_signature)
	设置标志以决定是否渲染签名。更多...

	SetRenderSignatureState (is_render_signature_state)
	设置标志以决定是否在签名上绘制签名状态。更多...

	SetRenderTextAntiAliasing (is_render_text_antialiasing)
	设置标志以决定是否绘制文本抗锯齿。更多...

	SetScreenDPIScale (scale)
	设置用于渲染的屏幕 DPI 缩放因子更多...

	StartQuickRender (page, matrix, pause)
	开始快速渲染 PDF 页面，主要用于缩略图目的。更多...

	StartRender (page, matrix, pause)
	开始渲染 PDF 页面。更多...

	StartRenderBitmap (bitmap, matrix, clip_rect, interpolation, alpha, pause)
	开始渲染位图。更多...

	StartRenderBitmap (bitmap, matrix, clip_rect, interpolation, pause)
	开始渲染位图。更多...

	StartRenderReflowPage (reflow_page, matrix, pause)
	开始渲染重排页面。更多...

	StartRenderXFAPage (xfa_page_view, matrix, is_highlight, pause)
	开始渲染 XFA 页面。更多...

Public 属性
	e_RenderAnnot
	如果设置，将渲染注释。

	e_RenderExceptHighLight
	如果设置，将渲染除高亮注释之外的所有注释。

	e_RenderHighLight
	如果设置，将仅渲染高亮注释。

	e_RenderPage
	渲染内容标志的枚举。更多...

	e_RenderScreen
	如果设置，将仅渲染屏幕注释。

静态 Public 属性
static	e_ColorModeMapping
	将颜色值映射到由背景颜色和前景颜色定义的颜色范围。

static	e_ColorModeMappingGray
	将灰色/白色/黑色颜色值映射到背景/前景；对于其他颜色，不改变。

static	e_ColorModeNormal
	渲染颜色模式的枚举。更多...

详细描述

PDF 渲染器是一个图形引擎，用于将页面渲染到位图或平台设备上下文。此类可以使用位图或设备对象构造。它提供设置渲染选项/标志和执行渲染的函数。在此类中，有几种渲染方式：

要渲染页面和注释，首先使用函数 FSDK.Renderer.SetRenderContentFlags 来决定是否同时渲染页面和注释，然后使用函数 FSDK.Renderer.StartRender 来执行渲染。函数 FSDK.Renderer.StartQuickRender 也可用于渲染页面，但仅用于缩略图目的。
要渲染单个注释，使用函数 FSDK.Renderer.RenderAnnot。
要渲染位图，使用函数 FSDK.Renderer.StartRenderBitmap。
要渲染重排页面，使用函数 FSDK.Renderer.StartRenderReflowPage。

在 Foxit PDF SDK 中，小部件注释始终与表单域和表单控件关联。对于如何渲染小部件注释，建议的流程如下：

加载 PDF 页面后，首先渲染该页面中的页面和所有注释（包括小部件注释）。
然后，如果用户使用 FSDK.Filler 对象填充表单，用户应使用函数 FSDK.Filler.Render 来渲染聚焦的表单控件，而不是使用函数 FSDK.Renderer.RenderAnnot。

参见: FSDK.Filler

成员函数说明

◆ ClearClips()

FSDK::Renderer::ClearClips ( )

清除由函数 FSDK.Renderer.SetClipRect 设置的裁剪矩形

返回: 无。

◆ constructor()

FSDK::Renderer::constructor	(	bitmap	,
		is_rgb_order
	)

带有位图的构造函数。

输入位图被视为独立设备，渲染器渲染的所有内容都将出现在位图中。

参数

[in]	bitmap	用于渲染的位图。用户应确保位图保持有效，直到当前渲染器对象的生命周期结束。位图的格式不应为 FSDK.Bitmap.e_DIB1bpp。
[in]	is_rgb_order	true 表示 Foxit PDF SDK 需要在渲染时使用 RGB 字节顺序（红色在最低位）。 false 表示 Foxit PDF SDK 需要在渲染时使用 BGR 字节顺序（蓝色在最低位）。

◆ EnableForPrint()

FSDK::Renderer::EnableForPrint ( is_render_for_print )

设置标志以决定是否以打印模式进行渲染。

当当前渲染器用于打印时，请确保此渲染标志设置为预期值。对于渲染注释，如果此标志设置为 true，Foxit PDF SDK 将仅渲染具有注释标志 FSDK.Annot.e_FlagPrint 的注释。
如果尚未为当前渲染器对象调用此函数，将使用默认值 false。

参数

[in] is_render_for_print true 表示以打印模式渲染，而 false 表示不以打印模式渲染。

返回: 无。

◆ IsEmpty()

FSDK::Renderer::IsEmpty ( )

         @brief 带有 postscript device setting data.

         @details All the content rendered by the renderer would appear in PostScrip file.

         @param[in] print_param       Setting data used to postscript device.
         @param[in] dest_psfile_path  The path to generate the printed PostScrip file.
        &zwj;/

Renderer(const PostScriptDeviceSettingData& print_param, const wchar_t* dest_psfile_path); endif

/**
   @brief 检查当前对象是否为空。

   @details 当当前对象为空时，表示当前对象无用。

   @return <b>true</b> 表示当前对象为空，而 <b>false</b> 表示不为空。

◆ RenderAnnot()

FSDK::Renderer::RenderAnnot	(	annot	,
		matrix
	)

渲染指定的注释。

当调用此函数时，将忽略渲染标志（通过函数 FSDK.Renderer.SetRenderContentFlags 设置或默认设置）。

参数

[in]	annot	要渲染的注释对象。如果输入注释是弹出注释，此函数将不渲染它并将返回 false。
[in]	matrix	用于渲染的变换矩阵，通常由函数 FSDK.PDFPage.GetDisplayMatrix 返回。

返回: true 表示成功，而 false 表示失败。

◆ RenderFormControls()

FSDK::Renderer::RenderFormControls	(	page	,
		matrix
	)

渲染表单控件。

当调用此函数时，将忽略渲染标志（通过函数 FSDK.Renderer.SetRenderContentFlags 设置或默认设置）。

参数

[in]	page	有效的 PDF 页面。如果输入页面无效，此函数不执行任何操作并直接返回 false。
[in]	matrix	用于渲染的变换矩阵，通常由函数 FSDK.PDFPage.GetDisplayMatrix 返回。

返回: true 表示成功，而 false 表示失败。

◆ RenderGraphicsObject()

FSDK::Renderer::RenderGraphicsObject	(	graphics_object	,
		page	,
		matrix
	)

渲染图形对象。

当调用此函数时，将忽略渲染标志（通过函数 FSDK.Renderer.SetRenderContentFlags 设置或默认设置）。

参数

[in]	graphics_object	要渲染的有效 PDF 图形对象。
[in]	page	有效的 PDF 页面。参数 graphics_object 属于此 PDF 页面。
[in]	matrix	用于渲染的变换矩阵，通常由函数 FSDK.PDFPage.GetDisplayMatrix 返回。

返回: true 表示成功，而 false 表示失败。

◆ SetClearType()

FSDK::Renderer::SetClearType ( is_clear_type )

设置标志以决定是否使用类似 ClearType 的抗锯齿来渲染文本对象。

如果不调用此函数，将使用默认值 true。

参数

[in] is_clear_type true 表示使用类似 ClearType 的抗锯齿来渲染文本对象。 false 表示不使用类似 ClearType 的抗锯齿来渲染文本对象。

返回: 无。

◆ SetClipPathFill()

FSDK::Renderer::SetClipPathFill	(	clip_path	,
		matrix	,
		fill_mode
	)

使用填充区域设置裁剪路径。

参数

[in]	clip_path	裁剪路径。
[in]	matrix	用于裁剪的变换矩阵。 FSDK.e_FillModeWinding。

返回: 无。

◆ SetClipPathStroke()

FSDK::Renderer::SetClipPathStroke	(	clip_path	,
		matrix	,
		graph_state
	)

使用描边区域设置裁剪路径。

参数

[in]	clip_path	裁剪路径。
[in]	matrix	用于裁剪的变换矩阵。
[in]	graph_state	有效的图形状态，用于画笔属性。如果为 null，Foxit PDF SDK 将使用具有默认构造函数的图形状态对象。默认值：null。

返回: 无。

◆ SetClipRect()

FSDK::Renderer::SetClipRect ( clip_rect )

设置将在后续渲染进度中使用的裁剪矩形

参数

[in] clip_rect 裁剪矩形。如果为 null，表示在后续渲染进度中不使用裁剪矩形。

返回: 无。

◆ SetColorMode()

FSDK::Renderer::SetColorMode ( color_mode )

设置颜色模式。

如果不调用此函数，将使用默认值 FSDK.Renderer.e_ColorModeNormal。

参数

[in]

color_mode

颜色模式值。它应该是以下值之一：

FSDK.Renderer.e_ColorModeNormal 表示正常颜色模式。
FSDK.Renderer.e_ColorModeMappingGray 表示将白色/黑色颜色值映射到背景/前景；对于其他颜色，不改变。如果使用此模式，请调用函数 FSDK.Renderer.SetMappingModeColors 来设置"背景颜色"和 "前景颜色"。
FSDK.Renderer.e_ColorModeMapping 表示将颜色值映射到由背景颜色和前景颜色定义的颜色范围。如果使用此模式，请调用函数 FSDK.Renderer.SetMappingModeColors 来设置"背景颜色"和 "前景颜色"。

返回: 无。

◆ SetForceDownSample()

FSDK::Renderer::SetForceDownSample ( is_to_force_down_sample )

设置标志以决定是否对图像拉伸使用降采样。

如果不调用此函数，将使用默认值 false。

参数

[in] is_to_force_down_sample true 表示对图像拉伸使用降采样。 false 表示不对图像拉伸使用降采样。

返回: 无。

◆ SetForceHalftone()

FSDK::Renderer::SetForceHalftone ( is_to_force_halftone )

设置标志以决定是否对图像拉伸使用半色调。

如果不调用此函数，将使用默认值 false。

参数

[in] is_to_force_halftone true 表示对图像拉伸使用半色调。 false 表示不对图像拉伸使用半色调。

返回: 无。

◆ SetForegroundColor()

FSDK::Renderer::SetForegroundColor ( foreground_color )

当颜色模式为 FSDK.Renderer.e_ColorModeForeground 时设置文本、路径或两者的前景颜色。

文本、路径或两者的前景颜色由函数 FSDK.Renderer.SetForegroundColorMode 设置的前景颜色模式决定。

参数

[in] foreground_color 文本、路径或两者的前景颜色。格式：0xAARRGGBB。

返回: 无。

◆ SetForegroundColorMode()

FSDK::Renderer::SetForegroundColorMode ( foreground_color_mode )

当颜色模式为 FSDK.Renderer.e_ColorModeForeground 时设置渲染前景颜色模式。

如果不调用此函数，将使用默认值 (FSDK.Renderer.e_ColorModeForegroundText | FSDK.Renderer.e_ColorModeForegroundPath | FSDK.Renderer.e_ColorModeForegroundBlackText | FSDK.Renderer.e_ColorModeForegroundBlackPath)。

参数

[in] foreground_color_mode 渲染前景颜色模式。请参考从 FSDK.Renderer.e_ColorModeForegroundText 开始的值，这应该是其中一个或这些值的组合。

返回: 无。

◆ SetJPEGDownSample()

FSDK::Renderer::SetJPEGDownSample ( is_jepg_down_sample )

设置标志以决定是否对 jpeg 图像使用降采样。

是否对 jpeg 图像使用降采样将影响 PDF 页面的渲染结果。当成功调用当前函数时，用户应在再次渲染 PDF 页面之前为 PDF 页面（已至少渲染一次）调用函数 FSDK.PDFPage.ClearRenderCache。
如果不调用此函数，将使用默认值 true。

参数

[in] is_jepg_down_sample true 表示对 jpeg 图像使用降采样。 false 表示不对 jpeg 图像使用降采样。

返回: 无。

◆ SetJPXDownSample()

FSDK::Renderer::SetJPXDownSample ( is_jpx_down_sample )

设置标志以决定是否对 jpx 图像使用降采样。

是否对 jpx 图像使用降采样将影响 PDF 页面的渲染结果。当成功调用当前函数时，用户应在再次渲染 PDF 页面之前为 PDF 页面（已至少渲染一次）调用函数 FSDK.PDFPage.ClearRenderCache。
如果不调用此函数，将使用默认值 true。

参数

[in] is_jpx_down_sample true 表示对 jpx 图像使用降采样。 false 表示不对 jpx 图像使用降采样。

返回: 无。

◆ SetLayerContext()

FSDK::Renderer::SetLayerContext ( layer_context )

将图层上下文设置到渲染上下文句柄。

为了在渲染上下文上渲染 PDF 页面的内容时渲染一个图层，用户应调用此函数将图层上下文设置到渲染上下文。

参数

[in] layer_context 图层上下文对象。

返回: 无。

◆ SetMappingModeColors()

FSDK::Renderer::SetMappingModeColors	(	background_color	,
		foreground_color
	)

当颜色模式为 FSDK.Renderer.e_ColorModeMappingGray 或 FSDK.Renderer.e_ColorModeMapping 时设置背景颜色和前景颜色。

参数

[in]	background_color	背景颜色。格式：0xAARRGGBB。
[in]	foreground_color	前景颜色。格式：0xAARRGGBB。

返回: 无。

◆ SetOverprint()

FSDK::Renderer::SetOverprint ( is_to_enable_overprint )

设置标志以决定是否启用叠印。

参数

[in] is_to_enable_overprint true 表示启用叠印。 false 表示不启用叠印。默认值：false。

返回: 无。

◆ SetPrintTextAsGraphic()

FSDK::Renderer::SetPrintTextAsGraphic ( is_to_print_text_graphic )

设置标志以决定是否将文本打印为路径或位图。

当此标志为 true 时，Foxit PDF SDK 将以不同的方式渲染文本：如果字体大小大于 50，则将文本打印为路径；否则，将文本打印为位图。
如果不调用此函数，将使用默认值 false。

参数

[in] is_to_print_text_graphic true 表示将文本打印为路径或位图。 false 表示不将文本打印为路径或位图。

返回: 无。

◆ SetPrintTextAsImage()

FSDK::Renderer::SetPrintTextAsImage ( is_to_print_text_image )

设置标志以决定是否将文本打印为图像。

如果不调用此函数，将使用默认值 false。

参数

[in] is_to_print_text_image true 表示将文本打印为图像。 false 表示不将文本打印为图像。

返回: 无。

◆ SetRenderAnnotAppearanceType()

FSDK::Renderer::SetRenderAnnotAppearanceType ( ap_type )

设置用于渲染的注释外观类型。

参数

[in] ap_type 注释外观的类型。请参考从 FSDK.Annot.e_AppearanceTypeNormal 开始的值，这应该是其中之一。

返回: 无。

◆ SetRenderAnnotsForThumbnail()

FSDK::Renderer::SetRenderAnnotsForThumbnail ( is_render_annots_for_thumbnail )

设置渲染标志以决定是否以缩略图模式渲染注释。

在缩略图模式下，注释的标志"NoZoom"和"NoRotate"将被忽略。此渲染标志仅在使用标志 FSDK.Renderer.e_RenderAnnot 进行渲染或调用函数 FSDK.Renderer.RenderAnnot 时可用。请参考函数 FSDK.Renderer.SetRenderContentFlags 关于设置标志 FSDK.Renderer.e_RenderAnnot。
如果不调用此函数，当此渲染标志可用时，将使用默认值 false。

参数

[in] is_render_annots_for_thumbnail true 表示以缩略图模式渲染注释。 false 表示不以缩略图模式渲染注释。

返回: 无。

◆ SetRenderContentFlags()

FSDK::Renderer::SetRenderContentFlags ( render_content_flags )

设置渲染标志以决定将渲染什么内容。

如果不调用此函数，将使用默认值 (FSDK.Renderer.e_RenderPage | FSDK.Renderer.e_RenderAnnot)。

参数

[in] render_content_flags 渲染内容标志。请参考从 FSDK.Renderer.e_RenderPage 开始的值，这应该是其中一个或这些值的组合。

返回: 无。

◆ SetRenderEnhanceThinLines()

FSDK::Renderer::SetRenderEnhanceThinLines ( is_render_enhance_thin_lines )

设置标志以决定是否增强细线。

如果不调用此函数，将使用默认值 false。

参数

[in] is_render_enhance_thin_lines true 表示用更粗的路径绘制零宽度线，使它们比默认的单像素更可见。
false 表示用单像素宽度绘制零宽度线。

返回: 无。

◆ SetRenderFormField()

FSDK::Renderer::SetRenderFormField ( is_render_formfield )

设置标志以决定是否渲染表单域（签名域除外）。

如果不调用此函数，当此标志可用时，将使用默认值 true。

参数

[in] is_render_formfield true 表示渲染表单域（签名域除外）。 false 表示不渲染表单域（签名域除外）。

返回: 无。

◆ SetRenderImageAntiAliasing()

FSDK::Renderer::SetRenderImageAntiAliasing ( is_render_image_antialiasing )

设置标志以决定是否绘制图像抗锯齿。

如果不调用此函数，将使用默认值 true。

参数

[in] is_render_image_antialiasing true 表示绘制图像抗锯齿，效果将类似于枚举类 InterpolationFlag 中定义的值。 false 表示绘制图像锯齿。

返回: 无。

◆ SetRenderLayer()

FSDK::Renderer::SetRenderLayer ( is_render_one_layer )

设置标志以决定是渲染一个图层还是所有可用图层。

如果不调用此函数，当此标志可用时，将使用默认值 true。

参数

[in] is_render_one_layer true 表示渲染一个图层。 false 表示渲染所有可用图层。

返回: 无。

◆ SetRenderPathAntiAliasing()

FSDK::Renderer::SetRenderPathAntiAliasing ( is_render_path_antialiasing )

设置标志以决定是否绘制路径抗锯齿。

如果不调用此函数，将使用默认值 true。

参数

[in] is_render_path_antialiasing true 表示绘制路径抗锯齿。 false 表示绘制路径锯齿。

返回: 无。

◆ SetRenderPathFullCovered()

FSDK::Renderer::SetRenderPathFullCovered ( is_render_path_full_covered )

可应用于填充模式的特殊标志。

如果不调用此函数，将使用默认值 false。

参数

[in] is_render_path_full_covered true 表示路径部分覆盖的所有像素将被完全绘制，而 false 表示不会。

返回: 无。

◆ SetRenderPathThinLine()

FSDK::Renderer::SetRenderPathThinLine ( is_render_path_thin_line )

设置标志以决定是否将路径绘制为细线。

如果不调用此函数，将使用默认值 false。

参数

[in] is_render_path_thin_line true 表示将路径绘制为细线。 false 表示不将路径绘制为细线。

返回: 无。

◆ SetRenderSignature()

FSDK::Renderer::SetRenderSignature ( is_render_signature )

设置标志以决定是否渲染签名。

如果不调用此函数，当此标志可用时，将使用默认值 true。

参数

[in] is_render_signature true 表示渲染签名。 false 表示不渲染签名。

返回: 无。

◆ SetRenderSignatureState()

FSDK::Renderer::SetRenderSignatureState ( is_render_signature_state )

设置标志以决定是否在签名上绘制签名状态。

如果不调用此函数，将使用默认值 true。

参数

[in] is_render_signature_state true 表示在签名上绘制签名状态，而 false 表示不绘制。

◆ SetRenderTextAntiAliasing()

FSDK::Renderer::SetRenderTextAntiAliasing ( is_render_text_antialiasing )

设置标志以决定是否绘制文本抗锯齿。

如果不调用此函数，将使用默认值 true。

参数

[in] is_render_text_antialiasing true 表示绘制文本抗锯齿。 false 表示绘制文本锯齿。

返回: 无。

◆ SetScreenDPIScale()

FSDK::Renderer::SetScreenDPIScale ( scale )

设置用于渲染的屏幕 DPI 缩放因子

设置屏幕 DPI 缩放比例以适应不同的 DPI 条件。此值通常应与系统报告的缩放因子匹配（例如，显示设置中 125% 缩放为 1.25），以确保与物理显示特性正确对齐的渲染。

参数

[in] scale 当前屏幕 DPI 的比例（1.0 = 100% 原生 DPI，2.0 = 200，等等）。必须大于 0，并且通常应与系统推荐的缩放因子相对应。默认值：非 Android 平台为 1.0f，Android 平台为 2.5f。

注解: 目前，此屏幕 DPI 缩放因子仅影响注释。

返回: 无。

◆ StartQuickRender()

FSDK::Renderer::StartQuickRender	(	page	,
		matrix	,
		pause
	)

开始快速渲染 PDF 页面，主要用于缩略图目的。

此函数主要用于渲染页面以生成缩略图。渲染的内容将不完整：所有注释都将被忽略，即使通过函数 FSDK.Renderer.SetRenderContentFlags 设置了标志 FSDK.Renderer.e_RenderAnnot；文本内容将变得模糊并将被像素点替换。
当页面具有复杂或大量内容时，执行此快速渲染仍可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。

参数

[in]	page	有效的 PDF 页面。它应已被解析。
[in]	matrix	用于渲染的变换矩阵，通常由函数 FSDK.PDFPage.GetDisplayMatrix 返回。
[in]	pause	暂停回调对象，用于决定渲染过程是否需要暂停。这可以是 null，表示在渲染过程中不暂停。如果不是 null，它应该是由用户实现的有效暂停对象。默认值：null。

返回: 渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 以继续进度，直到进度完成。

◆ StartRender()

FSDK::Renderer::StartRender	(	page	,
		matrix	,
		pause
	)

开始渲染 PDF 页面。

渲染具有复杂或大量内容的 PDF 页面可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。
在 Foxit PDF SDK 中，小部件注释始终与表单域和表单控件关联。对于如何渲染小部件注释，建议的流程如下：

加载 PDF 页面后，首先渲染该页面中的页面和所有注释（包括小部件注释）。
然后，如果用户使用 FSDK.Filler 对象填充表单，用户应使用函数 FSDK.Filler.Render 来渲染聚焦的表单控件，而不是使用函数 FSDK.Renderer.RenderAnnot。

参数

[in]	page	有效的 PDF 页面。如果仅渲染注释（即仅通过函数 FSDK.Renderer.SetRenderContentFlags 设置了 FSDK.Renderer.e_RenderAnnot），则无需解析输入页面；否则输入页面应已被解析。
[in]	matrix	用于渲染的变换矩阵，通常由函数 FSDK.PDFPage.GetDisplayMatrix 返回。
[in]	pause	暂停回调对象，用于决定渲染过程是否需要暂停。这可以是 null，表示在渲染过程中不暂停。如果不是 null，它应该是由用户实现的有效暂停对象。默认值：null。

返回: 渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 以继续进度，直到进度完成。

◆ StartRenderBitmap() [1/2]

FSDK::Renderer::StartRenderBitmap	(	bitmap	,
		matrix	,
		clip_rect	,
		interpolation	,
		alpha	,
		pause
	)

开始渲染位图。

渲染具有复杂或大量内容的位图可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。

参数

[in]	bitmap	有效的位图。用户应确保位图保持有效，直到当前渲染过程完成。
[in]	matrix	用于渲染的变换矩阵。此矩阵用作图像矩阵：假设 h 是图像高度，w 是图像宽度，则矩阵 [w 0 0 h 0 0] 将生成相同的图像。
[in]	clip_rect	渲染设备的裁剪矩形。这可以是 NULL。
[in]	interpolation	位图插值标志。请参考从 FSDK.Bitmap.e_Downsample 开始的值，这可以是其中一个或这些值的组合。如果不指定任何标志，请使用 0。
[in]	alpha	位图 alpha 表示透明度（0 = 完全透明，255 = 完全不透明）。有效范围：从 0 到 255。
[in]	pause	暂停回调对象，用于决定渲染过程是否需要暂停。这可以是 NULL，表示在渲染过程中不暂停。如果不是 NULL，它应该是由用户实现的有效暂停对象。

返回: 渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 以继续进度，直到进度完成。

◆ StartRenderBitmap() [2/2]

FSDK::Renderer::StartRenderBitmap	(	bitmap	,
		matrix	,
		clip_rect	,
		interpolation	,
		pause
	)

开始渲染位图。

渲染具有复杂或大量内容的位图可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。

参数

[in]	bitmap	有效的位图。用户应确保位图保持有效，直到当前渲染过程完成。
[in]	matrix	用于渲染的变换矩阵。此矩阵用作图像矩阵：假设 h 是图像高度，w 是图像宽度，则矩阵 [w 0 0 h 0 0] 将生成相同的图像。
[in]	clip_rect	渲染设备的裁剪矩形。这可以是 null。默认值：null。
[in]	interpolation	位图插值标志。请参考从 FSDK.Bitmap.e_Downsample 开始的值，这可以是其中一个或这些值的组合。如果不指定任何标志，请使用 0。默认值：0。
[in]	pause	暂停回调对象，用于决定渲染过程是否需要暂停。这可以是 null，表示在渲染过程中不暂停。如果不是 null，它应该是由用户实现的有效暂停对象。默认值：null。

返回: 渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 以继续进度，直到进度完成。

◆ StartRenderReflowPage()

FSDK::Renderer::StartRenderReflowPage	(	reflow_page	,
		matrix	,
		pause
	)

开始渲染重排页面。

渲染具有复杂或大量内容的重排页面可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。

参数

[in]	reflow_page	有效的重排页面。它应已被解析。
[in]	matrix	用于渲染的变换矩阵，通常由函数 FSDK.ReflowPage.GetDisplayMatrix 返回。
[in]	pause	暂停回调对象，用于决定渲染过程是否需要暂停。这可以是 null，表示在渲染过程中不暂停。如果不是 null，它应该是由用户实现的有效暂停对象。默认值：null。

返回: 渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 以继续进度，直到进度完成。

◆ StartRenderXFAPage()

FSDK::Renderer::StartRenderXFAPage	(	xfa_page_view	,
		matrix	,
		is_highlight	,
		pause
	)

开始渲染 XFA 页面。

渲染具有复杂或大量内容的 XFA 页面将需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。

参数

[in]	xfa_page_view	有效的 XFA 页面。
[in]	matrix	用于渲染的变换矩阵，通常由函数 FSDK.XFAPage.GetDisplayMatrix 返回。
[in]	is_highlight	true 表示高亮显示 XFA 小部件，false 表示不高亮显示 XFA 小部件。
[in]	pause	暂停回调对象，用于决定渲染过程是否需要暂停。这可以是 null，表示在渲染过程中不暂停。如果不是 null，它应该是由用户实现的有效暂停对象。默认值：null。

返回: 渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 以继续进度，直到进度完成。

类成员变量说明

◆ e_ColorModeNormal

FSDK::Renderer::e_ColorModeNormal

static

渲染颜色模式的枚举。

此枚举的值应单独使用。

正常颜色模式。

◆ e_RenderPage

FSDK::Renderer::e_RenderPage

渲染内容标志的枚举。

此枚举的值可以单独使用或组合使用。

如果设置，将渲染页面内容。

Public 成员函数

Public 属性

静态 Public 属性

详细描述

成员函数说明

◆ ClearClips()

◆ constructor()

◆ EnableForPrint()

◆ IsEmpty()

◆ RenderAnnot()

◆ RenderFormControls()

◆ RenderGraphicsObject()

◆ SetClearType()

◆ SetClipPathFill()

◆ SetClipPathStroke()

◆ SetClipRect()

◆ SetColorMode()

◆ SetForceDownSample()

◆ SetForceHalftone()

◆ SetForegroundColor()

◆ SetForegroundColorMode()

◆ SetJPEGDownSample()

◆ SetJPXDownSample()

◆ SetLayerContext()

◆ SetMappingModeColors()

◆ SetOverprint()

◆ SetPrintTextAsGraphic()

◆ SetPrintTextAsImage()

◆ SetRenderAnnotAppearanceType()

◆ SetRenderAnnotsForThumbnail()

◆ SetRenderContentFlags()

◆ SetRenderEnhanceThinLines()

◆ SetRenderFormField()

◆ SetRenderImageAntiAliasing()

◆ SetRenderLayer()

◆ SetRenderPathAntiAliasing()

◆ SetRenderPathFullCovered()

◆ SetRenderPathThinLine()

◆ SetRenderSignature()

◆ SetRenderSignatureState()

◆ SetRenderTextAntiAliasing()

◆ SetScreenDPIScale()

◆ StartQuickRender()

◆ StartRender()

◆ StartRenderBitmap() [1/2]

◆ StartRenderBitmap() [2/2]

◆ StartRenderReflowPage()

◆ StartRenderXFAPage()

类成员变量说明

◆ e_ColorModeNormal

◆ e_RenderPage