sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ref.swf: switch to new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228897 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-02-03 18:55:13 +00:00
parent 0cc4c6fffc
commit a3af373ef1
67 changed files with 2477 additions and 627 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
reference/swf/functions/swf-actiongeturl.xml
View file

@ -1,22 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-actiongeturl">
<refnamediv>
<refname>swf_actiongeturl</refname>
<refpurpose>Get a URL from a Shockwave Flash movie</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actiongeturl</methodname>
<methodparam><type>string</type><parameter>url</parameter></methodparam>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_actiongeturl</function> function gets the URL
specified by the parameter <parameter>url</parameter> with the
target <parameter> target</parameter>.
Gets the URL specified by the parameter <parameter>url</parameter> with
the given <parameter> target</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>url</parameter></term>
<listitem>
<para>
The URL, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
The target, as a string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

31
reference/swf/functions/swf-actiongotoframe.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-actiongotoframe">
<refnamediv>
<refname>swf_actiongotoframe</refname>
<refpurpose>Play a frame and then stop</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actiongotoframe</methodname>
<methodparam><type>int</type><parameter>framenumber</parameter></methodparam>
@ -18,6 +18,29 @@
it, and then stop.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>framenumber</parameter></term>
<listitem>
<para>
The frame number.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/swf/functions/swf-actiongotolabel.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-actiongotolabel">
<refnamediv>
<refname>swf_actiongotolabel</refname>
<refpurpose>Display a frame with the specified label</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actiongotolabel</methodname>
<methodparam><type>string</type><parameter>label</parameter></methodparam>
@ -18,6 +18,29 @@
<parameter>label</parameter> parameter and then stops.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>label</parameter></term>
<listitem>
<para>
The frame label.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/swf/functions/swf-actionnextframe.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-actionnextframe">
<refnamediv>
<refname>swf_actionnextframe</refname>
<refpurpose>Go forward one frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actionnextframe</methodname>
<void/>
@ -16,6 +16,13 @@
Go forward one frame.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/swf/functions/swf-actionplay.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-actionplay">
<refnamediv>
<refname>swf_actionplay</refname>
<refpurpose>Start playing the flash movie from the current frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actionplay</methodname>
<void/>
@ -16,6 +16,13 @@
Start playing the flash movie from the current frame.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/swf/functions/swf-actionprevframe.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-actionprevframe">
<refnamediv>
<refname>swf_actionprevframe</refname>
<refpurpose>Go backwards one frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actionprevframe</methodname>
<void/>
@ -16,6 +16,13 @@
&warn.undocumented.func;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

34
reference/swf/functions/swf-actionsettarget.xml
View file

@ -1,23 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-actionsettarget">
<refnamediv>
<refname>swf_actionsettarget</refname>
<refpurpose>Set the context for actions</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actionsettarget</methodname>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_actionsettarget</function> function sets the
context for all actions. You can use this to control other flash
Sets the context for all actions. You can use this to control other flash
movies that are currently playing.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
The target, as a string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/swf/functions/swf-actionstop.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-actionstop">
<refnamediv>
<refname>swf_actionstop</refname>
<refpurpose>Stop playing the flash movie at the current frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actionstop</methodname>
<void/>
@ -16,6 +16,14 @@
Stop playing the flash movie at the current frame.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/swf/functions/swf-actiontogglequality.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-actiontogglequality">
<refnamediv>
<refname>swf_actiontogglequality</refname>
<refpurpose>Toggle between low and high quality</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actiontogglequality</methodname>
<void/>
@ -16,6 +16,13 @@
Toggle the flash movie between high and low quality.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/swf/functions/swf-actionwaitforframe.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-actionwaitforframe">
<refnamediv>
<refname>swf_actionwaitforframe</refname>
<refpurpose>Skip actions if a frame has not been loaded</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_actionwaitforframe</methodname>
<methodparam><type>int</type><parameter>framenumber</parameter></methodparam>
@ -22,6 +22,37 @@
for "Loading..." type animations.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>framenumber</parameter></term>
<listitem>
<para>
The frame number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>skipcount</parameter></term>
<listitem>
<para>
The number of actions to skip.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

73
reference/swf/functions/swf-addbuttonrecord.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.swf-addbuttonrecord">
<refnamediv>
<refname>swf_addbuttonrecord</refname>
<refpurpose>Controls location, appearance and active area of the current button</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_addbuttonrecord</methodname>
<methodparam><type>int</type><parameter>states</parameter></methodparam>
@ -15,19 +15,59 @@
<methodparam><type>int</type><parameter>depth</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_addbuttonrecord</function> function allows you
to define the specifics of using a button. The first parameter,
<parameter>states</parameter>, defines what states the button can
have, these can be any or all of the following constants:
BSHitTest, BSDown, BSOver or BSUp. The second parameter, the
<parameter>shapeid</parameter> is the look of the button, this is
usually the object id of the shape of the button. The
<parameter>depth</parameter> parameter is the placement of the
button in the current frame.
Allow you to define the specifics of using a button.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>states</parameter></term>
<listitem>
<para>
Defines what states the button can have, these can be any or all of
the following constants: <constant>BSHitTest</constant>,
<constant>BSDown</constant>, <constant>BSOver</constant> or
<constant>BSUp</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>shapeid</parameter></term>
<listitem>
<para>
The second parameter, the <parameter>shapeid</parameter> is the look
of the button, this is usually the object id of the shape of the
button.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
<para>
This parameter is the placement of the button in the current frame.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>swf_addbuttonrecord</function> example
</title>
<title><function>swf_addbuttonrecord</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -44,6 +84,7 @@ swf_endButton();
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

80
reference/swf/functions/swf-addcolor.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-addcolor">
<refnamediv>
<refname>swf_addcolor</refname>
<refpurpose>Set the global add color to the rgba value specified</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_addcolor</methodname>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
@ -16,21 +16,65 @@
<methodparam><type>float</type><parameter>a</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_addcolor</function> function sets the global
add color to the <parameter>rgba</parameter> color specified.
This color is then used (implicitly) by the
<function>swf_placeobject</function>,
<function>swf_modifyobject</function> and the
<function>swf_addbuttonrecord</function> functions. The color of
the object will be add by the <parameter>rgba</parameter> values
when the object is written to the screen.
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>
<note>
<para>
The <parameter>rgba</parameter> values can be either positive or
negative.
</para>
</note>
</refsect1>
</refentry>

