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

105 lines
3.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cairocontext.devicetouserdistance" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CairoContext::deviceToUserDistance</refname>
<refname>cairo_device_to_user_distance</refname>
<refpurpose>Transform a distance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>CairoContext::deviceToUserDistance</methodname>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
<type>array</type><methodname>cairo_device_to_user_distance</methodname>
<methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
Transform a distance vector from device space to user space. This function is similar to
<methodname>CairoContext::deviceToUser</methodname> or <function>cairo_device_to_user</function>
except that the translation components of the inverse Cairo Transformation Matrix will be
ignored when transforming (<parameter>x</parameter>,<parameter>y</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>x</parameter></term>
<listitem>
<para>
X component of a distance vector
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
Y component of a distance vector
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with the x and y values of a distance vector in the user-space
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>CairoContext::deviceToUser</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
-->