1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 322205 $ -->
<refentry xml:id="swfdisplayitem.multcolor" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SWFDisplayItem::multColor</refname>
<refpurpose>Multiplies the item's color transform</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SWFDisplayItem::multColor</methodname>
<methodparam><type>float</type><parameter>red</parameter></methodparam>
<methodparam><type>float</type><parameter>green</parameter></methodparam>
<methodparam><type>float</type><parameter>blue</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>a</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>swfdisplayitem::multcolor</function> multiplies the item's
color transform by the given values.
</para>
<simpara>
The object may be a <function>swfshape</function>, a
<function>swfbutton</function>, a <function>swftext</function> or a
<function>swfsprite</function> object. It must have been added using
the <function>swfmovie::add</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
These parameters are floats between 0.0 and 1.0:
<variablelist>
<varlistentry>
<term><parameter>red</parameter></term>
<listitem>
<para>
Value of red component
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>green</parameter></term>
<listitem>
<para>
Value of green component
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blue</parameter></term>
<listitem>
<para>
Value of blue component
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>a</parameter></term>
<listitem>
<para>
Value of alpha component
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
This simple example will modify your picture's atmosphere
to Halloween (use a landscape or bright picture).
<example>
<title><function>swfdisplayitem::multcolor</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$b = new SWFBitmap(file_get_contents("backyard.jpg"));
// note use your own picture :-)
$s = new SWFShape();
$s->setRightFill($s->addFill($b));
$s->drawLine($b->getWidth(), 0);
$s->drawLine(0, $b->getHeight());
$s->drawLine(-$b->getWidth(), 0);
$s->drawLine(0, -$b->getHeight());
$m = new SWFMovie();
$m->setDimension($b->getWidth(), $b->getHeight());
$i = $m->add($s);
for ($n=0; $n<=20; ++$n) {
$i->multColor(1.0-$n/10, 1.0, 1.0);
$i->addColor(0xff*$n/20, 0, 0);
$m->nextFrame();
}
header('Content-type: application/x-shockwave-flash');
$m->output();
?>
]]>
</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
-->
|