File: imagefilledrectangle.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (131 lines) | stat: -rw-r--r-- 3,490 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
131
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.imagefilledrectangle" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagefilledrectangle</refname>
  <refpurpose>Draw a filled rectangle</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imagefilledrectangle</methodname>
   <methodparam><type>resource</type><parameter>image</parameter></methodparam>
   <methodparam><type>int</type><parameter>x1</parameter></methodparam>
   <methodparam><type>int</type><parameter>y1</parameter></methodparam>
   <methodparam><type>int</type><parameter>x2</parameter></methodparam>
   <methodparam><type>int</type><parameter>y2</parameter></methodparam>
   <methodparam><type>int</type><parameter>color</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a rectangle filled with <parameter>color</parameter> in the given
   <parameter>image</parameter> starting at point 1 and ending at point 2.
   0, 0 is the top left corner of the image.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>x1</parameter></term>
     <listitem>
      <para>
       x-coordinate for point 1.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y1</parameter></term>
     <listitem>
      <para>
       y-coordinate for point 1.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>x2</parameter></term>
     <listitem>
      <para>
       x-coordinate for point 2.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y2</parameter></term>
     <listitem>
      <para>
       y-coordinate for point 2.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>color</parameter></term>
     <listitem>
      <para>
       The fill color. A color identifier created with 
       <function>imagecolorallocate</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imagefilledrectangle</function> usage</title>
    <programlisting role="php">
<![CDATA[
<?php
// Create a 55x30 image
$im = imagecreatetruecolor(55, 30);
$white = imagecolorallocate($im, 255, 255, 255);

// Draw a white rectangle
imagefilledrectangle($im, 4, 4, 50, 25, $white);

// Save the image
imagepng($im, './imagefilledrectangle.png');
imagedestroy($im);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <mediaobject>
     <imageobject>
      <imagedata fileref="figures/image.imagefilledrectangle.png"/>
     </imageobject>
    </mediaobject>
   </example>
  </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
-->