43
reference/swf/functions/swf-closefile.xml
View file

@ -1,23 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.swf-closefile">
<refnamediv>
<refname>swf_closefile</refname>
<refpurpose>Close the current Shockwave Flash file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_closefile</methodname>
<type>mixed</type><methodname>swf_closefile</methodname>
<methodparam choice="opt"><type>int</type><parameter>return_file</parameter></methodparam>
</methodsynopsis>
<para>
Close a file that was opened by the
<function>swf_openfile</function> function. If the
<parameter>return_file</parameter> parameter is set then the contents
of the SWF file are returned from the function.
<function>swf_openfile</function> function.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>return_file</parameter></term>
<listitem>
<para>
If set then the contents of the SWF file are returned from the
function.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If <parameter>return_file</parameter> is provided returns the SWF
contents, otherwise returns &null;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>

43
reference/swf/functions/swf-definebitmap.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-definebitmap">
<refnamediv>
<refname>swf_definebitmap</refname>
<refpurpose>Define a bitmap</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_definebitmap</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
@ -15,8 +15,39 @@
</methodsynopsis>
<para>
The <function>swf_definebitmap</function> function defines a
bitmap given a GIF, JPEG, RGB or FI image. The image will be
converted into a Flash JPEG or Flash color map format.
bitmap given an image.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
An SWF object id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>image_name</parameter></term>
<listitem>
<para>
A GIF, JPEG, RGB or FI image. The image will be converted into a Flash
JPEG or Flash color map format.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

45
reference/swf/functions/swf-definefont.xml
View file

@ -1,26 +1,55 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-definefont">
<refnamediv>
<refname>swf_definefont</refname>
<refpurpose>Defines a font</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_definefont</methodname>
<methodparam><type>int</type><parameter>fontid</parameter></methodparam>
<methodparam><type>string</type><parameter>fontname</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_definefont</function> function defines a font
given by the <parameter>fontname</parameter> parameter and gives
it the id specified by the <parameter>fontid</parameter>
parameter. It then sets the font given by <parameter>
The <function>swf_definefont</function> function defines a font parameter
and gives it the specified id. It then sets the font given by <parameter>
fontname</parameter> to the current font.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fontid</parameter></term>
<listitem>
<para>
The id to be given to the font.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fontname</parameter></term>
<listitem>
<para>
The font so be set as current font.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

79
reference/swf/functions/swf-defineline.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-defineline">
<refnamediv>
<refname>swf_defineline</refname>
<refpurpose>Define a line</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_defineline</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
@ -18,13 +18,70 @@
<methodparam><type>float</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_defineline</function> defines a line starting
from the x coordinate given by <parameter>x1</parameter> and the
y coordinate given by <parameter>y1</parameter> parameter. Up
to the x coordinate given by the <parameter>x2</parameter>
parameter and the y coordinate given by the
<parameter>y2</parameter> parameter. It will have a width
defined by the <parameter>width</parameter> parameter.
Defines a line.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x1</parameter></term>
<listitem>
<para>
x-coordinate of start point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y1</parameter></term>
<listitem>
<para>
y-coordinate of start point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x2</parameter></term>
<listitem>
<para>
x-coordinate of end point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y2</parameter></term>
<listitem>
<para>
y-coordinate of end point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The line width.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

66
reference/swf/functions/swf-definepoly.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-definepoly">
<refnamediv>
<refname>swf_definepoly</refname>
<refpurpose>Define a polygon</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_definepoly</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
@ -16,14 +16,56 @@
<methodparam><type>float</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_definepoly</function> function defines a
polygon given an array of x, y coordinates (the coordinates are
defined in the parameter <parameter>coords</parameter>). The
parameter <parameter>npoints</parameter> is the number of overall
points that are contained in the array given by
<parameter>coords</parameter>. The <parameter>width</parameter>
is the width of the polygon's border, if set to 0.0 the polygon
is filled.
Defines a polygon given an array of x, y coordinates.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>coords</parameter></term>
<listitem>
<para>
An array of x, y coordinates.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>npoints</parameter></term>
<listitem>
<para>
The number of overall points that are contained in the array given by
<parameter>coords</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The width of the polygon's border, if set to 0.0 the polygon is
filled.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

82
reference/swf/functions/swf-definerect.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-definerect">
<refnamediv>
<refname>swf_definerect</refname>
<refpurpose>Define a rectangle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_definerect</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
@ -18,14 +18,72 @@
<methodparam><type>float</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_definerect</function> defines a rectangle with
an upper left hand coordinate given by the x,
<parameter>x1</parameter>, and the y, <parameter>y1</parameter>.
And a lower right hand coordinate given by the x coordinate,
<parameter>x2</parameter>, and the y coordinate, <parameter>y2
</parameter>. Width of the rectangles border is given by the
<parameter>width</parameter> parameter, if the width is 0.0 then
the rectangle is filled.
Defines a rectangle with an upper left hand coordinate and a lower right
hand coordinate.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x1</parameter></term>
<listitem>
<para>
x-coordinate of upper left point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y1</parameter></term>
<listitem>
<para>
y-coordinate of upper left point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x2</parameter></term>
<listitem>
<para>
x-coordinate of lower right point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y2</parameter></term>
<listitem>
<para>
y-coordinate of lower right point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
Width of the rectangles border, if the width is 0.0 then the rectangle
is filled.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

