fs_renderer_r.h File Reference

Header file for Renderer module of Foxit PDF SDK. More...

Go to the source code of this file.

Classes

struct  FSCRT_RENDERER
 Handle type for a renderer. More...
 

Macros

Macros Definitions for renderer flags
Note
Pass one or a combination of following flags to the function FSCRT_Renderer_SetFlags.
#define FSCRT_RENDERERFLAG_LCDTEXT   0x01
 Set if it needs text rendering optimization for LCD display.
 
#define FSCRT_RENDERERFLAG_BGRSTRIPE   0x02
 Set if device is using BGR LCD stripe.
 
#define FSCRT_RENDERERFLAG_USEANTIALIAS   0x04
 Use anti-aliasing to render graphics objects.
 
#define FSCRT_RENDERERFLAG_GRAYSCALE   0x08
 Gray scale output.
 
#define FSCRT_RENDERERFLAG_NONATIVETEXT   0x10
 Disable native text rendering feature (like GDI+, CGContext).
 
#define FSCRT_RENDERERFLAG_TEXTGAMMA   0x20
 Enable gamma to support to display small characters.
 
Macros Definitions for render blend mode
#define FSCRT_RENDERERBLEND_NORMAL   0
 Selecting source color and ignoring backdrop color. More...
 
#define FSCRT_RENDERERBLEND_MULTIPLY   1
 Multiply backdrop by source color values. More...
 
#define FSCRT_RENDERERBLEND_SCREEN   2
 Multiply complements of backdrop by source color values, and then complement the result. More...
 
#define FSCRT_RENDERERBLEND_OVERLAY   3
 Multiply or screens colors, depending on backdrop color value. More...
 
#define FSCRT_RENDERERBLEND_DARKEN   4
 Select darker one of backdrop and source colors. More...
 
#define FSCRT_RENDERERBLEND_LIGHTEN   5
 Select lighter one of backdrop and source colors. More...
 
#define FSCRT_RENDERERBLEND_COLORDODGE   6
 Brightens backdrop color to reflect source colors. More...
 
#define FSCRT_RENDERERBLEND_COLORBURN   7
 Darkens backdrop color to reflect the source color. More...
 
#define FSCRT_RENDERERBLEND_HARDLIGHT   8
 Multiply or screens colors, depending on source color value. More...
 
#define FSCRT_RENDERERBLEND_SOFTLIGHT   9
 Darkens or lightens colors, depending on source color value. More...
 
#define FSCRT_RENDERERBLEND_DIFFERENCE   10
 Subtracts the darker of the two constituent colors from lighter colors. More...
 
#define FSCRT_RENDERERBLEND_EXCLUSION   11
 Produces an effect similar to that of different modes but lower in contrast. More...
 
#define FSCRT_RENDERERBLEND_HUE   21
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color. More...
 
#define FSCRT_RENDERERBLEND_SATURATION   22
 Creates a color with the saturation of the source color, and the hue and luminosity of the backdrop color. More...
 
#define FSCRT_RENDERERBLEND_COLOR   23
 Creates a color with the hue and saturation of the source color, and the luminosity of the backdrop color. More...
 
#define FSCRT_RENDERERBLEND_LUMINOSITY   24
 Creates a color with the luminosity of the source color, and the hue and saturation of the backdrop color. More...
 
Macro Definitions for Line Cap Styles
#define FSCRT_LINECAP_BUTT   0
 The Butt Line Cap Type. More...
 
#define FSCRT_LINECAP_ROUND   1
 The Round Line Cap Type. More...
 
#define FSCRT_LINECAP_SQUARE   2
 The Projecting Square Line Cap Type. More...
 
Macro Definitions for Line Join Styles
#define FSCRT_LINEJOIN_MITER   0
 Miter line join type. More...
 
#define FSCRT_LINEJOIN_ROUND   1
 Round line join type. More...
 
#define FSCRT_LINEJOIN_BEVEL   2
 Bevel line join type. More...
 

Functions

FS_RESULT FSCRT_Renderer_CreateOnBitmap (FSCRT_BITMAP bitmap, FSCRT_RENDERER *renderer)
 Create a renderer on a bitmap object. More...
 
FS_RESULT FSCRT_Renderer_Release (FSCRT_RENDERER renderer)
 Release a given renderer object. More...
 
FS_RESULT FSCRT_Renderer_SetFlags (FSCRT_RENDERER renderer, FS_DWORD flags)
 Set flags of a renderer. More...
 
FS_RESULT FSCRT_Renderer_SetDitherBits (FSCRT_RENDERER renderer, FS_INT32 bits)
 Set bitmap dither bits of a renderer, support for 8bpp bitmap device. More...
 
FS_RESULT FSCRT_Renderer_SetGamma (FS_FLOAT gamma)
 Set gamma value for text rendering. More...
 
FS_RESULT FSCRT_Renderer_SetClipRect (FSCRT_RENDERER renderer, const FSCRT_RECT *clipRect)
 Set the current clipping rectangle into a renderer. More...
 
FS_RESULT FSCRT_Renderer_DrawBitmap (FSCRT_RENDERER renderer, FS_INT32 dstLeft, FS_INT32 dstTop, FSCRT_BITMAP srcBitmap, const FSCRT_RECT *srcRect)
 Render a bitmap object. More...
 

Detailed Description

Header file for Renderer module of Foxit PDF SDK.

Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. It is not allowed to distribute any parts of Foxit PDF SDK to any third parties or general public, unless there is a license agreement between Foxit Software Inc. and customers.

This header file defines a rendering engine.
It contains:

  • 1. Base definitions for a rendering engine.
  • 2. Create or release a rendering engine.
  • 3. Set properties of a rendering engine.
Note
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Standard module explicitly.

Foxit Corporation