PHP 8.3.4 Released!

imagefttext

(PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8)

imagefttext使用 FreeType 2 字体将文本写入图像

说明

imagefttext(
    GdImage $image,
    float $size,
    float $angle,
    int $x,
    int $y,
    int $color,
    string $font_filename,
    string $text,
    array $options = []
): array|false

注意:

在 PHP 8.0.0 之前,imagefttext()imagettftext() 的扩展变体,它还支持 options。 自 PHP 8.0.0 起,imagettftext()imagefttext() 的别名。

参数

image

由图象创建函数(例如imagecreatetruecolor())返回的 GdImage 对象。

size

字体的尺寸,单位:点(磅)。

angle

以度为单位的角度,0 度表示从左到右阅读文本。较高的值表示逆时针旋转。例如,值为 90 将导致从下到上阅读文本。

x

xy 给出的坐标将定义第一个字符的基点(大致是字符的左下角)。 这与 imagestring() 不同,其中 xy 定义第一个字符的左上角。例如,“左上角”是 0, 0。

y

y 坐标。设置字体基线的位置,而不是字符的最底部。

color

文本所需颜色的索引,请参阅 imagecolorexact()

font_filename

希望使用的 TrueType 字体的路径。

根据 PHP 使用的 GD 库版本,font_filename 不以 / 开头时,将追加 .ttf 到文件名末尾,库将尝试沿着库定义的字体路径搜索该文件名。

在许多情况下,字体与使用的脚本位于同一目录中,以下技巧将缓解任何包含问题。

<?php
// 设置 GD 的环境变量
putenv('GDFONTPATH=' . realpath('.'));

// Name the font to be used (note the lack of the .ttf extension)
$font = 'SomeFont';
?>

text

要插入到图像中的文本。

options

options 可能的数组索引
类型 含义
linespacing float 定义绘制行距

返回值

这个函数返回数组,定义了盒子的四个点,从左下角开始逆时针移动:

0 左下 x 坐标
1 左下 y 坐标
2 右下 x 坐标
3 右下 x 坐标
4 右上 x 坐标
5 右上 x 坐标
6 左上 x 坐标
7 左上 y 坐标

失败时返回 false

更新日志

版本 说明
8.0.0 image 现在需要 GdImage 实例;之前需要有效的 gd resource

示例

示例 #1 imagefttext() 示例

<?php
// Create a 300x100 image
$im = imagecreatetruecolor(300, 100);
$red = imagecolorallocate($im, 0xFF, 0x00, 0x00);
$black = imagecolorallocate($im, 0x00, 0x00, 0x00);

// Make the background red
imagefilledrectangle($im, 0, 0, 299, 99, $red);

// Path to our ttf font file
$font_file = './arial.ttf';

// Draw the text 'PHP Manual' using font size 13
imagefttext($im, 13, 0, 105, 55, $black, $font_file, 'PHP Manual');

// Output image to the browser
header('Content-Type: image/png');

imagepng($im);
imagedestroy($im);
?>

注释

注意: 此函数仅在 PHP 编译时加入 freetype 支持时有效(--with-freetype-dir=DIR)。

参见

add a note

User Contributed Notes 15 notes

up
3
ben at tNOSPAManjNOSPAMo dot cnospamordots dot om
21 years ago
If you're interested in turning off FreeType hinting, search for the following line in the gd source (gdft.c):
      err = FT_Load_Glyph (face, glyph_index, FT_LOAD_DEFAULT);
and replace it with
      err = FT_Load_Glyph (face, glyph_index, FT_LOAD_NO_HINTING);

Recompile GD, and vo?la: beauteous antialiasing.
up
2
MagicalTux at FF dot st
19 years ago
When compiling PHP with FreeType 2 support, you'll probably have some problems if - for example - you use debian and didn't compile freetype2 yourself...
If configure fails after saying "If configure fails, try --with-xpm-dir..." you most likely have FreeType1 installed, but not freetype2 ...

Do this as root :
apt-get install libfreetype6-dev

It took me some time to find out that apt-get install freetype2 is actually installing freetype1 ...
up
2
aidan at php dot net
18 years ago
This function is very simular to imageffttext(), you may find the information provided on its manual page helpful:

