Added documentation for Imagick::setImageOpacity

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242516 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mikko Koppanen 2007-09-13 22:43:49 +00:00
parent 5f4657f17f
commit 323efa47cd
2 changed files with 143 additions and 1 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.imagick">
@ -1113,6 +1113,7 @@
&reference.imagick.imagick.negateimage;
&reference.imagick.imagick.newimage;
&reference.imagick.imagick.setimage;
&reference.imagick.imagick.setimageopacity;
&reference.imagick.imagick.newpseudoimage;
&reference.imagick.imagick.nextimage;
&reference.imagick.imagick.normalizeimage;

View file

@ -0,0 +1,141 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-setimageopacity">
<refnamediv>
<refname>Imagick::setImageOpacity</refname>
<refpurpose>Sets the image opacity level</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>Imagick::setImageOpacity</methodname>
<methodparam><type>float</type><parameter>opacity</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.experimental.func;
<para>
Sets the image to the specified opacity level. This method is present if Imagick is compiled against
ImageMagick 6.3.1 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>opacity</parameter></term>
<listitem>
<para>
The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&imagick.return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Imagick::setImageOpacity</function> example</title>
<para>
An example of using Imagick::setImageOpacity()
</para>
<programlisting role="php">
<![CDATA[
<?php
/* Create the object */
$image = new Imagick('source.png');
/* Set the opacity */
$image->setImageOpacity(0.7);
/* output the image */
header('Content-type: image/png');
echo $image;
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></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:"../../../../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
-->