<!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>Give the bounding box of a text using fonts via freetype2</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagefontwidth.html">imagefontwidth</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagefttext.html">imagefttext</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.imageftbbox" class="refentry">
<div class="refnamediv">
<h1 class="refname">imageftbbox</h1>
<p class="verinfo">(PHP 4 >= 4.0.7, PHP 5)</p><p class="refpurpose"><span class="refname">imageftbbox</span> — <span class="dc-title">Give the bounding box of a text using fonts via freetype2</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imageftbbox-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>imageftbbox</strong></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$size</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$angle</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$fontfile</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$text</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$extrainfo</code></span>
] )</div>
<p class="para rdfs-comment">
This function calculates and returns the bounding box in pixels
for a FreeType text.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imageftbbox-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">size</code></em></span>
<dd>
<p class="para">The font size. Depending on your version of GD, this should be specified as the pixel size (GD1) or point size (GD2).</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">angle</code></em></span>
<dd>
<p class="para">
Angle in degrees in which <em><code class="parameter">text</code></em> will be
measured.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">fontfile</code></em></span>
<dd>
<p class="para">
The name of the TrueType font file (can be a URL). Depending on
which version of the GD library that PHP is using, it may attempt to
search for files that do not begin with a leading '/' by appending
'.ttf' to the filename and searching along a library-defined font path.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">text</code></em></span>
<dd>
<p class="para">
The string to be measured.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">extrainfo</code></em></span>
<dd>
<p class="para">
<table class="doctable table">
<caption><strong>Possible array indexes for <em><code class="parameter">extrainfo</code></em></strong></caption>
<thead>
<tr>
<th>Key</th>
<th>Type</th>
<th>Meaning</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><em>linespacing</em></td>
<td><span class="type"><a href="language.types.float.html" class="type float">float</a></span></td>
<td>Defines drawing linespacing</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imageftbbox-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>imageftbbox()</strong></span> returns an array with 8
elements representing four points making the bounding box of the
text:
<table class="doctable informaltable">
<tbody class="tbody">
<tr>
<td>0</td>
<td>lower left corner, X position</td>
</tr>
<tr>
<td>1</td>
<td>lower left corner, Y position</td>
</tr>
<tr>
<td>2</td>
<td>lower right corner, X position</td>
</tr>
<tr>
<td>3</td>
<td>lower right corner, Y position</td>
</tr>
<tr>
<td>4</td>
<td>upper right corner, X position</td>
</tr>
<tr>
<td>5</td>
<td>upper right corner, Y position</td>
</tr>
<tr>
<td>6</td>
<td>upper left corner, X position</td>
</tr>
<tr>
<td>7</td>
<td>upper left corner, Y position</td>
</tr>
</tbody>
</table>
</p>
<p class="para">
The points are relative to the <em class="emphasis">text</em> regardless of the
<em><code class="parameter">angle</code></em>, so "upper left" means in the top left-hand
corner seeing the text horizontally.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imageftbbox-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3242">
<p><strong>Example #1 <span class="function"><strong>imageftbbox()</strong></span> example</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 a 300x150 image<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">300</span><span style="color: #007700">, </span><span style="color: #0000BB">150</span><span style="color: #007700">);<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">// Set the background to be white<br /></span><span style="color: #0000BB">imagefilledrectangle</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">299</span><span style="color: #007700">, </span><span style="color: #0000BB">299</span><span style="color: #007700">, </span><span style="color: #0000BB">$white</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Path to our font file<br /></span><span style="color: #0000BB">$font </span><span style="color: #007700">= </span><span style="color: #DD0000">'./arial.ttf'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// First we create our bounding box<br /></span><span style="color: #0000BB">$bbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imageftbbox</span><span style="color: #007700">(</span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">$font</span><span style="color: #007700">, </span><span style="color: #DD0000">'The PHP Documentation Group'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// This is our cordinates for X and Y<br /></span><span style="color: #0000BB">$x </span><span style="color: #007700">= </span><span style="color: #0000BB">$bbox</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">] + (</span><span style="color: #0000BB">imagesx</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">) / </span><span style="color: #0000BB">2</span><span style="color: #007700">) - (</span><span style="color: #0000BB">$bbox</span><span style="color: #007700">[</span><span style="color: #0000BB">4</span><span style="color: #007700">] / </span><span style="color: #0000BB">2</span><span style="color: #007700">) - </span><span style="color: #0000BB">5</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$y </span><span style="color: #007700">= </span><span style="color: #0000BB">$bbox</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] + (</span><span style="color: #0000BB">imagesy</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">) / </span><span style="color: #0000BB">2</span><span style="color: #007700">) - (</span><span style="color: #0000BB">$bbox</span><span style="color: #007700">[</span><span style="color: #0000BB">5</span><span style="color: #007700">] / </span><span style="color: #0000BB">2</span><span style="color: #007700">) - </span><span style="color: #0000BB">5</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">imagefttext</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">$x</span><span style="color: #007700">, </span><span style="color: #0000BB">$y</span><span style="color: #007700">, </span><span style="color: #0000BB">$black</span><span style="color: #007700">, </span><span style="color: #0000BB">$font</span><span style="color: #007700">, </span><span style="color: #DD0000">'The PHP Documentation Group'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Output to browser<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>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imageftbbox-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function is only available if
PHP is compiled with freetype support (<strong class="option configure">--with-freetype-dir=DIR</strong>
)
</span></p></blockquote>
</div>
<div class="refsect1 changelog" id="refsect1-function.imageftbbox-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.3.5</td>
<td>
<em><code class="parameter">extrainfo</code></em> was made optional.
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagefontwidth.html">imagefontwidth</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagefttext.html">imagefttext</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>