http://php.net/imagettftext
up
1
sebastiand at gmx dot de
20 years ago
After spending the evening with some work on automatically generated images, I had the idea to switch of anti-aliasing (looking, if some font would look better that way), which turned out not to be quite so easy.

Actually you have to use the negative of the desired color to switch of antialising. I include the corresponding line from my code (line split up):

// USE NEGATIVE OF DESIRED COLOR TO SWITCH OF ANTI-ALIASING
ImageFTText ($neuesBild,$fontsize,$fontangle,$TextPosX,$TextPosY,
-$custom_fg,$fonttype,$text,array());
up
0
KeepSake at crimebloc dot com
14 years ago
For a design project I am required to have spacing between characters; since imagefttext does not support this feature I have created a function which does support this.

The arguments are identical to imagefttext, accept that (array)$extrainfo now accepts the 'character_spacing' spacing parameter. The return values are as expected, and include the image boundaries of the entire string including the character spacing.

The downside is that $angle rotates each letter instead of rotating the entire word (could be seen as a feature on its own).

I hope this is of some use to someone.
- KeepSake

<?php
// Required header (assuming we use png images)
header("Content-type: image/png");

// Create a basic image with a dark background.
$image = imagecreatetruecolor(300, 20);
imagefill($image, 0, 0, imagecolorallocate($image, 21, 21, 21));

// Function call, arguments are the same as imagefttext, expect that (array)$extrainfo takes a new paramenter called character_spacing.
$imageBox = imagefttext2($image, 9, 0, 2, 15, imagecolorallocate($image, 255, 255, 255), 'tahomabold.ttf', 'The quick brown fox...', array('character_spacing' => 5));

// Output the file, and clear the resources
imagepng($image);
imagedestroy($image);

function
imagefttext2($imageResource, $font_size, $text_angle, $start_x, $start_y, $color, $font_file, $text, $extra_info = array()) {
    if(
$extra_info['character_spacing'] == NULL || !is_numeric($extra_info['character_spacing'])) {
       
$extra_info['character_spacing'] = 0;
    }
   
$lastX = $start_x - $extra_info['character_spacing'];
    foreach(
str_split($text) as $v) {
       
$coordinates = imagefttext($imageResource, $font_size, $text_angle, $lastX + $extra_info['character_spacing'], $start_y, $color, $font_file, $v, $extra_info);
       
$lastX = max($coordinates[2], $coordinates[4]);
    }
   
// Return the newly generated image box coordinates:
   
return array($start_x, $start_y, $coordinates[2], $coordinates[3], $coordinates[4], $coordinates[5], $start_x, $coordinates[7]);
}

?>
up
0
d underscore brown x at hotmail dot
16 years ago
realpath(".")
realpath(getenv("SCRIPT_FILENAME"));

could be different.  This helped when setting GDFONTPATH.
up
0
darren at badpun dot co dot uk
16 years ago
I had trouble working out how to accurately represent fonts in point sizes when constructing charts that had a user-customisable output DPI (basically, the user could specify the size of the chart in mm - or any other physical measure - and the DPI to create arbitrarily-sized charts to work properly in real printed documents).

GD1 was OK as it used pixels for font rendering, but GD2 uses points, which only makes any sense if you know the DPI that it assumes when rendering text on the image surface. I have not been able to find this anywhere in this documentation but have examined the GD2 source code and it appears to assume a DPI of 96 internally. However, this can easily be customised in the GD2 source so it cannot be assumed that all PHP interpreters out there have a GD2 compiled using 96dpi internally.

If it does, and you are using it to construct images whose target DPI is not 96, you can calculate the point size to supply to imageftbox() and imagefttext() like this:

<?php
/* 100mm x 100mm image */
$imageWidth = 100;
$imageHeight = 100;

/* 300 dpi image, therefore image is 1181 x 1181 pixels */
$imageDPI = 300;

/* unless we do this, text will be about 3 times too small */
$realFontSize = ($fontPt * $targetDPI) / 96;
?>
up
0
Anonymous
18 years ago
I am using php 5.1.2 on a winxp machine. I was  getting into the TrueType fonts and wanted to see which ones would look best incorporated into web images. So I created the following script that prints out samples of all the TrueType fonts found in my C:\Windows\Fonts directory. The script takes only one request parameter - 'fsize'. It stands for font-size and lets you see each font in any size you wish -- I limited it to values between 5 and 48. Hope this helps someone other than me :)

