File: imagepstext.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (130 lines) | stat: -rw-r--r-- 4,915 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/image.xml, last change in rev 1.2 -->
  <refentry id="function.imagepstext">
   <refnamediv>
    <refname>imagepstext</refname>
    <refpurpose>To draw a text string over an image using PostScript Type1 fonts</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>imagepstext</methodname>
      <methodparam><type>resource</type><parameter>image</parameter></methodparam>
      <methodparam><type>string</type><parameter>text</parameter></methodparam>
      <methodparam><type>int</type><parameter>font</parameter></methodparam>
      <methodparam><type>int</type><parameter>size</parameter></methodparam>
      <methodparam><type>int</type><parameter>foreground</parameter></methodparam>
      <methodparam><type>int</type><parameter>background</parameter></methodparam>
      <methodparam><type>int</type><parameter>x</parameter></methodparam>
      <methodparam><type>int</type><parameter>y</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>space</parameter></methodparam>
      <methodparam><type>int</type><parameter>tightness</parameter></methodparam>
      <methodparam><type>float</type><parameter>angle</parameter></methodparam>
      <methodparam><type>int</type><parameter>antialias_steps</parameter></methodparam>
     </methodsynopsis>
    <para>
     <parameter>foreground</parameter> is the color in which the text
     will be painted.  <parameter>Background</parameter> is the color
     to which the text will try to fade in with antialiasing. No
     pixels with the color <parameter>background</parameter> are
     actually painted, so the background image does not need to be of
     solid color.
    </para>
    <para>
     The coordinates given by <parameter>x</parameter>,
     <parameter>y</parameter> will define the origin (or reference
     point) of the first character (roughly the lower-left corner of
     the character).  This is different from the
     <function>imagestring</function>, where <parameter>x</parameter>,
     <parameter>y</parameter> define the upper-right corner of the
     first character. Refer to PostScript documentation about fonts and
     their measuring system if you have trouble understanding how this
     works.
    </para>
    <para>
     <parameter>space</parameter> 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.
    </para>
    <para>
     <parameter>tightness</parameter> 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.
    </para>
    <para>
     <parameter>angle</parameter> is in degrees.
    </para>
    <para>
     <parameter>size</parameter> is expressed in pixels.
    </para>
    <para>
     <parameter>antialias_steps</parameter> 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.
    </para>
    <para>
     Parameters <parameter>space</parameter> and
     <parameter>tightness</parameter> are expressed in character space
     units, where 1 unit is 1/1000th of an em-square.
    </para>
    <para>
     Parameters <parameter>space</parameter>,
     <parameter>tightness</parameter>, <parameter>angle</parameter>
     and <parameter>antialias_steps</parameter> are optional.
    </para>
    
    &note.config.t1lib;
    
    <para>
     This function returns an array containing the following elements:
     <informaltable>
     <tgroup cols="2">
      <tbody>
       <row>
        <entry>0</entry>
        <entry>lower left x-coordinate</entry>
       </row>
       <row>
        <entry>1</entry>
        <entry>lower left y-coordinate</entry>
       </row>
       <row>
        <entry>2</entry>
        <entry>upper right x-coordinate</entry>
       </row>
       <row>
        <entry>3</entry>
        <entry>upper right y-coordinate</entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable></para>
    <para>
     See also <function>imagepsbbox</function>.
    </para>
   </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:"../../../../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
-->