<!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>Draws a circle</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ps-begin-template.html">ps_begin_template</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-clip.html">ps_clip</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ps-circle" class="refentry">
<div class="refnamediv">
<h1 class="refname">ps_circle</h1>
<p class="verinfo">(PECL ps >= 1.1.0)</p><p class="refpurpose"><span class="refname">ps_circle</span> — <span class="dc-title">Draws a circle</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ps-circle-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ps_circle</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$psdoc</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$x</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$y</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$radius</code></span>
)</div>
<p class="para rdfs-comment">
Draws a circle with its middle point at (<em><code class="parameter">x</code></em>,
<em><code class="parameter">y</code></em>). The circle starts and ends at position
(<em><code class="parameter">x</code></em>+<em><code class="parameter">radius</code></em>,
<em><code class="parameter">y</code></em>). If this function is called outside a path it
will start a new path. If it is called within a path it will add the circle
as a subpath. If the last drawing operation does not end in point
(<em><code class="parameter">x</code></em>+<em><code class="parameter">radius</code></em>,
<em><code class="parameter">y</code></em>) then there will be a gap in the path.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ps-circle-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">psdoc</code></em></span>
<dd>
<p class="para">
Resource identifier of the postscript file
as returned by <span class="function"><a href="function.ps-new.html" class="function">ps_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">x</code></em></span>
<dd>
<p class="para">
The x-coordinate of the circle's middle point.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">y</code></em></span>
<dd>
<p class="para">
The y-coordinate of the circle's middle point.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">radius</code></em></span>
<dd>
<p class="para">
The radius of the circle
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ps-circle-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ps-circle-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ps-arc.html" class="function" rel="rdfs-seeAlso">ps_arc()</a> - Draws an arc counterclockwise</span></li>
<li class="member"> <span class="function"><a href="function.ps-arcn.html" class="function" rel="rdfs-seeAlso">ps_arcn()</a> - Draws an arc clockwise</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="function.ps-begin-template.html">ps_begin_template</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ps-clip.html">ps_clip</a></div>
<div class="up"><a href="ref.ps.html">PS Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