I apologize in advance if any of my code is not the prettiest-written php code even seen -- I have only been coding in php for the past week (I'm a perl-guy usually).

<?php
   
list($x, $y, $maxwidth) = array(0, 0, 0);

   
$fsize = (int)$_REQUEST['fsize'];
    if (
$fsize < 5 or $fsize > 48) $fsize = 8;

   
header("Content-type: image/jpeg");

   
// don't know how wide or tall the font samples will be.
    // create a huge image for now, we'll copy it smaller
    // later when we know how large the image needs to be.
   
$im = imagecreate(1000, 20000) or die('could not create!');
   
$clr_white = imagecolorallocate($im, 255, 255, 255);
   
$clr_black = imagecolorallocate($im, 0, 0, 0);

   
$font_path = "C:/Windows/Fonts/";
   
$dh = opendir($font_path);
    while ((
$file = readdir($dh)) !== FALSE) {
       
// we're only dealing with TTY fonts here.
       
if (substr(strtolower($file), -4) != '.ttf') continue;

       
$str = "Sample text for '$file'";
       
$bbox = imagettfbbox(
           
$fsize, 0, "{$font_path}{$file}", $str
       
);
       
$ww = $bbox[4] - $bbox[6];
       
$hh = $bbox[1] - $bbox[7];

       
imagettftext(
           
$im, $fsize, 0, $x, $y,
           
$clr_black, "{$font_path}{$file}", $str
       
);

       
$y += $hh + 20;
        if (
$ww > $maxwidth) $maxwidth = $ww;
    }

   
closedir($dh);

   
// ok, now we can chop off the extra space from the
    // 1000 x 20000 image.
   
$im2 = imagecreate($maxwidth + 20, $y);
   
imagecopyresized(
       
$im2, $im, 0, 0, 0, 0, $maxwidth + 20,
       
$y, $maxwidth + 20, $y
   
);
   
imagejpeg($im2);
   
imagedestroy($im);
   
imagedestroy($im2);
?>
up
0
vsazel at atlas dot cz
18 years ago
If you want to get the best result in monochrome font rendering, change render_mode to FT_LOAD_RENDER. It's the last parameter of FT_Load_Glyph() function (in gdft.c).
up
0
dnf at seznam dot cz
18 years ago
For negative image you must add one line after the $grayColor computation:

$grayColor =  ~ $grayColor & 0x7FFFFFF;
up
0
kagaku at gmail dot com
19 years ago
I found myself in need of an align right function and found one on the imagepstext manual page. I can't imagine I'm the only person who's needed to use this, so here's a slightly modified version that works with imagefttext:

<?
 
function align_right($string, $fontfile, $imgwidth, $fontsize){
   
$spacing = 0;
   
$line = array("linespacing" => $spacing);
    list(
$lx,$ly,$rx,$ry) = imageftbbox($fontsize,0,$fontfile,$string,$line);
   
$textwidth = $rx - $lx;
   
$imw = ($imgwidth-10-$textwidth);
    return
$imw;
  }
?>
up
0
eshenk at comcast dot net
20 years ago
I wrote a bit of code to gather all the .ttf files in the directory with this script, and randomize them to write text on a header image for my site. The only catch is the font files have to be named 1.ttf, 2.ttf etc etc.

<?php

srand
((double)microtime()*1234567); // Start the random gizmo
$image = imagecreatefromjpeg(rand(1,exec('ls *.jpg | wc -l')) . ".jpg"); // Get a background
$font = rand(1,exec('ls *.ttf | wc -l')) . ".ttf"; // Get a font
$textcolor = imagecolorallocate($image,0,0,0); // Set text color

$text1 = "shenko.homedns.org"; // Here is our text

imagettftext($image, 50, 0, 20, 50, $textcolor, $font, $text1); // Write the text with a font

header("Content-type: image/jpeg"); // Its a JPEG
imagejpeg($image,'',90); // Zap it to the browser
imagedestroy($image); // Memory Freeupage

?>
up
-1
cory at lavacube dot com
17 years ago
Since this function is not documented, I felt it was best that I shed some light on the extrainfo parameter.

You can see the full documentation at the GD reference manual:
http://www.boutell.com/gd/manual2.0.33.html#gdImageStringFTEx

Basically it accepts an array containing the following options as keys and an associated value:
(int) flags [more info in the GD reference manual]
(double/float) linespacing
(int) charmap
(int) hdpi
(int) vdpi
(string) xshow
(string) fontpath

My C/C++ is not very good but this is the best I can explain. Read the documentation for more information. :-)

