File: curveto.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (203 lines) | stat: -rw-r--r-- 5,820 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297101 $ -->

<refentry xml:id="cairocontext.curveto" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>CairoContext::curveTo</refname>
  <refname>cairo_curve_to</refname>
  <refpurpose>Adds a curve</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>Object oriented style (method):</para>
   <methodsynopsis>
   <modifier>public</modifier> <type>void</type><methodname>CairoContext::curveTo</methodname>
   <methodparam><type>float</type><parameter>x1</parameter></methodparam>
   <methodparam><type>float</type><parameter>y1</parameter></methodparam>
   <methodparam><type>float</type><parameter>x2</parameter></methodparam>
   <methodparam><type>float</type><parameter>y2</parameter></methodparam>
   <methodparam><type>float</type><parameter>x3</parameter></methodparam>
   <methodparam><type>float</type><parameter>y3</parameter></methodparam>
   </methodsynopsis>
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>void</type><methodname>cairo_curve_to</methodname>
   <methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
   <methodparam><type>float</type><parameter>x1</parameter></methodparam>
   <methodparam><type>float</type><parameter>y1</parameter></methodparam>
   <methodparam><type>float</type><parameter>x2</parameter></methodparam>
   <methodparam><type>float</type><parameter>y2</parameter></methodparam>
   <methodparam><type>float</type><parameter>x3</parameter></methodparam>
   <methodparam><type>float</type><parameter>y3</parameter></methodparam>
  </methodsynopsis>
  <para>
   Adds a cubic Bezier spline to the path from the current point to position <parameter>x3</parameter>
   ,<parameter>y3</parameter> in user-space coordinates, using <parameter>x1</parameter>,
   <parameter>y1</parameter> and <parameter>x2</parameter>, <parameter>y2</parameter> as the control
   points. After this call the current point will be <parameter>x3</parameter>, <parameter>y3</parameter>.
  </para>
  <para>
    If there is no current point before the call to <methodname>CairoContext::curveTo</methodname>
    this function will behave as if preceded by a call to <methodname>CairoContext::moveTo</methodname>
    (<parameter>x1</parameter>, <parameter>y1</parameter>).
  </para>
 
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       A valid <classname>CairoContext</classname> object created with
       <methodname>CairoContext::__construct</methodname> or <function>cairo_create</function>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>x1</parameter></term>
     <listitem>
      <para>
       First control point in the x axis for the curve
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y1</parameter></term>
     <listitem>
      <para>
       First control point in the y axis for the curve
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>x2</parameter></term>
     <listitem>
      <para>
       Second control point in x axis for the curve
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y2</parameter></term>
     <listitem>
      <para>
       Second control point in y axis for the curve
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>x3</parameter></term>
     <listitem>
      <para>
       Final point in the x axis for the curve
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y3</parameter></term>
     <listitem>
      <para>
       Final point in the y axis for the curve
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Object oriented style</title>
    <programlisting role="php">
<![CDATA[
<?php
$s = new CairoImageSurface(CairoFormat::ARGB32, 100, 100);
$c = new CairoContext($s);

$c->setSourceRgb(0, 0, 0);

$c->paint();

$c->moveTo(10, 50); 
$c->setLineWidth(5);
$c->setSourceRgb(.1, 0, 1);
$c->curveTo(20, 80, 80, 20, 90, 50); 
$c->stroke();

$s->writeToPng(dirname(__FILE__) . '/curveTo.png');
]]>
     </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Procedural style</title>
    <programlisting role="php">
<![CDATA[
<?php

$s = cairo_image_surface_create(CAIRO_SURFACE_TYPE_IMAGE, 100, 100);
$c = cairo_create($s);

cairo_set_source_rgb($c, 0, 0, 0);

cairo_paint($c);

cairo_move_to($c, 10, 50);
cairo_set_line_width($c, 5);
cairo_set_source_rgb($c, .1, 0, 1);
cairo_curve_to($c, 20, 80, 80, 20, 90, 50);
cairo_stroke($c);

cairo_surface_write_to_png($s, dirname(__FILE__) . '/curve_to.png');
]]>
     </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>CairoContext::moveTo</methodname></member>
   </simplelist>
  </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:"~/.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
-->