What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

cpdf_clip
Prev	IX. ClibPDF Functions	Next

cpdf_clip

Name

cpdf_clip — Clips to current path

Synopsis

bool cpdf_clip(pdfdoc); resource pdfdoc: PDF document identifier

Returns

TRUE on success or FALSE on error

Description

Clips around the current drawing path. This can be used to create a cutout effect and to ensure shapes fit inside a spcified area.

In the example below, a cpdf_newpath() is used to create a clipping path in the shape of a rectangle and the clipping path cleared with a second call to cpdf_newpath() so shapes can be drawn.

Version

Since versions 3.0.8 and 4.0

Example

Example 120. Create a clipping path

// start a PDF document
$cpdf = cpdf_open(0, "test.pdf");

// create a 600x400 page
cpdf_page_init($cpdf, 1, 0, 600, 400, 1);

// set the stroke gray amount
cpdf_setgray_stroke($cpdf, 0.0);

// set the linw width
cpdf_setlinewidth($cpdf, 0.2);

// save the current document state
cpdf_save($cpdf);

// create the clipping path
cpdf_newpath($cpdf);
cpdf_rect($cpdf, 50,50, 150, 90);
cpdf_clip($cpdf);
cpdf_newpath($cpdf);

// create a shape and close the path
cpdf_arc($cpdf, 100, 100, 50, 30, 220, 0); 
cpdf_closepath($cpdf);

// fill and stroke the shape and clipping path combined
cpdf_fill_stroke($cpdf); 

// comment out next line to see clipping path
// also affect this shape
cpdf_restore($cpdf);
cpdf_rect($cpdf, 30,30, 100, 30);
cpdf_stroke($cpdf);

// close and write document
cpdf_finalize($cpdf);
cpdf_close($cpdf);

Prev	Home	Next
cpdf_circle	Up	cpdf_close

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.