pdfClipPath

Purpose — Set the clipping path to the current path (W/W*), then optionally also paint it.

Declarations

BOOL32 __stdcall pdfClipPath(PPDF IPDF, TClippingMode ClipMode, TPathFillMode FillMode);

function pdfClipPath(const IPDF: PPDF; ClipMode: TClippingMode; FillMode: TPathFillMode): LongBool; stdcall; external 'LumasPdf.dll';

TClippingMode:

TClippingMode = (cmEvenOdd, cmWinding);

Parameters

Return value — TRUE on success; FALSE if no content stream is open.

Remarks — verified: FillMode means something different here than everywhere else in this chapter. pdfClipPath implements its own reduced dispatch, not WriteFillMode's 12-value table:

Critically, this call never emits an explicit h (close) operator regardless of FillMode — the "close" distinction that matters for the chapter's shared table (e.g. 3 = close+fill vs 0 = fill-no-close) is not preserved here; both 0 and 3 produce plain f. If you're reusing a FillMode constant you also pass to pdfRectangle/pdfClosePath/etc., verify against this table — passing the same integer to pdfClipPath does not necessarily do what its meaning elsewhere would suggest (though for the common values 0/1/2/3/4/5 the *paint operator chosen* happens to agree even though the close behavior differs; values 6–11 diverge outright — e.g. 6 means "fill even-odd" in the shared table but produces a plain nonzero-winding f here, and the shared table's n/h distinction at 10/11 both collapse to n here).

See also — pdfBeginClipPath

C# (P/Invoke)

[return: MarshalAs(UnmanagedType.Bool)]