doc-fr/reference/ps/functions/ps-open-image.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.ps-open-image" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_open_image</refname>
  <refpurpose>Lit une image pour placement futur</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>
   Lit une image qui est déjà disponible en mémoire. Le paramètre
   <parameter>source</parameter> n'est présentent pas évalué et est assumé
   d'être <literal>memory</literal>. Les données de l'image est une séquence
   de pixels démarrant avec le coin supérieur gauche et termine avec le coin
   inférieur droit. Chaque pixel consiste de composants de couleur
   <parameter>components</parameter> et chaque composant a
   <parameter>bpc</parameter> bits.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Identifiant d'un fichier postscript retourné par
       <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       Type de l'image. Les valeurs possibles sont <literal>png</literal>,
       <literal>jpeg</literal> ou <literal>eps</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>source</parameter></term>
     <listitem>
      <para>
       Non utilisé.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Les données de l'image.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       La taille des données de l'image.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       La largeur de l'image.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       La hauteur de l'image.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>components</parameter></term>
     <listitem>
      <para>
       Le nombre de composant pour chaque pixel. Cela peut être 1 (images à
       échelle de gris), 3 (images rgb) ou 4 (images cmyk, rgba).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bpc</parameter></term>
     <listitem>
      <para>
       Nombre de bits par composant (très souvent 8).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>params</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne l'identifiant de l'image ou zéro en cas d'erreur. L'identifiant
   est un nombre positif supérieur à &zero;.
  </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
-->