Foxit PDF SDK
fsdk.RenderConfig Class Reference

Public Member Functions

def GetGraphics_objs_count_in_one_step ()
 Get the count of graphics objects to be rendered in one step during progressive rendering process. More...
 
def Set (graphics_objs_count_in_one_step)
 Set value.
More...
 
def SetGraphics_objs_count_in_one_step (value)
 Set the count of graphics objects to be rendered in one step during progressive rendering process. More...
 

Detailed Description

This class represents rendering configuration which is a global configuration. This configuration can be retrieved by function fsdk.LibraryGetRenderConfig and be set by function fsdk.LibrarySetRenderConfig .

Member Function Documentation

◆ GetGraphics_objs_count_in_one_step()

fsdk.RenderConfig.GetGraphics_objs_count_in_one_step ( )

Get the count of graphics objects to be rendered in one step during progressive rendering process.

In Foxit PDF SDK, rendering process can be progressive – that means the rendering process will be separated into many steps and during each step a certain count of graphics objects will be rendered. When one step is finished, Foxit PDF SDK will check and ask user whether current process needs to be paused or not (if a is used for the process of fsdk.Renderer.StartRender ). This certain count is just used as a suggestion for Foxit PDF SDK to decide when to check during progressive rendering process, but cannot fully control the number of steps in a progressive rendering process. For example, when a form XObject or a shading object is to be rendered, Foxit PDF SDK will ask user whether current process needs to be paused or not, without considering this count.

Returns
The count of graphics objects to be rendered in one step during progressive rendering process. This should be a positive value.

◆ Set()

def fsdk.RenderConfig.Set (   graphics_objs_count_in_one_step)

Set value.

Parameters
[in]graphics_objs_count_in_one_stepThe count of graphics objects to be rendered in one step during progressive rendering process. This should be a positive value.

@ return None.

◆ SetGraphics_objs_count_in_one_step()

fsdk.RenderConfig.SetGraphics_objs_count_in_one_step (   value)

Set the count of graphics objects to be rendered in one step during progressive rendering process.

In Foxit PDF SDK, rendering process can be progressive – that means the rendering process will be separated into many steps and during each step a certain count of graphics objects will be rendered. When one step is finished, Foxit PDF SDK will check and ask user whether current process needs to be paused or not (if a is used for the process of fsdk.Renderer.StartRender ). This certain count is just used as a suggestion for Foxit PDF SDK to decide when to check during progressive rendering process, but cannot fully control the number of steps in a progressive rendering process. For example, when a form XObject or a shading object is to be rendered, Foxit PDF SDK will ask user whether current process needs to be paused or not, without considering this count.

Parameters
[in]valueThe count of graphics objects to be rendered in one step during progressive rendering process. This should be a positive value.
Returns
None.