54
reference/swf/functions/swf-definetext.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-definetext">
<refnamediv>
<refname>swf_definetext</refname>
<refpurpose>Define a text string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_definetext</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
@ -15,11 +15,47 @@
<methodparam><type>int</type><parameter>docenter</parameter></methodparam>
</methodsynopsis>
<para>
Define a text string (the <parameter>str</parameter> parameter)
using the current font and font size. The
<parameter>docenter</parameter> is where the word is centered, if
<parameter>docenter</parameter> is 1, then the word is centered
in x.
Defines a text string using the current font and font size.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>str</parameter></term>
<listitem>
<para>
The text, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>docenter</parameter></term>
<listitem>
<para>
The <parameter>docenter</parameter> is where the word is centered, if
<parameter>docenter</parameter> is 1, then the word is centered in x.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

15
reference/swf/functions/swf-endbutton.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-endbutton">
<refnamediv>
<refname>swf_endbutton</refname>
<refpurpose>End the definition of the current button</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_endbutton</methodname>
<void/>
@ -17,6 +17,13 @@
definition of the current button.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/swf/functions/swf-enddoaction.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-enddoaction">
<refnamediv>
<refname>swf_enddoaction</refname>
<refpurpose>End the current action</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_enddoaction</methodname>
<void/>
@ -17,6 +17,13 @@
<function>swf_startdoaction</function> function.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

15
reference/swf/functions/swf-endshape.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-endshape">
<refnamediv>
<refname>swf_endshape</refname>
<refpurpose>Completes the definition of the current shape</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_endshape</methodname>
<void/>
@ -17,6 +17,13 @@
the current shape.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

18
reference/swf/functions/swf-endsymbol.xml
View file

@ -1,23 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-endsymbol">
<refnamediv>
<refname>swf_endsymbol</refname>
<refpurpose>End the definition of a symbol</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_endsymbol</methodname>
<void/>
</methodsynopsis>
<para>
The <function>swf_endsymbol</function> function ends the
definition of a symbol that was started by the
Ends the definition of a symbol that was started by the
<function>swf_startsymbol</function> function.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/swf/functions/swf-fontsize.xml
View file

@ -1,21 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-fontsize">
<refnamediv>
<refname>swf_fontsize</refname>
<refpurpose>Change the font size</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_fontsize</methodname>
<methodparam><type>float</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_fontsize</function> function changes the font
size to the value given by the <parameter>size</parameter>
parameter.
Changes the font size to the value given by the
<parameter>size</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The font size, as an integer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

35
reference/swf/functions/swf-fontslant.xml
View file

@ -1,21 +1,44 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-fontslant">
<refnamediv>
<refname>swf_fontslant</refname>
<refpurpose>Set the font slant</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_fontslant</methodname>
<methodparam><type>float</type><parameter>slant</parameter></methodparam>
</methodsynopsis>
<para>
Set the current font slant to the angle indicated by the
<parameter>slant</parameter> parameter. Positive values create a
forward slant, negative values create a negative slant.
<parameter>slant</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>slant</parameter></term>
<listitem>
<para>
Positive values create a forward slant, negative values create a
negative slant.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

31
reference/swf/functions/swf-fonttracking.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-fonttracking">
<refnamediv>
<refname>swf_fonttracking</refname>
<refpurpose>Set the current font tracking</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_fonttracking</methodname>
<methodparam><type>float</type><parameter>tracking</parameter></methodparam>
@ -20,6 +20,29 @@
letters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>tracking</parameter></term>
<listitem>
<para>
The font tracking.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/swf/functions/swf-getbitmapinfo.xml
View file

@ -1,22 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-getbitmapinfo">
<refnamediv>
<refname>swf_getbitmapinfo</refname>
<refpurpose>Get information about a bitmap</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>swf_getbitmapinfo</methodname>
<methodparam><type>int</type><parameter>bitmapid</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_getbitmapinfo</function> function returns an
array of information about a bitmap given by the
<parameter>bitmapid</parameter> parameter. The returned array
has the following elements:
Returns information about a bitmap.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bitmapid</parameter></term>
<listitem>
<para>
The bitmap id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with the following elements:
<itemizedlist>
<listitem>
<simpara>

21
reference/swf/functions/swf-getfontinfo.xml
View file

@ -1,20 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-getfontinfo">
<refnamediv>
<refname>swf_getfontinfo</refname>
<refpurpose>The height in pixels of a capital A and a lowercase x</refpurpose>
<refpurpose>Gets font information</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>swf_getfontinfo</methodname>
<void/>
</methodsynopsis>
<para>
The <function>swf_getfontinfo</function> function returns an
associative array with the following parameters:
Gets information about the font by giving the height in pixels of a
capital A and a lowercase x.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with the following parameters:
<itemizedlist>
<listitem>
<simpara>

16
reference/swf/functions/swf-getframe.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-getframe">
<refnamediv>
<refname>swf_getframe</refname>
<refpurpose>Get the frame number of the current frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>swf_getframe</methodname>
<void/>
@ -17,6 +17,14 @@
the current frame.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current frame number, as an integer.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

34
reference/swf/functions/swf-labelframe.xml
View file

@ -1,20 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-labelframe">
<refnamediv>
<refname>swf_labelframe</refname>
<refpurpose>Label the current frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_labelframe</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Label the current frame with the name given by the
<parameter>name</parameter> parameter.
Labels the current frame with the given <parameter>name</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The frame label.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

90
reference/swf/functions/swf-lookat.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-lookat">
<refnamediv>
<refname>swf_lookat</refname>
<refpurpose>Define a viewing transformation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_lookat</methodname>
<methodparam><type>float</type><parameter>view_x</parameter></methodparam>
@ -19,15 +19,79 @@
<methodparam><type>float</type><parameter>twist</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_lookat</function> function defines a viewing
transformation by giving the viewing position (the parameters
<parameter>view_x</parameter>, <parameter>view_y</parameter>, and
<parameter>view_z</parameter>) and the coordinates of a reference
point in the scene, the reference point is defined by the
<parameter>reference_x</parameter>, <parameter>reference_y
</parameter>, and <parameter>reference_z</parameter> parameters.
The <parameter>twist</parameter> controls the rotation along
with viewer's z axis.
Defines a viewing transformation by giving the viewing position and the
coordinates of a reference point in the scene.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>view_x</parameter></term>
<listitem>
<para>
x-coordinate for the viewing position
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>view_y</parameter></term>
<listitem>
<para>
y-coordinate for the viewing position
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>view_z</parameter></term>
<listitem>
<para>
z-coordinate for the viewing position
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>reference_x</parameter></term>
<listitem>
<para>
x-coordinate for the reference point
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>reference_y</parameter></term>
<listitem>
<para>
y-coordinate for the reference point
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>reference_z</parameter></term>
<listitem>
<para>
z-coordinate for the reference point
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>twist</parameter></term>
<listitem>
<para>
Controls the rotation along with viewer's z axis.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

