<!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 text over an image using PostScript Type1 fonts</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagepsslantfont.html">imagepsslantfont</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagerectangle.html">imagerectangle</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imagepstext" class="refentry">
<div class="refnamediv">
<h1 class="refname">imagepstext</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imagepstext</span> — <span class="dc-title">Draws a text over an image using PostScript Type1 fonts</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imagepstext-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>imagepstext</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$image</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$text</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$font_index</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$foreground</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$background</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$x</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$y</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$space</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$tightness</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">float</span> <code class="parameter">$angle</code><span class="initializer"> = 0.0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$antialias_steps</code><span class="initializer"> = 4</span></span>
]]]] )</div>
<p class="para rdfs-comment">
Draws a text on an image using PostScript Type1 fonts.
</p>
<p class="para">
Refer to PostScript documentation about fonts and their measuring system
if you have trouble understanding how this works.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imagepstext-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
image</code></em></span><dd>
<p class="para">An image resource, returned by one of the image creation functions,
such as <span class="function"><a href="function.imagecreatetruecolor.html" class="function">imagecreatetruecolor()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">text</code></em></span>
<dd>
<p class="para">
The text to be written.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">font_index</code></em></span>
<dd>
<p class="para">
A font resource, returned by <span class="function"><a href="function.imagepsloadfont.html" class="function">imagepsloadfont()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">size</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">size</code></em> is expressed in pixels.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">foreground</code></em></span>
<dd>
<p class="para">
The color in which the text will be painted.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">background</code></em></span>
<dd>
<p class="para">
The color to which the text will try to fade in with antialiasing.
No pixels with the color <em><code class="parameter">background</code></em> are
actually painted, so the background image does not need to be of solid
color.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">x</code></em></span>
<dd>
<p class="para">
x-coordinate for the lower-left corner of the first character.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">y</code></em></span>
<dd>
<p class="para">
y-coordinate for the lower-left corner of the first character.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">space</code></em></span>
<dd>
<p class="para">
Allows you to change the default value of a space in a font. This
amount is added to the normal value and can also be negative.
Expressed in character space units, where 1 unit is 1/1000th of an
em-square.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">tightness</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">tightness</code></em> allows you to control the amount
of white space between characters. This amount is added to the
normal character width and can also be negative.
Expressed in character space units, where 1 unit is 1/1000th of an
em-square.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">angle</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">angle</code></em> is in degrees.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">antialias_steps</code></em></span>
<dd>
<p class="para">
Allows you to control the number of colours used for antialiasing
text. Allowed values are 4 and 16. The higher value is recommended
for text sizes lower than 20, where the effect in text quality is
quite visible. With bigger sizes, use 4. It's less computationally
intensive.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imagepstext-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function returns an array containing the following elements:
<table class="doctable informaltable">
<tbody class="tbody">
<tr>
<td>0</td>
<td>lower left x-coordinate</td>
</tr>
<tr>
<td>1</td>
<td>lower left y-coordinate</td>
</tr>
<tr>
<td>2</td>
<td>upper right x-coordinate</td>
</tr>
<tr>
<td>3</td>
<td>upper right y-coordinate</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imagepstext-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3270">
<p><strong>Example #1 <span class="function"><strong>imagepstext()</strong></span> usage</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Create image handle<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatetruecolor</span><span style="color: #007700">(</span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #0000BB">200</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Allocate colors<br /></span><span style="color: #0000BB">$black </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorallocate</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$white </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorallocate</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Load the PostScript Font<br /></span><span style="color: #0000BB">$font </span><span style="color: #007700">= </span><span style="color: #0000BB">imagepsloadfont</span><span style="color: #007700">(</span><span style="color: #DD0000">'font.pfm'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Write the font to the image<br /></span><span style="color: #0000BB">imagepstext</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #DD0000">'Sample text is simple'</span><span style="color: #007700">, </span><span style="color: #0000BB">$font</span><span style="color: #007700">, </span><span style="color: #0000BB">12</span><span style="color: #007700">, </span><span style="color: #0000BB">$black</span><span style="color: #007700">, </span><span style="color: #0000BB">$white</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: #FF8000">// Output and free memory<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">'Content-type: image/png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">imagepng</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 notes" id="refsect1-function.imagepstext-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function is only available
if PHP is compiled using <strong class="option configure">--with-t1lib[=DIR]</strong>
.
</span></p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.imagepstext-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imagepsbbox.html" class="function" rel="rdfs-seeAlso">imagepsbbox()</a> - Give the bounding box of a text rectangle using PostScript Type1 fonts</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.imagepsslantfont.html">imagepsslantfont</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagerectangle.html">imagerectangle</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
