archived-doc-ja/reference/ps/functions/ps-open-image.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: takagi Status: ready -->
<refentry xml:id="function.ps-open-image" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_open_image</refname>
  <refpurpose>後で配置するために画像を読み込む</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>
    すでにメモリ上にある画像を読み込みます。現在は <parameter>source</parameter>
    は評価されず、常に <literal>memory</literal> と仮定されます。
    画像データは、左上から右下に向かってピクセルデータを順に並べたものです。
    各ピクセルは、色コンポーネント <parameter>components</parameter>
    で構成されており、このコンポーネントの大きさは <parameter>bpc</parameter>
    ビットです。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       <function>ps_new</function> が返す、postscript
       ファイルのリソース ID。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       画像の形式。<literal>png</literal>、
       <literal>jpeg</literal> あるいは <literal>eps</literal>。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>source</parameter></term>
     <listitem>
      <para>
       使用されません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       画像データ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       画像データの長さ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       画像の幅。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       画像の高さ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>components</parameter></term>
     <listitem>
      <para>
       各ピクセルのコンポーネントの数。
       1 (グレースケール画像)、
       3 (rgb 画像)
       あるいは 4 (cmyk, rgba 画像)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bpc</parameter></term>
     <listitem>
      <para>
       コンポーネント単位のビット数 (ほとんどの場合は 8)
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>params</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    成功した場合に画像の ID を、失敗した場合にゼロを返します。
    ID は、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
-->