56
reference/swf/functions/swf-modifyobject.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-modifyobject">
<refnamediv>
<refname>swf_modifyobject</refname>
<refpurpose>Modify an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_modifyobject</methodname>
<methodparam><type>int</type><parameter>depth</parameter></methodparam>
@ -15,17 +15,47 @@
</methodsynopsis>
<para>
Updates the position and/or color of the object at the specified
depth, <parameter>depth</parameter>. The parameter
<parameter>how</parameter> determines what is updated.
<parameter>how</parameter> can either be the constant MOD_MATRIX
or MOD_COLOR or it can be a combination of both
(MOD_MATRIX|MOD_COLOR).
<parameter>depth</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
MOD_COLOR uses the current mulcolor (specified by the function
<function>swf_mulcolor</function>) and addcolor (specified by the
function <function>swf_addcolor</function>) to color the object.
MOD_MATRIX uses the current matrix to position the object.
<variablelist>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
<para>
The depth, as an integer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>how</parameter></term>
<listitem>
<para>
Determines what is updated. <parameter>how</parameter> can either be
the constant <constant>MOD_MATRIX</constant> or
<constant>MOD_COLOR</constant> or it can be a combination of both.
</para>
<para>
<constant>MOD_COLOR</constant> uses the current mulcolor (specified by
the function <function>swf_mulcolor</function>) and addcolor
(specified by the function <function>swf_addcolor</function>) to color
the object. <constant>MOD_MATRIX</constant> uses the current matrix to
position the object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

80
reference/swf/functions/swf-mulcolor.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-mulcolor">
<refnamediv>
<refname>swf_mulcolor</refname>
<refpurpose>Sets the global multiply color to the rgba value specified</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_mulcolor</methodname>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
@ -16,21 +16,65 @@
<methodparam><type>float</type><parameter>a</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_mulcolor</function> function sets the global
multiply color to the <parameter>rgba</parameter> color
specified. This color is then used (implicitly) by the
<function>swf_placeobject</function>,
<function>swf_modifyobject</function> and the
<function>swf_addbuttonrecord</function> functions. The color of
the object will be multiplied by the <parameter>rgba</parameter>
values when the object is written to the screen.
Sets the global multiply color to the given one. 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 multiplied by the given color 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>
<note>
<para>
The <parameter>rgba</parameter> values can be either positive or
negative.
</para>
</note>
</refsect1>
</refentry>

15
reference/swf/functions/swf-nextid.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-nextid">
<refnamediv>
<refname>swf_nextid</refname>
<refpurpose>Returns the next free object id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>swf_nextid</methodname>
<void/>
@ -17,6 +17,13 @@
available object id.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the id, as an integer.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

216
reference/swf/functions/swf-oncondition.xml
View file

@ -1,112 +1,134 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-oncondition">
<refnamediv>
<refname>swf_oncondition</refname>
<refpurpose>Describe a transition used to trigger an action list</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_oncondition</methodname>
<methodparam><type>int</type><parameter>transition</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_oncondition</function> function describes a
transition that will trigger an action list. There are several
types of possible transitions, the following are for buttons
defined as TYPE_MENUBUTTON:
<itemizedlist>
<listitem>
<simpara>
IdletoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoIdle
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OverDowntoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
IdletoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OutDowntoIdle
</simpara>
</listitem>
<listitem>
<simpara>
MenuEnter (IdletoOverUp|IdletoOverDown)
</simpara>
</listitem>
<listitem>
<simpara>
MenuExit (OverUptoIdle|OverDowntoIdle)
</simpara>
</listitem>
</itemizedlist>
For TYPE_PUSHBUTTON there are the following options:
<itemizedlist>
<listitem>
<simpara>
IdletoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoIdle
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OverDowntoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
OverDowntoOutDown
</simpara>
</listitem>
<listitem>
<simpara>
OutDowntoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OutDowntoIdle
</simpara>
</listitem>
<listitem>
<simpara>
ButtonEnter (IdletoOverUp|OutDowntoOverDown)
</simpara>
</listitem>
<listitem>
<simpara>
ButtonExit (OverUptoIdle|OverDowntoOutDown)
</simpara>
</listitem>
</itemizedlist>
transition that will trigger an action list.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>transition</parameter></term>
<listitem>
<para>
There are several types of possible transitions, the following are for
buttons defined as TYPE_MENUBUTTON:
<itemizedlist>
<listitem>
<simpara>
IdletoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoIdle
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OverDowntoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
IdletoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OutDowntoIdle
</simpara>
</listitem>
<listitem>
<simpara>
MenuEnter (IdletoOverUp|IdletoOverDown)
</simpara>
</listitem>
<listitem>
<simpara>
MenuExit (OverUptoIdle|OverDowntoIdle)
</simpara>
</listitem>
</itemizedlist>
For TYPE_PUSHBUTTON there are the following options:
<itemizedlist>
<listitem>
<simpara>
IdletoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoIdle
</simpara>
</listitem>
<listitem>
<simpara>
OverUptoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OverDowntoOverUp
</simpara>
</listitem>
<listitem>
<simpara>
OverDowntoOutDown
</simpara>
</listitem>
<listitem>
<simpara>
OutDowntoOverDown
</simpara>
</listitem>
<listitem>
<simpara>
OutDowntoIdle
</simpara>
</listitem>
<listitem>
<simpara>
ButtonEnter (IdletoOverUp|OutDowntoOverDown)
</simpara>
</listitem>
<listitem>
<simpara>
ButtonExit (OverUptoIdle|OverDowntoOutDown)
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

