<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieves the current clip as a list of rectangles</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="cairocontext.clippreserve.html">CairoContext::clipPreserve</a></div>
<div class="next" style="text-align: right; float: right;"><a href="cairocontext.closepath.html">CairoContext::closePath</a></div>
<div class="up"><a href="class.cairocontext.html">CairoContext</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="cairocontext.cliprectanglelist" class="refentry">
<div class="refnamediv">
<h1 class="refname">CairoContext::clipRectangleList</h1>
<h1 class="refname">cairo_clip_rectangle_list</h1>
<p class="verinfo">(PECL cairo >= 0.1.0)</p><p class="refpurpose"><span class="refname">CairoContext::clipRectangleList</span> -- <span class="refname">cairo_clip_rectangle_list</span> — <span class="dc-title">Retrieves the current clip as a list of rectangles</span></p>
</div>
<div class="refsect1 description" id="refsect1-cairocontext.cliprectanglelist-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style (method):</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>CairoContext::clipRectangleList</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style:</p>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>cairo_clip_rectangle_list</strong></span>
( <span class="methodparam"><span class="type"><a href="class.cairocontext.html" class="type CairoContext">CairoContext</a></span> <code class="parameter">$context</code></span>
)</div>
<p class="para rdfs-comment">
Returns a list-type array with the current clip region as a list of rectangles in user coordinates
</p>
</div>
<div class="refsect1 parameters" id="refsect1-cairocontext.cliprectanglelist-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">context</code></em></span>
<dd>
<p class="para">
A valid <a href="class.cairocontext.html" class="classname">CairoContext</a> object created with <span class="methodname"><a href="cairocontext.construct.html" class="methodname">CairoContext::__construct()</a></span> or
<span class="function"><a href="function.cairo-create.html" class="function">cairo_create()</a></span>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-cairocontext.cliprectanglelist-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An array of user-space represented rectangles for the current clip
</p>
<p class="para">
(The status in the list may be CAIRO_STATUS_CLIP_NOT_REPRESENTABLE to indicate that the clip
region cannot be represented as a list of user-space rectangles.
The status may have other values to indicate other errors.)
</p>
</div>
<div class="refsect1 examples" id="refsect1-cairocontext.cliprectanglelist-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2858">
<p><strong>Example #1 Object oriented style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$surface </span><span style="color: #007700">= new </span><span style="color: #0000BB">CairoImageSurface</span><span style="color: #007700">(</span><span style="color: #0000BB">CairoFormat</span><span style="color: #007700">::</span><span style="color: #0000BB">ARGB32</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$context </span><span style="color: #007700">= new </span><span style="color: #0000BB">CairoContext</span><span style="color: #007700">(</span><span style="color: #0000BB">$surface</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">-></span><span style="color: #0000BB">clipRectangleList</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(1) {
[0]=>
array(4) {
["x"]=>
float(0)
["y"]=>
float(0)
["width"]=>
float(50)
["height"]=>
float(50)
}
}
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-2859">
<p><strong>Example #2 Procedural style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$surface </span><span style="color: #007700">= </span><span style="color: #0000BB">cairo_image_surface_create</span><span style="color: #007700">(</span><span style="color: #0000BB">CAIRO_FORMAT_ARGB32</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$context </span><span style="color: #007700">= </span><span style="color: #0000BB">cairo_create</span><span style="color: #007700">(</span><span style="color: #0000BB">$surface</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">cairo_clip_rectangle_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(1) {
[0]=>
array(4) {
["x"]=>
float(0)
["y"]=>
float(0)
["width"]=>
float(50)
["height"]=>
float(50)
}
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-cairocontext.cliprectanglelist-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><strong>Classname::Method()</strong></span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="cairocontext.clippreserve.html">CairoContext::clipPreserve</a></div>
<div class="next" style="text-align: right; float: right;"><a href="cairocontext.closepath.html">CairoContext::closePath</a></div>
<div class="up"><a href="class.cairocontext.html">CairoContext</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
