API referenceGraphics

pdfBeginClipPath

Nominally: mark the start of a clip-path construction

CategoryClipping
Noteno-op beyond a nil-check (see Remarks)

Purpose — Nominally: mark the start of a clip-path construction sequence.

Description — no-op in this release. The entire implementation is Result := EnsureCurrentContent <> nil — it writes nothing to the content stream and sets no state. Calling pdfMoveTo/pdfLineTo/etc. followed by pdfClipPath works identically whether or not you call this first.

Declarations

C
BOOL32 __stdcall pdfBeginClipPath(PPDF IPDF);
Delphi
function pdfBeginClipPath(const IPDF: PPDF): LongBool; stdcall; external 'LumasPdf.dll';

Return valueTRUE if a content stream is open; FALSE otherwise — functionally a precondition probe, nothing more.

See alsopdfClipPath

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
Graphics
Category

Core

Exported names

pdfBeginClipPath

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.