transformimagecolorspace.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="imagick.transformimagecolorspace" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Imagick::transformImageColorspace</refname>

  <refpurpose>Transforms an image to a new colorspace.</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;

  <methodsynopsis role="oop">
   <type>bool</type><methodname>Imagick::transformImageColorspace</methodname>
   <methodparam><type>int</type><parameter>colorspace</parameter></methodparam>
  </methodsynopsis>
  <para>
    Transforms an image to a new colorspace.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>colorspace</parameter></term>
    <listitem>
     <para>
       The colorspace the image should be transformed to, one of the <link linkend="imagick.constants.colorspace">COLORSPACE constants</link> e.g. Imagick::COLORSPACE_CMYK.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>



 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="classname.methodname.example.basic">
   <title><methodname>Imagick::transformImageColorspace</methodname> example</title>
   <para>
   Transforms an image to a new colorspace, and then extracts a single channel so that the individual channel values can be viewed.
   </para>

   <programlisting role="php">
<![CDATA[
<?php
function transformImageColorspace($imagePath, $colorSpace, $channel) {
    $imagick = new \Imagick(realpath($imagePath));
    $imagick->transformimagecolorspace($colorSpace);
    //channel should be one of the channel constants e.g. \Imagick::CHANNEL_BLUE 
    $imagick->separateImageChannel($channel);
    header("Content-Type: image/jpg");
    echo $imagick->getImageBlob();
}
?>
]]>
   </programlisting>

  </example>
 </refsect1>


 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Imagick::setColorSpace</methodname></member>
  </simplelist>
 </refsect1>



 <refsect1 role="examples">
  &reftitle.examples;
  <para>
    <example>
      <title> <function>Imagick::transformImageColorspace</function></title>
      <programlisting role="php">
      <![CDATA[
<?php
function transformImageColorspace($imagePath, $colorSpace, $channel) {
    $imagick = new \Imagick(realpath($imagePath));
    $imagick->transformimagecolorspace($colorSpace);
    $imagick->separateImageChannel($channel);
    header("Content-Type: image/jpg");
    echo $imagick->getImageBlob();
}

?>
]]>
      </programlisting>
    </example>
  </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
-->