php-doc-en/reference/cpdf/functions/cpdf-place-inline-image.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

134 lines
3.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.cpdf-place-inline-image" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>cpdf_place_inline_image</refname>
<refpurpose>Places an image on the page</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>cpdf_place_inline_image</methodname>
<methodparam><type>int</type><parameter>pdf_document</parameter></methodparam>
<methodparam><type>int</type><parameter>image</parameter></methodparam>
<methodparam><type>float</type><parameter>x_coor</parameter></methodparam>
<methodparam><type>float</type><parameter>y_coor</parameter></methodparam>
<methodparam><type>float</type><parameter>angle</parameter></methodparam>
<methodparam><type>float</type><parameter>width</parameter></methodparam>
<methodparam><type>float</type><parameter>height</parameter></methodparam>
<methodparam><type>int</type><parameter>gsave</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Places an image created with the PHP image functions on the page.
The image can be scaled at the same time.
</para>
<note>
<simpara>
This function is only available if PHP was compiled with the GD Graphics
Library 1.3. See the <link linkend="image.requirements">GD extension</link>
installation instructions for further information.
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&cpdf.pdf-document.description;
<varlistentry>
<term><parameter>image</parameter></term>
<listitem>
<para>
An image created with the PHP image functions
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x_coor</parameter></term>
<listitem>
<para>
The x-coordinate of the image
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y_coor</parameter></term>
<listitem>
<para>
The y-coordinate of the image
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>angle</parameter></term>
<listitem>
<para>
The image rotation angle, in degrees
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The image width
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
The image height
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>gsave</parameter></term>
<listitem>
<para>
Should be non-zero to allow this function to operate correctly
</para>
</listitem>
</varlistentry>
&cpdf.mode.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cpdf_import_jpeg</function></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:"../../../../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
-->