121
reference/swf/functions/swf-openfile.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-openfile">
<refnamediv>
<refname>swf_openfile</refname>
<refpurpose>Open a new Shockwave Flash file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_openfile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
@ -19,22 +19,107 @@
<methodparam><type>float</type><parameter>b</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_openfile</function> function opens a new file
named <parameter>filename</parameter> with a width of
<parameter>width</parameter> and a height of
<parameter>height</parameter> a frame rate of
<parameter>framerate</parameter> and background with a red color
of <parameter>r</parameter> a green color of
<parameter>g</parameter> and a blue color of
<parameter>b</parameter>.
</para>
<para>
The <function>swf_openfile</function> must be the first function
you call, otherwise your script will cause a segfault. If you
want to send your output to the screen make the filename:
"php://stdout" (support for this is in 4.0.1 and up).
Opens a new file. This must be the first function you call, otherwise your
script will not work.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The path to the SWF file. If you want to send your output to the
screen, set this to <literal>php://stdout</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The movie width
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
The movie height
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>framerate</parameter></term>
<listitem>
<para>
The frame rate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>r</parameter></term>
<listitem>
<para>
Red value for the background.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>g</parameter></term>
<listitem>
<para>
Green value for the background.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>b</parameter></term>
<listitem>
<para>
Blue value for the background.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.0.1</entry>
<entry>
Support for <literal>php://stdout</literal> was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

69
reference/swf/functions/swf-ortho.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-ortho">
<refnamediv>
<refname>swf_ortho</refname>
<refpurpose>Defines an orthographic mapping of user coordinates onto the current viewport</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_ortho</methodname>
<methodparam><type>float</type><parameter>xmin</parameter></methodparam>
@ -18,8 +18,65 @@
<methodparam><type>float</type><parameter>zmax</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_ortho</function> function defines an orthographic
mapping of user coordinates onto the current viewport.
Defines an orthographic mapping of user coordinates onto the current
viewport.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmin</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>xmax</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ymin</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ymax</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>zmin</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>zmax</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

63
reference/swf/functions/swf-ortho2.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-ortho2">
<refnamediv>
<refname>swf_ortho2</refname>
<refpurpose>Defines 2D orthographic mapping of user coordinates onto the current viewport</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_ortho2</methodname>
<methodparam><type>float</type><parameter>xmin</parameter></methodparam>
@ -16,11 +16,56 @@
<methodparam><type>float</type><parameter>ymax</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_ortho2</function> function defines a two
dimensional orthographic mapping of user coordinates onto the
current viewport, this defaults to one to one mapping of the area
of the Flash movie. If a perspective transformation is desired,
the <function>swf_perspective</function> function can be used.
Defines a two dimensional orthographic mapping of user coordinates onto
the current viewport, this defaults to one to one mapping of the area of
the Flash movie.
</para>
<para>
If a perspective transformation is desired,
<function>swf_perspective</function> can be used.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmin</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>xmax</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ymin</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ymax</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

64
reference/swf/functions/swf-perspective.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-perspective">
<refnamediv>
<refname>swf_perspective</refname>
<refpurpose>Define a perspective projection transformation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_perspective</methodname>
<methodparam><type>float</type><parameter>fovy</parameter></methodparam>
@ -16,14 +16,7 @@
<methodparam><type>float</type><parameter>far</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_perspective</function> function defines a
perspective projection transformation. The
<parameter>fovy</parameter> parameter is field-of-view angle in
the y direction. The <parameter>aspect</parameter> parameter
should be set to the aspect ratio of the viewport that is being
drawn onto. The <parameter>near</parameter> parameter is the
near clipping plane and the <parameter>far</parameter> parameter
is the far clipping plane.
Defines a perspective projection transformation.
</para>
<note>
<para>
@ -33,6 +26,53 @@
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fovy</parameter></term>
<listitem>
<para>
A field-of-view angle in the y direction.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>aspect</parameter></term>
<listitem>
<para>
The aspect ratio of the viewport that is being drawn onto.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>near</parameter></term>
<listitem>
<para>
The near clipping plane.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>far</parameter></term>
<listitem>
<para>
The far clipping plane.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

56
reference/swf/functions/swf-placeobject.xml
View file

@ -1,35 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-placeobject">
<refnamediv>
<refname>swf_placeobject</refname>
<refpurpose>Place an object onto the screen</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_placeobject</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
<methodparam><type>int</type><parameter>depth</parameter></methodparam>
</methodsynopsis>
<para>
Places the object specified by <parameter>objid</parameter> in
the current frame at a depth of <parameter>depth</parameter>.
The <parameter>objid</parameter> parameter and the
<parameter>depth</parameter> must be between 1 and 65535.
Places the object in the current frame at a specified
<parameter>depth</parameter>.
</para>
<para>
This uses the current mulcolor (specified by
<function>swf_mulcolor</function>) and the current addcolor
(specified by <function>swf_addcolor</function>) to color the
object and it uses the current matrix to position the object.
<function>swf_mulcolor</function>) and the current addcolor (specified by
<function>swf_addcolor</function>) to color the object and it uses the
current matrix to position the object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
<para>
Must be between 1 and 65535.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
<note>
<para>
Full RGBA colors are supported.
</para>
</note>
</refsect1>
</refentry>

