cairo_clip(3) php man page | unix.com

CAIRO_CLIP(3)								 1							     CAIRO_CLIP(3)

CairoContext::clip - Establishes a new clip region

       Object oriented style (method):

SYNOPSIS
       public void CairoContext::clip (void  )

DESCRIPTION
       Procedural style:
       void cairo_clip (CairoContext  $context)

	Establishes a new clip region by intersecting the current clip region with the current path as it would be filled by CairoContext::fill or
       cairo_fill(3) and according to the current fill rule (see CairoContext::setFillRule or cairo_set_fill_rule(3)).

	After CairoContext::clip or cairo_clip(3), the current path will be cleared from the cairo context.

	The current clip region affects all drawing operations by effectively masking out any changes to the surface that are outside the  current
       clip region.

	Calling  CairoContext::clip  or  cairo_clip(3)	can  only  make the clip region smaller, never larger. But the current clip is part of the
       graphics state, so a temporary restriction of the clip region can be achieved by  calling  CairoContext::clip  or  cairo_clip(3)  within  a
       CairoContext::save/  CairoContext::restore  or cairo_save(3)/cairo_restore(3) pair. The only other means of increasing the size of the clip
       region is CairoContext::resetClip or procedural cairo_reset_clip(3).

PARAMETERS
	      o $context
		- A valid CairoContext object

RETURN VALUES
	No value is returned.

EXAMPLES
       Example #1

	      Object oriented style

	      <?php

	      $surface = new CairoImageSurface(CairoFormat::ARGB32, 50, 50);

	      $context = new CairoContext($surface);

	      $context->clip();

	      ?>

       Example #2

	      Procedural style

	      <?php

	      $surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, 50, 50);

	      $context = cairo_create($surface);

	      cairo_clip($context);

	      ?>

SEE ALSO
       CairoContext::resetClip, cairo_reset_clip(3).

PHP Documentation Group 													     CAIRO_CLIP(3)