php-doc-en/reference/swf/functions/swf-addcolor.xml

101 lines
2.5 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.swf-addcolor" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>swf_addcolor</refname>
<refpurpose>Set the global add color to the rgba value specified</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_addcolor</methodname>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
<methodparam><type>float</type><parameter>g</parameter></methodparam>
<methodparam><type>float</type><parameter>b</parameter></methodparam>
<methodparam><type>float</type><parameter>a</parameter></methodparam>
</methodsynopsis>
<para>
Sets the global add color to the specified color. This color is then
implicitly used by the <function>swf_placeobject</function>,
<function>swf_modifyobject</function> and
<function>swf_addbuttonrecord</function> functions.
</para>
<para>
The color of the object will be add by the given values when the object is
written to the screen.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>r</parameter></term>
<listitem>
<para>
Red value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>g</parameter></term>
<listitem>
<para>
Green value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>b</parameter></term>
<listitem>
<para>
Blue value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>a</parameter></term>
<listitem>
<para>
Alpha value
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
These parameters can be either positive or negative.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</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
-->