<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 48220b9fcde41afb13e0b7f3e806f51cd179df90 Maintainer: hirokawa Status: ready -->

<!-- CREDITS: shimooka,mumumu -->

<refentry xml:id="function.imagettfbbox" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>imagettfbbox</refname>

<refpurpose>TypeType フォントを使用したテキストの bounding box を生成する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>array</type><type>false</type></type><methodname>imagettfbbox</methodname>

<methodparam><type>float</type><parameter>size</parameter></methodparam>

<methodparam><type>float</type><parameter>angle</parameter></methodparam>

<methodparam><type>string</type><parameter>font_filename</parameter></methodparam>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>

</methodsynopsis>

<para>

この関数は TrueType テキストの bounding box をピクセル単位で計算して

返します。

</para>

<note>

<para>

PHP 8.0.0 より前のバージョンでは、

<function>imageftbbox</function> は、

<function>imagettfbbox</function> を拡張したものでした。

<parameter>extrainfo</parameter> を追加でサポートしています。

PHP 8.0.0 以降では、

<function>imagettfbbox</function> は、

<function>imageftbbox</function> のエイリアスになっています。

</para>

</note>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>size</parameter></term>

<listitem>

<para>&gd.font.size;</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>angle</parameter></term>

<listitem>

<para>

測定する <parameter>string</parameter> の角度(度単位)。

</para>

</listitem>

</varlistentry>

&gd.ttf.fontfile;

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

測定する文字列。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>options</parameter></term>

<listitem>

<para>

<function>imagettftext</function> と同じです。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

<function>imagettfbbox</function> は、テキストの bounding box を

作成するための 4 点を表現する 8 個の要素からなる配列を返します。

エラー時には &false; を返します。

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>キー</entry>

<entry>内容</entry>

</row>

</thead>

<tbody>

<row>

<entry>0</entry>

<entry>左下角の X 座標</entry>

</row>

<row>

<entry>1</entry>

<entry>左下角の Y 座標</entry>

</row>

<row>

<entry>2</entry>

<entry>右下角の X 座標</entry>

</row>

<row>

<entry>3</entry>

<entry>右下角の Y 座標</entry>

</row>

<row>

<entry>4</entry>

<entry>右上角の X 座標</entry>

</row>

<row>

<entry>5</entry>

<entry>右上角の Y 座標</entry>

</row>

<row>

<entry>6</entry>

<entry>左上角の X 座標</entry>

</row>

<row>

<entry>7</entry>

<entry>左上角の Y 座標</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

<para>

各点の位置は、

<parameter>angle</parameter> にかかわらず

<emphasis>text</emphasis> からの相対位置で表されます。

つまり、"左上"はテキストを水平に見た場合の左上の角を意味します。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>options</parameter> が追加されました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>imagettfbbox</function> の例</title>

<programlisting role="php">

<![CDATA[

<?php

// 300x150 の画像を作成します

$im = imagecreatetruecolor(300, 150);

$black = imagecolorallocate($im, 0, 0, 0);

$white = imagecolorallocate($im, 255, 255, 255);

// 背景を白に設定します

imagefilledrectangle($im, 0, 0, 299, 299, $white);

// フォントファイルへのパス

$font = './arial.ttf';

// まず最初のテキスト用のバウンディングボックスを作成します

$bbox = imagettfbbox(10, 45, $font, 'Powered by PHP ' . phpversion());

// X 座標と Y 座標

$x = $bbox[0] + (imagesx($im) / 2) - ($bbox[4] / 2) - 25;

$y = $bbox[1] + (imagesy($im) / 2) - ($bbox[5] / 2) - 5;

// 書き込みます

imagettftext($im, 10, 45, $x, $y, $black, $font, 'Powered by PHP ' . phpversion());

// 次に 2 番目のテキスト用のバウンディングボックスを作成します

$bbox = imagettfbbox(10, 45, $font, 'and Zend Engine ' . zend_version());

// 最初のテキストに続ける座標を設定します

$x = $bbox[0] + (imagesx($im) / 2) - ($bbox[4] / 2) + 10;

$y = $bbox[1] + (imagesy($im) / 2) - ($bbox[5] / 2) - 5;

// 書き込みます

imagettftext($im, 10, 45, $x, $y, $black, $font, 'and Zend Engine ' . zend_version());

// ブラウザに出力します

header('Content-Type: image/png');

imagepng($im);

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

&note.freetype;

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>imagettftext</function></member>

<member><function>imageftbbox</function></member>

</simplelist>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->