72
reference/swf/functions/swf-polarview.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-polarview">
<refnamediv>
<refname>swf_polarview</refname>
<refpurpose>Define the viewer's position with polar coordinates</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_polarview</methodname>
<methodparam><type>float</type><parameter>dist</parameter></methodparam>
@ -17,18 +17,58 @@
</methodsynopsis>
<para>
The <function>swf_polarview</function> function defines the
viewer's position in polar coordinates. The
<parameter>dist</parameter> parameter gives the distance between
the viewpoint to the world space origin. The
<parameter>azimuth</parameter> parameter defines the azimuthal
angle in the x,y coordinate plane, measured in distance from the
y axis. The <parameter>incidence</parameter> parameter defines
the angle of incidence in the y,z plane, measured in distance
from the z axis. The incidence angle is defined as the angle of
the viewport relative to the z axis. Finally the
<parameter>twist</parameter> specifies the amount that the
viewpoint is to be rotated about the line of sight using the
right hand rule.
viewer's position in polar coordinates.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dist</parameter></term>
<listitem>
<para>
The distance between the viewpoint to the world space origin.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>azimuth</parameter></term>
<listitem>
<para>
Defines the azimuthal angle in the x,y coordinate plane, measured in
distance from the y axis.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>incidence</parameter></term>
<listitem>
<para>
Defines the angle of incidence in the y,z plane, measured in distance
from the z axis. The incidence angle is defined as the angle of the
viewport relative to the z axis.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>twist</parameter></term>
<listitem>
<para>
Specifies the amount that the viewpoint is to be rotated about the
line of sight using the right hand rule.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

18
reference/swf/functions/swf-popmatrix.xml
View file

@ -1,20 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-popmatrix">
<refnamediv>
<refname>swf_popmatrix</refname>
<refpurpose>Restore a previous transformation matrix</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_popmatrix</methodname>
<void/>
</methodsynopsis>
<para>
The <function>swf_popmatrix</function> function pushes the
current transformation matrix back onto the stack.
Pushes the current transformation matrix back onto the stack.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

41
reference/swf/functions/swf-posround.xml
View file

@ -1,24 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-posround">
<refnamediv>
<refname>swf_posround</refname>
<refpurpose>Enables or Disables the rounding of the translation when objects are placed or moved</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_posround</methodname>
<methodparam><type>int</type><parameter>round</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_posround</function> function enables or
disables the rounding of the translation when objects are placed
or moved, there are times when text becomes more readable because
rounding has been enabled. The <parameter>round</parameter> is
whether to enable rounding or not, if set to the value of 1, then
rounding is enabled, if set to 0 then rounding is disabled.
Enables or disables the rounding of the translation when objects are
placed or moved, there are times when text becomes more readable because
rounding has been enabled.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>round</parameter></term>
<listitem>
<para>
Whether to enable rounding or not, if set to the value of 1, then
rounding is enabled, if set to 0 then rounding is disabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

18
reference/swf/functions/swf-pushmatrix.xml
View file

@ -1,20 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-pushmatrix">
<refnamediv>
<refname>swf_pushmatrix</refname>
<refpurpose>Push the current transformation matrix back unto the stack</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_pushmatrix</methodname>
<void/>
</methodsynopsis>
<para>
The <function>swf_pushmatrix</function> function pushes the
current transformation matrix back onto the stack.
Pushes the current transformation matrix back onto the stack.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

34
reference/swf/functions/swf-removeobject.xml
View file

@ -1,20 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-removeobject">
<refnamediv>
<refname>swf_removeobject</refname>
<refpurpose>Remove an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_removeobject</methodname>
<methodparam><type>int</type><parameter>depth</parameter></methodparam>
</methodsynopsis>
<para>
Removes the object at the depth specified by
<parameter>depth</parameter>.
Removes the object at the depth specified by <parameter>depth</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
<para>
The depth, as an integer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

48
reference/swf/functions/swf-rotate.xml
View file

@ -1,24 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-rotate">
<refnamediv>
<refname>swf_rotate</refname>
<refpurpose>Rotate the current transformation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_rotate</methodname>
<methodparam><type>float</type><parameter>angle</parameter></methodparam>
<methodparam><type>string</type><parameter>axis</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_rotate</function> rotates the current
transformation by the angle given by the
<parameter>angle</parameter> parameter around the axis given by
the <parameter>axis</parameter> parameter. Valid values for the
axis are 'x' (the x axis), 'y' (the y axis) or 'z' (the z axis).
Rotates the current transformation by a given <parameter>angle</parameter>
around the given <parameter>axis</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>angle</parameter></term>
<listitem>
<para>
The rotation angle.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>axis</parameter></term>
<listitem>
<para>
The axis. Valid values axis are <literal>x</literal> (the x axis),
<literal>y</literal> (the y axis) or <litereal>z</literal> (the z
axis).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

54
reference/swf/functions/swf-scale.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-scale">
<refnamediv>
<refname>swf_scale</refname>
<refpurpose>Scale the current transformation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_scale</methodname>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
@ -15,11 +15,47 @@
<methodparam><type>float</type><parameter>z</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_scale</function> scales the x coordinate of the
curve by the value of the <parameter>x</parameter> parameter, the
y coordinate of the curve by the value of the
<parameter>y</parameter> parameter, and the z coordinate of the
curve by the value of the <parameter>z</parameter> parameter.
The <function>swf_scale</function> scales curve coordinates by the given
value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
x scale factor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
y scale factor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>z</parameter></term>
<listitem>
<para>
z scale factor.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

31
reference/swf/functions/swf-setfont.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-setfont">
<refnamediv>
<refname>swf_setfont</refname>
<refpurpose>Change the current font</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_setfont</methodname>
<methodparam><type>int</type><parameter>fontid</parameter></methodparam>
@ -17,6 +17,29 @@
value given by the <parameter>fontid</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fontid</parameter></term>
<listitem>
<para>
The font identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

34
reference/swf/functions/swf-setframe.xml
View file

@ -1,20 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-setframe">
<refnamediv>
<refname>swf_setframe</refname>
<refpurpose>Switch to a specified frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_setframe</methodname>
<methodparam><type>int</type><parameter>framenumber</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_setframe</function> changes the active frame to
the frame specified by <parameter>framenumber</parameter>.
Changes the active frame to the specified on.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>framenumber</parameter></term>
<listitem>
<para>
The frame number to be set.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