A very simple example of usage would be:

<?php

imagefttext
( $img_pointer, 12, 0, 10, 10, [-insertsomecolour-], '/path/to/font.ttf', "THIS IS A TEST\nTHIS IS LINE 2\nTHIS IS LINE3", array('lineheight'=>2.0) );

?>
up
-1
jwilliam at kcr dot uky dot edu
21 years ago
Thanks for the script!  I modified it to show several fonts that I was wanting to use.  I am using GD-2.0.7, FreeType-2.1.3(text rotation fix,among others), and PHP-4.2.3 and had to include the array information to get it to work.

Code change follows:
$fontfile="/usr/local/fonts/ttf/bookantbd.ttf";
// Waterfall of point sizes to see what Freetype 2's autohinting looks like:
//
for($i=4;$i<=12;$i++){
  ImageFtText($image,$i,0,10,(280+$i*14),$forecolor,$fontfile, bookantbd . $i . ". " . $string, array("linespacing" => 1.0));
}

John
up
-1
php@davehirschD0TK0MM
13 years ago
I'm not sure if this is a PHP issue or an GD issue, but after upgrading to PHP 5.3.2, text written at an angle has become top-justified (so "N" and "n" have the same top, but the bottom of the "N" is lower than the bottom of the "n".  I've written a kludgy work-around, which writes the text to a non-rotated temporary image, then copies the temporary image, rotated onto the main image.  The kludginess is to get around the fact that I can't seem to extract the font info, particularly the distance between the baseline and the very bottom (I've hard-coded it as 30% of the font size)
I hope the bug can be fixed (if it is indeed a bug) or that others can improve this code:

<?php
   
// Function that draws rotated text by creating a temporary image and rotating it, since rotated text appears to be busted
   
function imageTextRotated($image, $size, $angle, $x, $y, $inColor, $fontfile, $text, $info=array()) {
//        Force some demo text that contains risers and descenders:
//        $text = "Nlfbacejygq!";

       
$bbox = imageftbbox($size, 0, $fontfile, $text, $info);
       
$dropdown = $size*0.3;
       
$xsize = abs($bbox[2] - $bbox[0]);
       
$ysize = abs($bbox[5] - $bbox[3]);
       
$tmpImage = imagecreatetruecolor($xsize*1.25, $ysize*1.25);        // need the extra space to accommodate risers and descenders
       
$transparent = imagecolorallocate($tmpImage, 255, 255, 154);
        if (!
$transparent) {
           
error_log("Color allocate failed");
        }
       
imagecolortransparent($tmpImage, $transparent);
        if (!
imagefill($tmpImage, 0, $ysize, $transparent)) {
           
error_log("Fill failed");
        }
       
$rgb = imagecolorsforindex($image, $inColor);
       
$color = imagecolorexact($tmpImage, $rgb['red'], $rgb['green'], $rgb['blue']);
        if (
$color == -1) {
           
$color = imagecolorallocate($tmpImage, $rgb['red'], $rgb['green'], $rgb['blue']);
            if (!
$color) {
               
error_log("Color allocate 2 failed");
            }
        }

       
$newbbox = imagefttext($tmpImage, $size, 0, 0, $ysize*1.0, $color, $fontfile, $text, $info);
       
$tmpImage = imagerotate($tmpImage, $angle, $transparent);
       
$newWidth = imagesx($tmpImage);
       
$newHt = imagesy($tmpImage);
       
imagecopymerge($image, $tmpImage, $x-$newWidth+$dropdown, $y-$newHt, 0, 0, $newWidth, $newHt, 100);
       
//        Highlight the desired starting point (baseline) with a green dot:
//        $green = imagecolorallocate($image, 0, 251, 0);
//        imagefilledellipse($image, $x, $y, 10, 10, $green);
       
imagedestroy($tmpImage);
?>

-Dave
To Top