archived-doc-pt-br/reference/ps/functions/ps-open-image.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c6fb604f39a0fa7bf1ae872064b2a3a24f23d855 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<!-- 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>Lê uma imagem para posicionamento posterior</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>length</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>
    Lê uma imagem que já está disponível na memória. O parâmetro
    <parameter>source</parameter> não é avaliado atualmente e assume-se que é
    <literal>memory</literal>. Os dados da imagem são uma sequência de pixels que começa
    no canto superior esquerdo e termina no canto inferior direito. Cada pixel
    consiste em <parameter>components</parameter> componentes de cor, e cada
    componente possui bits <parameter>bpc</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Identificador de recurso do arquivo postscript
       conforme retornado por <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       O tipo da imagem. Os valores possíveis são <literal>png</literal>,
       <literal>jpeg</literal> ou <literal>eps</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>source</parameter></term>
     <listitem>
      <para>
       Não usado.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Os dados da imagem.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       O comprimento dos dados da imagem.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       A largura da imagem.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       A altura da imagem.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>components</parameter></term>
     <listitem>
      <para>
       O número de componentes para cada pixel. Pode ser
       1 (imagens em escala de cinza), 3 (imagens RGB) ou 4 (imagens CMYK, RGBA).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bpc</parameter></term>
     <listitem>
      <para>
       Número de bits por componente (geralmente 8).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>params</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna o identificador da imagem ou zero em caso de erro. O identificador é
   um número positivo maior que 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
-->