php-doc-en/reference/cairo/cairocontext/copypathflat.xml
2012-01-11 06:50:17 +00:00

143 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cairocontext.copypathflat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CairoContext::copyPathFlat</refname>
<refname>cairo_copy_path_flat</refname>
<refpurpose>Gets a flattened copy of the current path</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>CairoPath</type><methodname>CairoContext::copyPathFlat</methodname>
<void />
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
<type>CairoPath</type><methodname>cairo_copy_path_flat</methodname>
<methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<para>
Gets a flattened copy of the current path and returns it to the user as a <classname>CairoPath.</classname>
</para>
<para>
This function is like <methodname>CairoContext::copyPath</methodname> except that any curves
in the path will be approximated with piecewise-linear approximations,
(accurate to within the current tolerance value). That is, the result is guaranteed to not
have any elements of type CAIRO_PATH_CURVE_TO which will instead be replaced by a series of
CAIRO_PATH_LINE_TO elements.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
A CairoContext object
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A copy of the current path
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
$surface = new CairoImageSurface(CairoFormat::ARGB32, 50, 50);
$context = new CairoContext($surface);
var_dump($context->copyPathFlat());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(CairoPath)#3 (0) {
}
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
$surface = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, 50, 50);
$context = cairo_create($surface);
var_dump(cairo_copy_path_flat($context));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(CairoPath)#3 (0) {
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>CairoContext::copyPath</methodname></member>
<member><methodname>CairoContext::closePath</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
-->