<!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>Closes the current path</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="cairocontext.cliprectanglelist.html">CairoContext::clipRectangleList</a></div>
<div class="next" style="text-align: right; float: right;"><a href="cairocontext.construct.html">CairoContext::__construct</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.closepath" class="refentry">
<div class="refnamediv">
<h1 class="refname">CairoContext::closePath</h1>
<h1 class="refname">cairo_close_path</h1>
<p class="verinfo">(PECL cairo >= 0.1.0)</p><p class="refpurpose"><span class="refname">CairoContext::closePath</span> -- <span class="refname">cairo_close_path</span> — <span class="dc-title">Closes the current path</span></p>
</div>
<div class="refsect1 description" id="refsect1-cairocontext.closepath-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"><span class="type void">void</span></span> <span class="methodname"><strong>CairoContext::closePath</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style:</p>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>cairo_close_path</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">
Adds a line segment to the path from the current point to the beginning of the current sub-path,
(the most recent point passed to <span class="methodname"><a href="cairocontext.moveto.html" class="methodname">CairoContext::moveTo()</a></span>),
and closes this sub-path. After this call the current point will be at the joined endpoint
of the sub-path.
</p>
<p class="para">
The behavior of close_path() is distinct from simply calling
<span class="methodname"><a href="cairocontext.lineto.html" class="methodname">CairoContext::lineTo()</a></span> with the equivalent coordinate in the case of
stroking. When a closed sub-path is stroked, there are no caps on the ends of the sub-path.
Instead, there is a line join connecting the final and initial segments of the sub-path.
</p>
<p class="para">
If there is no current point before the call to <span class="methodname"><strong>CairoContext::closePath()</strong></span>,
this function will have no effect.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-cairocontext.closepath-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.closepath-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-cairocontext.closepath-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2860">
<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">$context</span><span style="color: #007700">-></span><span style="color: #0000BB">closePath</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-2861">
<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">cairo_close_path</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>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-cairocontext.closepath-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="cairocontext.copypath.html" class="methodname" rel="rdfs-seeAlso">CairoContext::copyPath()</a> - Creates a copy of the current path</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.cliprectanglelist.html">CairoContext::clipRectangleList</a></div>
<div class="next" style="text-align: right; float: right;"><a href="cairocontext.construct.html">CairoContext::__construct</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>