71
reference/swf/functions/swf-shapearc.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-shapearc">
<refnamediv>
<refname>swf_shapearc</refname>
<refpurpose>Draw a circular arc</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapearc</methodname>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
@ -17,13 +17,62 @@
<methodparam><type>float</type><parameter>ang2</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_shapearc</function> function draws a circular
arc from angle A given by the <parameter>ang1</parameter>
parameter to angle B given by the <parameter>ang2</parameter>
parameter. The center of the circle has an x coordinate given by
the <parameter>x</parameter> parameter and a y coordinate given
by the <parameter>y</parameter>, the radius of the circle is
given by the <parameter>r</parameter> parameter.
Draws a circular arc.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
x-coordinate of the center.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
y-coordinate of the center.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>r</parameter></term>
<listitem>
<para>
The arc radius.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ang1</parameter></term>
<listitem>
<para>
The start angle.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ang2</parameter></term>
<listitem>
<para>
The end angle.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

69
reference/swf/functions/swf-shapecurveto.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-shapecurveto">
<refnamediv>
<refname>swf_shapecurveto</refname>
<refpurpose>Draw a quadratic bezier curve between two points</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapecurveto</methodname>
<methodparam><type>float</type><parameter>x1</parameter></methodparam>
@ -16,14 +16,59 @@
<methodparam><type>float</type><parameter>y2</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_shapecurveto</function> function draws a
quadratic bezier curve from the current location, though the x
coordinate given by <parameter>x1</parameter> and the y
coordinate given by <parameter>y1</parameter> to the x
coordinate given by <parameter>x2</parameter> and the y coordinate
given by <parameter>y2</parameter>. The current position is then
set to the x,y coordinates given by the <parameter>x2</parameter> and
<parameter>y2</parameter> parameters
Draws a quadratic bezier curve from the current location, though the
two given points.
</para>
<para>
The current position is then set to the point defined by the
<parameter>x2</parameter> and <parameter>y2</parameter> parameters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x1</parameter></term>
<listitem>
<para>
x-coordinate of the first point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y1</parameter></term>
<listitem>
<para>
y-coordinate of the first point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x2</parameter></term>
<listitem>
<para>
x-coordinate of the second point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y2</parameter></term>
<listitem>
<para>
y-coordinate of the second point.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

84
reference/swf/functions/swf-shapecurveto3.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-shapecurveto3">
<refnamediv>
<refname>swf_shapecurveto3</refname>
<refpurpose>Draw a cubic bezier curve</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapecurveto3</methodname>
<methodparam><type>float</type><parameter>x1</parameter></methodparam>
@ -18,14 +18,74 @@
<methodparam><type>float</type><parameter>y3</parameter></methodparam>
</methodsynopsis>
<para>
Draw a cubic bezier curve using the x,y coordinate pairs
<parameter>x1</parameter>, <parameter>y1</parameter> and
<parameter>x2</parameter>,<parameter>y2</parameter> as off curve
control points and the x,y coordinate
<parameter>x3</parameter>,<parameter> y3</parameter> as an
endpoint. The current position is then set to the x,y coordinate
pair given by
<parameter>x3</parameter>,<parameter>y3</parameter>.
Draw a cubic bezier curve using the given coordinates.
</para>
<para>
The current position is then set to the
<parameter>x3</parameter>,<parameter>y3</parameter> coordinate.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x1</parameter></term>
<listitem>
<para>
x-coordinate of the first off curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y1</parameter></term>
<listitem>
<para>
y-coordinate of the first off curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x2</parameter></term>
<listitem>
<para>
x-coordinate of the second off curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y2</parameter></term>
<listitem>
<para>
y-coordinate of the second off curve control point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x3</parameter></term>
<listitem>
<para>
x-coordinate of the endpoint.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y3</parameter></term>
<listitem>
<para>
y-coordinate of the endpoint.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

36
reference/swf/functions/swf-shapefillbitmapclip.xml
View file

@ -1,21 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-shapefillbitmapclip">
<refnamediv>
<refname>swf_shapefillbitmapclip</refname>
<refpurpose>Set current fill mode to clipped bitmap</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapefillbitmapclip</methodname>
<methodparam><type>int</type><parameter>bitmapid</parameter></methodparam>
</methodsynopsis>
<para>
Sets the fill to bitmap clipped, empty spaces will be filled by
the bitmap given by the <parameter>bitmapid</parameter>
parameter.
Sets the fill to bitmap clipped, empty spaces will be filled by the
bitmap.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bitmapid</parameter></term>
<listitem>
<para>
The bitmap id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

34
reference/swf/functions/swf-shapefillbitmaptile.xml
View file

@ -1,21 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-shapefillbitmaptile">
<refnamediv>
<refname>swf_shapefillbitmaptile</refname>
<refpurpose>Set current fill mode to tiled bitmap</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapefillbitmaptile</methodname>
<methodparam><type>int</type><parameter>bitmapid</parameter></methodparam>
</methodsynopsis>
<para>
Sets the fill to bitmap tile, empty spaces will be filled by the
bitmap given by the <parameter>bitmapid</parameter> parameter
(tiled).
bitmap.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bitmapid</parameter></term>
<listitem>
<para>
The bitmap id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

18
reference/swf/functions/swf-shapefilloff.xml
View file

@ -1,20 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-shapefilloff">
<refnamediv>
<refname>swf_shapefilloff</refname>
<refpurpose>Turns off filling</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapefilloff</methodname>
<void/>
</methodsynopsis>
<para>
The <function>swf_shapefilloff</function> function turns off
filling for the current shape.
Turns off filling for the current shape.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

60
reference/swf/functions/swf-shapefillsolid.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-shapefillsolid">
<refnamediv>
<refname>swf_shapefillsolid</refname>
<refpurpose>Set the current fill style to the specified color</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapefillsolid</methodname>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
@ -16,9 +16,55 @@
<methodparam><type>float</type><parameter>a</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_shapefillsolid</function> function sets the
current fill style to solid, and then sets the fill color to the
values of the <parameter>rgba</parameter> parameters.
Sets the current fill style to solid, and then sets the fill color to the
given color.
</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>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

69
reference/swf/functions/swf-shapelinesolid.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-shapelinesolid">
<refnamediv>
<refname>swf_shapelinesolid</refname>
<refpurpose>Set the current line style</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapelinesolid</methodname>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
@ -17,11 +17,62 @@
<methodparam><type>float</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_shapelinesolid</function> function sets the
current line style to the color of the
<parameter>rgba</parameter> parameters and width to the
<parameter>width</parameter> parameter. If 0.0 is given as a
width then no lines are drawn.
Sets the current line style to the given color and width.
</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>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The line width. If 0.0 is given then no lines are drawn.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

