API reference

Rendering & Viewer

130 functions. Every declaration on the detail pages is extracted from the shipped bindings.

Content Creation

pdfAddRenderingIntent Despite the source's own section-header comment marking
pdfAddRenderingIntentEx Despite the source's own section-header comment marking

Core

pdfRenderAnnotOrField Render a single annotation's (or field's) widget bounding
pdfRenderPage Render the active document page into a caller-supplied
pdfRenderPageEx Render the active document page into a caller-supplied
pdfRenderPageToImage Render one page of the currently open document directly
pdfRenderPDFFile Render the currently open *import* file (opened via
pdfRenderPDFFileEx Render the currently open *import* file (opened via
pdfSelectedRenderer Nominally: choose which internal renderer implementation
pdfSelectRenderer Nominally: choose which internal renderer implementation

Getters

pdfGetRenderScale Nominally: choose which internal renderer implementation

Misc

psrGetRenderingIntent pdfSetRenderingIntent sets the document's (and
psrSetRenderingIntent pdfSetRenderingIntent sets the document's (and
vwrShowFile The complete, self-contained standalone PDF viewer window

Rasterizer/Rendering

rasAbort Three abort granularities: a single IRAS rasterizer, all
rasAbortInvisible Three abort granularities: a single IRAS rasterizer, all
rasAbortTile Three abort granularities: a single IRAS rasterizer, all
rasAppend Append a page slot to the cache's tracked page count.
rasAttachImageBuffer Re-point an existing IRAS rasterizer at a different
rasCalcMaxima Precompute the widest/tallest page size (MaxPageW/
rasCalcPagePixelSize Two independent, standalone page-size calculators that
rasChangeBackColor Three real paint-configuration setters: the viewport
rasChangeCursor Explicitly set the cache's stored cursor shape (the
rasClearSelection Clear the current marquee/object selection without
rasClientToPage Two independent device-pixel → PDF-user-space coordinate
rasCloseFile rasCloseFile resets the cache's view state (not the
rasCopyToClipBoard Real, substantial text-selection functionality: extract
rasCreateAnnotFromControl rasCreateControl registers a UI control descriptor on
rasCreateControl rasCreateControl registers a UI control descriptor on
rasCreatePageCache Create the interactive page-cache object (IPGC) that
rasCreatePageCacheV3 Create the interactive page-cache object (IPGC) that
rasCreateRasterizer Create a single-buffer software rasterizer (IRAS) over
rasCreateRasterizerEx Create a single-buffer software rasterizer (IRAS) over
rasDeletePage Reorder or delete pages in the underlying document
rasDeletePageCache Create the interactive page-cache object (IPGC) that
rasDeleteRasterizer Create a single-buffer software rasterizer (IRAS) over
rasExchangePages Reorder or delete pages in the underlying document
rasExecAction Nominally: execute a PDF action (rasExecAction) or
rasExecBookmark Nominally: execute a PDF action (rasExecAction) or
rasGetBaseControlSize Get/set the cache's "base control size" — the reference
rasGetCurrPage Get/set the page cache's current page (the authoritative
rasGetCurrTile rasCloseFile resets the cache's view state (not the
rasGetCurrZoom Get/set the page cache's zoom factor.
rasGetDefPageLayout Get/set the cache's active page layout (single-page vs.
rasGetObjTypeAt Real, working object hit-testing and selection — the
rasGetObjTypeAtV3 Real, working object hit-testing and selection — the
rasGetOption A generic, extensible per-cache integer option bag,
rasGetPageAt Hit-test a viewport device point against the cache's
rasGetPageInfo Report a page's rendered pixel/logical geometry at the
rasGetPageLayout Get/set the cache's active page layout (single-page vs.
rasGetPageMatrix Nominally: resolve the page-to-device transform matrix for
rasGetPagePos Resolve a specific page's top-left position in the
rasGetPageScale Get/set the cache's fit-mode (psFitWidth/psFitHeight/
rasGetRasInfo rasCloseFile resets the cache's view state (not the
rasGetRotate Get/set the cache's view rotation (on top of, not
rasGetScrollLineDelta The classic Win32 scrollbar-model quintet: current
rasGetScrollPos The classic Win32 scrollbar-model quintet: current
rasGetScrollRange The classic Win32 scrollbar-model quintet: current
rasGetSelectedText Real, substantial text-selection functionality: extract
rasGetSelectionMode Select the entire current page (rasSelectAll), and
rasGetSelectionPath Query whether a selection exists, and whether it has
rasGetSelRect Report the current marquee/text-selection rectangle, in
rasGetSelRectPDF Report the current marquee/text-selection rectangle, in
rasGetWidthHeight Two independent, standalone page-size calculators that
rasHaveSelectedText Query whether a selection exists, and whether it has
rasHaveSelection Query whether a selection exists, and whether it has
rasHighlightText Real, substantial text-selection functionality: extract
rasInitBaseObjects Size the page-cache's viewport and compute its initial
rasInitBaseObjectsV3 Size the page-cache's viewport and compute its initial
rasInitColorManagement Enable viewer-side color management on the page cache.
rasInitialize Nominally: initialize the page cache's background
rasInitMainTile Attach the caller's "main tile" pixel buffer to the page
rasIsBusy Report whether the page cache's background render/update
rasKeyStroke Keyboard input for the viewer — real, narrow behavior:
rasLock Nominally two independent locking mechanisms — a general
rasLockTileBuffer Nominally two independent locking mechanisms — a general
rasMouseDblClick Nominally: object-hit-testing-aware mouse handlers that
rasMouseDblClickV3 Nominally: object-hit-testing-aware mouse handlers that
rasMouseDown The real, working mouse-drag pipeline for
rasMouseDown2 Nominally: object-hit-testing-aware mouse handlers that
rasMouseDown3 Nominally: object-hit-testing-aware mouse handlers that
rasMouseMove The real, working mouse-drag pipeline for
rasMouseMove2 Nominally: object-hit-testing-aware mouse handlers that
rasMouseMove3 Nominally: object-hit-testing-aware mouse handlers that
rasMouseUp The real, working mouse-drag pipeline for
rasMouseUp2 Nominally: object-hit-testing-aware mouse handlers that
rasMouseUp3 Nominally: object-hit-testing-aware mouse handlers that
rasMovePage Reorder or delete pages in the underlying document
rasPaint The real, complete interactive paint routine — clamps
rasPixToPDF Two independent device-pixel → PDF-user-space coordinate
rasPrefetchPage Pre-render a page into the cache's bitmap cache ahead of
rasProcessErrors rasCloseFile resets the cache's view state (not the
rasRedraw Blit an already-rendered IRAS rasterizer's buffer to a
rasRenderTile Render one tile of a page directly into the cache's "main
rasResetMousePos Cancel any in-progress mouse drag/selection tracking and
rasResize rasResize/rasResizeViewport resize an IPGC page
rasResizeBitmap rasResize/rasResizeViewport resize an IPGC page
rasResizeViewport rasResize/rasResizeViewport resize an IPGC page
rasScroll The classic Win32 scrollbar-model quintet: current
rasSelectAll Select the entire current page (rasSelectAll), and
rasSelectAnnotOrField Select a specific annotation or field by handle
rasSelectObject Real, working object hit-testing and selection — the
rasSelectObjectV3 Real, working object hit-testing and selection — the
rasSetAsyncPaint Turn background rasterisation on or off for a page cache,
rasSetBaseControlSize Get/set the cache's "base control size" — the reference
rasSetClientRect Resize the page cache's viewport from a client rectangle.
rasSetCMapDir Nominally: point the rasterizer/viewer at an external CJK
rasSetCurrPage Get/set the page cache's current page (the authoritative
rasSetDefPageLayout Get/set the cache's active page layout (single-page vs.
rasSetMinLineWidth Minimum stroke line width — genuinely two separate
rasSetMinLineWidth2 Minimum stroke line width — genuinely two separate
rasSetOCGState Three real paint-configuration setters: the viewport
rasSetOnPaintCallback Three real paint-configuration setters: the viewport
rasSetOption A generic, extensible per-cache integer option bag,
rasSetPageLayout Get/set the cache's active page layout (single-page vs.
rasSetPageScale Get/set the cache's fit-mode (psFitWidth/psFitHeight/
rasSetRotate Get/set the cache's view rotation (on top of, not
rasSetScreenRes Minimum stroke line width — genuinely two separate
rasSetScrollLineDelta The classic Win32 scrollbar-model quintet: current
rasSetSelectionMode Select the entire current page (rasSelectAll), and
rasSetThreadPriority Store the cache's update/render background-thread
rasSetWindowHandle Store the cache's update/render background-thread
rasUnLock Nominally two independent locking mechanisms — a general
rasUnLockTileBuffer Nominally two independent locking mechanisms — a general
rasUpdate Request a repaint — optionally switching the current page
rasZoom Get/set the page cache's zoom factor.

Setters

pdfSetRenderDCErasePage Nominally: choose which internal renderer implementation
pdfSetRenderDCOffset Nominally: choose which internal renderer implementation
pdfSetRenderingIntent pdfSetRenderingIntent sets the document's (and
pdfSetSoftGlyphRendering Toggle whether the the engine software