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)
Check Out this Related Man Page
CAIRO_GET_CURRENT_POINT(3) 1 CAIRO_GET_CURRENT_POINT(3)CairoContext::getCurrentPoint - The getCurrentPoint purpose
Object oriented style
SYNOPSIS
public array CairoContext::getCurrentPoint (void )
DESCRIPTION
Procedural style
array cairo_get_current_point (CairoContext $context)
Gets the current point of the current path, which is conceptually the final point reached by the path so far.
The current point is returned in the user-space coordinate system. If there is no defined current point or if cr is in an error status, x
and y will both be set to 0.0. It is possible to check this in advance with CairoContext::hasCurrentPoint.
Most path construction functions alter the current point. See the following for details on how they affect the current point: CairoCon-
text::newPath, CairoContext::newSubPath, CairoContext::appendPath, CairoContext::closePath, CairoContext::moveTo, CairoContext::lineTo,
CairoContext::curveTo, CairoContext::relMoveTo, CairoContext::relLineTo, CairoContext::relCurveTo, CairoContext::arc, CairoContext::arcNeg-
ative, CairoContext::rectangle, CairoContext::textPath, CairoContext::glyphPath.
Some functions use and alter the current point but do not otherwise change current path: CairoContext::showText.
Some functions unset the current path and as a result, current point: CairoContext::fill, CairoContext::stroke.
PARAMETERS
o $context
- A valid CairoContext object.
RETURN VALUES
An array containing the x (index 0) and y (index 1) coordinates of the current point.
EXAMPLES
Example #1
Object oriented style
<?php
$s = new CairoImageSurface(CairoFormat::ARGB32, 100, 100);
$c = new CairoContext($s);
$c->moveTo(10, 10);
var_dump($c->getCurrentPoint());
?>
The above example will output something similar to:
array(2) {
[0]=>
float(10)
[1]=>
float(10)
}
Example #2
Procedural style
<?php
$s = cairo_image_surface_create(CAIRO_SURFACE_TYPE_IMAGE, 100, 100);
$c = cairo_create($s);
cairo_move_to($c, 10, 10);
var_dump(cairo_get_current_point($c));
?>
The above example will output something similar to:
array(2) {
[0]=>
float(10)
[1]=>
float(10)
}
SEE ALSO
CairoContext::moveTo, CairoContext::hasCurrentPoint.
PHP Documentation Group CAIRO_GET_CURRENT_POINT(3)