45
reference/swf/functions/swf-shapelineto.xml
View file

@ -1,23 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-shapelineto">
<refnamediv>
<refname>swf_shapelineto</refname>
<refpurpose>Draw a line</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapelineto</methodname>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_shapelineto</function> draws a line to the x,y
coordinates given by the <parameter>x</parameter> parameter &amp; the
<parameter>y</parameter> parameter. The current position is then
set to the x,y parameters.
Draws a line to the <parameter>x</parameter> and <parameter>y</parameter>
coordinates. The current position is then set to that point.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
x-coordinate of the target.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
y-coordinate of the target.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

44
reference/swf/functions/swf-shapemoveto.xml
View file

@ -1,23 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.swf-shapemoveto">
<refnamediv>
<refname>swf_shapemoveto</refname>
<refpurpose>Move the current position</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_shapemoveto</methodname>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_shapemoveto</function> function moves the
current position to the x coordinate given by the
<parameter>x</parameter> parameter and the y position given by
the <parameter>y</parameter> parameter.
Moves the current position to the given point.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
x-coordinate of the target.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
y-coordinate of the target.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

17
reference/swf/functions/swf-showframe.xml
View file

@ -1,19 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-showframe">
<refnamediv>
<refname>swf_showframe</refname>
<refpurpose>Display the current frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_showframe</methodname>
<void/>
</methodsynopsis>
<para>
The swf_showframe function will output the current frame.
Outputs the current frame.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

51
reference/swf/functions/swf-startbutton.xml
View file

@ -1,25 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-startbutton">
<refnamediv>
<refname>swf_startbutton</refname>
<refpurpose>Start the definition of a button</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_startbutton</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_startbutton</function> function starts off the
definition of a button. The <parameter>type</parameter>
parameter can either be TYPE_MENUBUTTON or TYPE_PUSHBUTTON. The
TYPE_MENUBUTTON constant allows the focus to travel from the
button when the mouse is down, TYPE_PUSHBUTTON does not allow the
focus to travel when the mouse is down.
Starts the definition of a button.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
Can either be <constant>TYPE_MENUBUTTON</constant> or
<constant>TYPE_PUSHBUTTON</constant>. The
<constant>TYPE_MENUBUTTON</constant> constant allows the focus to
travel from the button when the mouse is down,
<constant>TYPE_PUSHBUTTON</constant> does not allow the focus to
travel when the mouse is down.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

20
reference/swf/functions/swf-startdoaction.xml
View file

@ -1,21 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-startdoaction">
<refnamediv>
<refname>swf_startdoaction</refname>
<refpurpose>Start a description of an action list for the current frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_startdoaction</methodname>
<void/>
</methodsynopsis>
<para>
The <function>swf_startdoaction</function> function starts the
description of an action list for the current frame. This must
be called before actions are defined for the current frame.
Starts the description of an action list for the current frame. This
must be called before actions are defined for the current frame.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

35
reference/swf/functions/swf-startshape.xml
View file

@ -1,21 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-startshape">
<refnamediv>
<refname>swf_startshape</refname>
<refpurpose>Start a complex shape</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_startshape</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_startshape</function> function starts a complex
shape, with an object id given by the
<parameter>objid</parameter> parameter.
Starts a complex shape.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

37
reference/swf/functions/swf-startsymbol.xml
View file

@ -1,22 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-startsymbol">
<refnamediv>
<refname>swf_startsymbol</refname>
<refpurpose>Define a symbol</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_startsymbol</methodname>
<methodparam><type>int</type><parameter>objid</parameter></methodparam>
</methodsynopsis>
<para>
Define an object id as a symbol. Symbols are tiny flash movies
that can be played simultaneously. The
<parameter>objid</parameter> parameter is the object id you want
to define as a symbol.
Defines an object id as a symbol. Symbols are tiny flash movies that can
be played simultaneously.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>objid</parameter></term>
<listitem>
<para>
The object id you want to define as a symbol.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

36
reference/swf/functions/swf-textwidth.xml
View file

@ -1,21 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-textwidth">
<refnamediv>
<refname>swf_textwidth</refname>
<refpurpose>Get the width of a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>swf_textwidth</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_textwidth</function> function gives the width
of the string, <parameter>str</parameter>, in pixels, using the
current font and font size.
Gives the width of the string in pixels, using the current font and font
size.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<listitem>
<para>
The string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the line width, as a float.
</para>
</refsect1>
</refentry>

52
reference/swf/functions/swf-translate.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-translate">
<refnamediv>
<refname>swf_translate</refname>
<refpurpose>Translate the current transformations</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_translate</methodname>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
@ -15,10 +15,46 @@
<methodparam><type>float</type><parameter>z</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_translate</function> function translates the
current transformation by the <parameter>x</parameter>,
<parameter>y</parameter>, and <parameter>z</parameter> values
given.
Translates the current transformation by the given values.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
x value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
y value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>z</parameter></term>
<listitem>
<para>
z value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

54
reference/swf/functions/swf-viewport.xml
View file

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/swf.xml, last change in rev 1.8 -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.swf-viewport">
<refnamediv>
<refname>swf_viewport</refname>
<refpurpose>Select an area for future drawing</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>swf_viewport</methodname>
<methodparam><type>float</type><parameter>xmin</parameter></methodparam>
@ -16,13 +16,55 @@
<methodparam><type>float</type><parameter>ymax</parameter></methodparam>
</methodsynopsis>
<para>
The <function>swf_viewport</function> function selects an area
for future drawing for <parameter>xmin</parameter> to
Selects an area for future drawing for <parameter>xmin</parameter> to
<parameter>xmax</parameter> and <parameter>ymin</parameter> to
<parameter>ymax</parameter>, if this function is not called the
area defaults to the size of the screen.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmin</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>xmax</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ymin</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ymax</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file