API reference

Images

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

Core

pdfCloseImage Close/clear the staged image slot left by pdfCreateImage
pdfEnableImageCache Configure a document-level image-decode cache size limit
pdfFreeImageBuffer Return the raw encoded/decoded byte buffer of the
pdfFreeImageObj Release the transient, shared read-back buffer populated
pdfFreeImageObjEx Mint a standalone, independently-lifetimed image object
pdfInsertRawImage Insert an image directly from already-decoded raw pixel data
pdfInsertRawImageEx Insert an image directly from already-decoded raw pixel data
pdfOCRImage Run OCR (via the external OCR engine configured by
pdfOCRImageToPDF Run OCR (via the external OCR engine configured by
pdfPlaceImage Place an already-registered image (from pdfCreateImage, or
pdfReadImageResolution Read the embedded DPI (dots-per-inch) resolution metadata of
pdfReadImageResolutionEx Read the embedded DPI (dots-per-inch) resolution metadata of
pdfReplaceImage Swap out an already-inserted image's underlying pixel data
pdfReplaceImageEx Swap out an already-inserted image's underlying pixel data
pdfReverseImage Vertically flip (mirror top-to-bottom) the pixel data of the
pdfSaveImageListItemDataToFile Write a specific, directly-addressed image (by index) to
pdfSaveImageToFile Write the currently selected image's (via pdfSelectImage,
pdfSaveImageToString Write the currently selected image's (via pdfSelectImage,
pdfSelectedImage Set/get a document-level "currently selected image" cursor —
pdfSelectImage Set/get a document-level "currently selected image" cursor —

Getters

pdfGetImageBuffer Return the raw encoded/decoded byte buffer of the
pdfGetImageCount Count the number of embedded images inside an arbitrary
pdfGetImageCountEx Count the number of embedded images inside an arbitrary
pdfGetImageHandle Resolve a PIMG standalone object handle back to its
pdfGetImageHeight Return an image's native pixel dimensions by document handle.
pdfGetImageObj Read an image's full metadata and pixel/compressed byte
pdfGetImageObjCount Return the total number of images registered in the current
pdfGetImageObjEx Read an image's full metadata and pixel/compressed byte
pdfGetImageWidth Return an image's native pixel dimensions by document handle.
pdfGetLogMetafileSize Read a metafile's own logical bounds rectangle (its embedded
pdfGetLogMetafileSizeEx Read a metafile's own logical bounds rectangle (its embedded

Images

pdfInsertImage Load an image file (format auto-detected from content) and
pdfInsertImageEx Load an image file (format auto-detected from content) and
pdfInsertImageFromBuffer Same as pdfInsertImage, but decoding from an in-memory

Metafiles

pdfInsertMetafile Replay an EMF/WMF metafile file (A/W) or in-memory buffer
pdfInsertMetafileEx Replay an EMF/WMF metafile file (A/W) or in-memory buffer
pdfInsertMetafileExt Same as pdfInsertMetafile/Ex, with an additional View
pdfInsertMetafileExtEx Same as pdfInsertMetafile/Ex, with an additional View
pdfInsertMetafileFromHandle Replay a live, in-process GDI HENHMETAFILE handle
pdfInsertMetafileFromHandleEx Replay a live, in-process GDI HENHMETAFILE handle

Object Creation

pdfCreateImage Load and register an image from a file without placing it
pdfCreateImageObj Mint a standalone, independently-lifetimed image object

Setters

pdfSetFindImagesMode Set a document-global "find images" mode value.
pdfSetUseImageInterpolation Set the PDF /Interpolate flag on a specific image (plain
pdfSetUseImageInterpolationEx Set the PDF /Interpolate flag on a specific image (plain