API reference

Graphics

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

Conversion

pdfConvColor Convert one color value (up to 4 components) from a source
pdfConvColorEx Convert one color value (up to 4 components) from a source
pdfConvertColors Rewrite every page's content stream, converting RGB/CMYK color

Core

pdfAbortPath Inspect and discard the current path under construction.
pdfBeginClipPath Nominally: mark the start of a clip-path construction
pdfBeginPattern Begin/end capturing a custom tiling pattern — drawing
pdfBezier_1_2_3 Append a cubic Bézier curve with both control points explicit
pdfBezier_1_3 Cubic Bézier where the first control point is explicit
pdfBezier_2_3 Cubic Bézier where the first control point equals the
pdfChangeSeparationColor Change the tint-transform color and alternate device space of
pdfClipPath Set the clipping path to the current path (W/W*), then
pdfClosePath Paint the current path per FillMode (per the shared table
pdfDAShiftedHeader Per its name and ABI shape, this appears intended to detect
pdfEllipse Draw and immediately paint an ellipse inscribed in the given
pdfEndPattern Begin/end capturing a custom tiling pattern — drawing
pdfHaveOpenPath Inspect and discard the current path under construction.
pdfInitBarcode2 Zero-fill and populate Barcode with sensible defaults before
pdfInitColorManagement Initialize document-level color-management state — a
pdfInitColorManagementEx Initialize document-level color-management state — a
pdfInsertBarcode Draw one of 4 built-in 2D-barcode symbologies onto the
pdfInsertBarcodeStr The convenience form of pdfInsertBarcode: place a
pdfIsColorPage Test whether the current page's content stream contains any
pdfLineTo Append a straight line segment to (PosX, PosY) (PDF l
pdfMoveTo Begin a new subpath at (PosX, PosY) (PDF m operator).
pdfMultiplyMatrix Pure matrix-math utility: multiply two 2D affine matrices
pdfPlaceTemplByMatrix Place a previously-created template (or pattern-scratch
pdfRectangle Draw and immediately paint a rectangle.
pdfRenameSpotColor Rename a spot-colorant name across every registered
pdfResetLineDashPattern Set (three input forms) or clear the current line-dash pattern
pdfRotateCoords Concatenate a rotation (by alpha degrees, counter-clockwise)
pdfRoundRect Draw and immediately paint a rectangle with uniform circular
pdfRoundRectEx Rounded rectangle with independent horizontal/vertical corner
pdfScaleCoords Concatenate a scale transform (independent X/Y factors, pivot
pdfSkewCoords Concatenate a shear (skew) transform — independent X-tilt
pdfStrokePath Stroke the current manually-built path (S operator).
pdfTestTempPath Read the OS-level temp directory the SDK would use for
pdfTriangle Draw and immediately paint a triangle from three explicit

Getters

pdfGetBarcodeDict Read back the caption text of a barcode-bearing form field,
pdfGetColorSpace Return the current fill color space.
pdfGetColorSpaceCount Return the number of color spaces registered on the document
pdfGetColorSpaceObj Read a full color-space descriptor by registered handle
pdfGetColorSpaceObjEx Read a full color-space descriptor by registered handle
pdfGetDrawDirection Set/get a document-global "draw direction" value.
pdfGetEMFPatternDistance Set/get a document-global tiling-pattern hatch-line spacing
pdfGetFillColor Return the last packed fill (resp. stroke) color value set via
pdfGetGStateFlags Set/get a document-global compatibility/behavior bitmask
pdfGetIconColor Set/get a document-global default icon color, presumably
pdfGetLineCapStyle Set/get the current line-cap style (TLineCapStyle:
pdfGetLineJoinStyle Set/get the current line-join style (TLineJoinStyle:
pdfGetLineWidth Set/get the current stroke line width, in user-space units
pdfGetMatrix Read the current accumulated transformation matrix.
pdfGetMiterLimit Set/get the current miter limit, which bounds how far a sharp
pdfGetOpacity Set/get a document-global "current opacity" value intended to
pdfGetStrokeColor Return the last packed fill (resp. stroke) color value set via
pdfGetTempPath Read the OS-level temp directory the SDK would use for
pdfGetTransparentColor Set/get a document-global "transparent color" value.

Misc

psrGetBlendMode Read/write the blend-mode sub-field of a caller-owned packed
psrGetLineCapStyle Read/write the line-cap sub-field (bits 8-9) of a
psrGetLineJoinStyle Read/write the line-join sub-field (bits 12-13) of a
psrSetBlendMode Read/write the blend-mode sub-field of a caller-owned packed
psrSetLineCapStyle Read/write the line-cap sub-field (bits 8-9) of a
psrSetLineJoinStyle Read/write the line-join sub-field (bits 12-13) of a

Object Creation

pdfCreateAxialShading Register a two-stop axial (linear-gradient) or radial
pdfCreateCIEColorSpace Register a new CIE-based color space — CalGray, CalRGB, or Lab
pdfCreateDeviceNColorSpace Register a new DeviceN color space with one or more named
pdfCreateExtGState Register a new ExtGState resource from a fully-populated
pdfCreateICCBasedColorSpace Register a new ICCBased color space, either loading the ICC
pdfCreateICCBasedColorSpaceEx Register a new ICCBased color space, either loading the ICC
pdfCreateIndexedColorSpace Register a new Indexed color space over a palette of
pdfCreateRadialShading Register a two-stop axial (linear-gradient) or radial
pdfCreateRectilinearMeasure Attach a rectilinear (/Subtype /RL) /Measure dictionary to
pdfCreateSetOCGStateAction Create a /SetOCGState action listing three OCG-handle sets
pdfCreateStdPattern Register one of 6 built-in hatch-style tiling patterns

Polygon Clipper

gpcAddVertex Append one contour (a closed vertex loop) to a caller-owned
gpcClipPoly Perform a boolean polygon operation (difference/intersection/
gpcDeleteGPC Create/destroy/reset a GPC (polygon-clipper) context handle —
gpcNewGPC Create/destroy/reset a GPC (polygon-clipper) context handle —
gpcReset Create/destroy/reset a GPC (polygon-clipper) context handle —

Setters

pdfSetColorMask Set a /Mask color-key range ([min1 max1 min2 max2 ...]) on
pdfSetColors Convenience call that sets both the fill and stroke color
pdfSetColorSpace Select the current color space for both fill and stroke in
pdfSetDrawDirection Set/get a document-global "draw direction" value.
pdfSetEMFPatternDistance Set/get a document-global tiling-pattern hatch-line spacing
pdfSetFillColor Set the fill (resp. stroke) color from one packed 32-bit color
pdfSetFillColorEx Set the fill (resp. stroke) color from a byte array, one byte
pdfSetFillColorF Set the fill (resp. stroke) color from a float array, each
pdfSetFillColorSpace Set the current fill (resp. stroke) color space independently
pdfSetGStateFlags Set/get a document-global compatibility/behavior bitmask
pdfSetIconColor Set/get a document-global default icon color, presumably
pdfSetLineCapStyle Set/get the current line-cap style (TLineCapStyle:
pdfSetLineDashPattern Set (three input forms) or clear the current line-dash pattern
pdfSetLineDashPattern2 Set (three input forms) or clear the current line-dash pattern
pdfSetLineDashPatternEx Set (three input forms) or clear the current line-dash pattern
pdfSetLineJoinStyle Set/get the current line-join style (TLineJoinStyle:
pdfSetLineWidth Set/get the current stroke line width, in user-space units
pdfSetMatrix Apply an arbitrary transform to the current coordinate system.
pdfSetMiterLimit Set/get the current miter limit, which bounds how far a sharp
pdfSetOCGConfigState Set a single OCG's default visibility within a specific
pdfSetOCGState Set an OCG's default visibility in the document's base
pdfSetOCREnginePath Configure the external OCR engine executable path and its
pdfSetOpacity Set/get a document-global "current opacity" value intended to
pdfSetStrokeColor Set the fill (resp. stroke) color from one packed 32-bit color
pdfSetStrokeColorEx Set the fill (resp. stroke) color from a byte array, one byte
pdfSetStrokeColorF Set the fill (resp. stroke) color from a float array, each
pdfSetStrokeColorSpace Set the current fill (resp. stroke) color space independently
pdfSetTransparentColor Set/get a document-global "transparent color" value.
pdfSetUndercolorRemovalFunction Install a /UCR2 undercolor-removal function, as a Type 0

Vector Graphics

pdfDrawArc Draw a circular arc and stroke it.
pdfDrawArcEx Elliptical-arc variant of [pdfDrawArc](#api-pdfdrawarc),
pdfDrawChord Draw an elliptical arc closed by a straight chord (the arc's
pdfDrawCircle Draw and immediately paint a circle. Equivalent to
pdfDrawHTMLBoxMatrix Draw the SDK's limited HTML subset (see [HTML Text, Arc Text & Callout Conversion](../V06_Text/E04_HTMLTextAndArcText.md) for the exact
pdfDrawHTMLMatrix Draw the SDK's limited HTML subset (see [HTML Text, Arc Text & Callout Conversion](../V06_Text/E04_HTMLTextAndArcText.md) for the exact
pdfDrawPie Draw a pie-slice wedge (center → arc start → arc → back to