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

126 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cairomatrix.inittranslate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CairoMatrix::initTranslate</refname>
<refname>cairo_matrix_init_translate</refname>
<refpurpose>Creates a new translation matrix</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (method):</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>CairoMatrix::initTranslate</methodname>
<methodparam><type>float</type><parameter>tx</parameter></methodparam>
<methodparam><type>float</type><parameter>ty</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
<type>object</type><methodname>cairo_matrix_init_translate</methodname>
<methodparam><type>float</type><parameter>tx</parameter></methodparam>
<methodparam><type>float</type><parameter>ty</parameter></methodparam>
</methodsynopsis>
<para>
Creates a new matrix to a transformation that translates by tx and ty in the X
and Y dimensions, respectively.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>tx</parameter></term>
<listitem>
<para>
amount to translate in the X direction
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ty</parameter></term>
<listitem>
<para>
amount to translate in the Y direction
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a new Matrix */
$matrix = CairoMatrix::initTranslate(1.0, 2.0);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a new Matrix */
$matrix = cairo_matrix_init_translate(1.0, 2.0);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>CairoMatrix::__construct</methodname></member>
<member><methodname>CairoMatrix::initIdentity</methodname></member>
<member><methodname>CairoMatrix::initRotate</methodname></member>
<member><methodname>CairoMatrix::initScale</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
-->