php-doc-en/reference/ps/functions/ps-open-image.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-open-image" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_open_image</refname>
  <refpurpose>Reads an image for later placement</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>ps_open_image</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>type</parameter></methodparam>
   <methodparam><type>string</type><parameter>source</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>int</type><parameter>lenght</parameter></methodparam>
   <methodparam><type>int</type><parameter>width</parameter></methodparam>
   <methodparam><type>int</type><parameter>height</parameter></methodparam>
   <methodparam><type>int</type><parameter>components</parameter></methodparam>
   <methodparam><type>int</type><parameter>bpc</parameter></methodparam>
   <methodparam><type>string</type><parameter>params</parameter></methodparam>
  </methodsynopsis>
   <para>
    Reads an image which is already available in memory. The parameter
    <parameter>source</parameter> is currently not evaluated and assumed to be
    <literal>memory</literal>. The image data is a sequence of pixels starting
    in th upper left corner and ending in the lower right corner. Each pixel
    consists of <parameter>components</parameter> color components, and each
    component has <parameter>bpc</parameter> bits.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Resource identifier of the postscript file
       as returned by <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       The type of the image. Possible values are <literal>png</literal>,
       <literal>jpeg</literal>, or <literal>eps</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>source</parameter></term>
     <listitem>
      <para>
       Not used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       The image data.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       The length of the image data.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       The width of the image.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       The height of the image.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>components</parameter></term>
     <listitem>
      <para>
       The number of components for each pixel. This can be
       1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba images).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bpc</parameter></term>
     <listitem>
      <para>
       Number of bits per component (quite often 8).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>params</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns identifier of image or zero in case of an error. The identifier is
   a positive number greater than 0.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ps_open_image_file</function></member>
    <member><function>ps_place_image</function></member>
    <member><function>ps_close_image</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:"~/.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
-->