Join Up! 91785 members and counting!

Login To PHPBuilder User Name: Password: Register A New Site Account * NOTE: This is for logging into the main site only! To login to the forums, click here

PHP Manual All Mail Lists Entire Site

Linux Today Enterprise Linux Today Apache Today JustLinux.com Linux Planet PHPBuilder All Linux Devices Hiermenus DatabaseJournal Technology Jobs IT Developer Internet News Small Business Personal Technology International Search internet.com Advertise Corporate Info Newsletters Tech Jobs E-mail Offers Covalent Extends Apache 2.0 to Microsoft ASP.NET ShopWorX - Support for Windows PHP Security Advisory: Vulnerability in PHP versions 4.2.0 and 4.2.1 Network Risk Assessment Full-Featured, Java-Based Apache GUI Partners & Affiliates Visual Verification in PHP Validating PHP User Sessions The Power of CVS Using the Manual at PHP.net PHP Helper

From: Egon Schmid (eschmid <email protected>)
Date: 05/29/00

• Next message: Egon Schmid: "[PHPDOC] cvs: phpdoc /de/functions/ swf.xml"
• Previous message: eschmid+sic <email protected>: "Re: [PHPDOC] Alphabetical order?"
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

eschmid Mon May 29 12:14:47 2000 EDT

  Modified files:
    /phpdoc/en/functions swf.xml
  Log:
  Note to translators: No content change, only formatting.
  
Index: phpdoc/en/functions/swf.xml
diff -u phpdoc/en/functions/swf.xml:1.7 phpdoc/en/functions/swf.xml:1.8
--- phpdoc/en/functions/swf.xml:1.7 Sun May 28 04:35:10 2000
+++ phpdoc/en/functions/swf.xml Mon May 29 12:14:46 2000
@@ -3,26 +3,26 @@
   <titleabbrev>SWF</titleabbrev>
   
   <partintro>
- <simpara>
- PHP offers the ability to create Shockwave Flash files via Paul Haeberli's
- libswf module. You can download libswf at <ulink url="&url.swf;">&url.swf;</ulink>.
- Once you have libswf all you need to do is to configure
- <option role="configure">--with-swf[=DIR]</option> where DIR is a location
- containing the directories include and lib. The include directory has to
- contain the swf.h file and the lib directory has to contain the libswf.a
- file. If you unpack the libswf distribution the two files will be in one
- directory. Consequently you will have to copy the files to the proper
- location manually.
- </simpara>
- <para>
- Once you've successfully installed PHP with Shockwave Flash support you can then
- go about creating Shockwave files from PHP. You would be surprised at what you can
- do, take the following code:
- <example>
- <title>
- SWF example
- </title>
- <programlisting role="php">
+ <simpara>
+ PHP offers the ability to create Shockwave Flash files via Paul
+ Haeberli's libswf module. You can download libswf at <ulink
+ url="&url.swf;">&url.swf;</ulink>. Once you have libswf all you
+ need to do is to configure <option
+ role="configure">--with-swf[=DIR]</option> where DIR is a location
+ containing the directories include and lib. The include directory
+ has to contain the swf.h file and the lib directory has to contain
+ the libswf.a file. If you unpack the libswf distribution the two
+ files will be in one directory. Consequently you will have to copy
+ the files to the proper location manually.
+ </simpara>
+ <para>
+ Once you've successfully installed PHP with Shockwave Flash
+ support you can then go about creating Shockwave files from PHP.
+ You would be surprised at what you can do, take the following
+ code:
+ <example>
+ <title>SWF example</title>
+ <programlisting role="php">
 &lt;php
 swf_openfile ("test.swf", 256, 256, 30, 1, 1, 1);
 swf_ortho2 (-100, 100, -100, 100);
@@ -69,2102 +69,2084 @@
 
 swf_closefile ();
 ?>
- </programlisting>
- </example>
- It will produce the animation found at the following
- <ulink url="&url.swf.test">url</ulink>.
+ </programlisting>
+ </example>
+ It will produce the animation found at the following <ulink
+ url="&url.swf.test">url</ulink>.
+ </para>
+ <note>
+ <para>
+ SWF support was added in PHP4 RC2.
+ </para>
+ </note>
+ </partintro>
+
+ <refentry id="function.swf-openfile">
+ <refnamediv>
+ <refname>swf_openfile</refname>
+ <refpurpose>Open a new Shockwave Flash file</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_openfile</function>
+ </funcdef>
+ <paramdef>string
+ <parameter>filename</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>width</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>height</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>framerate</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>r</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>g</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>b</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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).
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-closefile">
+ <refnamediv>
+ <refname>swf_closefile</refname>
+ <refpurpose>Close the current Shockwave Flash file</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_closefile</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ Close a file that was opened by the
+ <function>swf_openfile</function> function.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-labelframe">
+ <refnamediv>
+ <refname>swf_labelframe</refname>
+ <refpurpose>Label the current frame</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_labelframe</function>
+ </funcdef>
+ <paramdef>string
+ <parameter>name</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ Label the current frame with the name given by the
+ <parameter>name</parameter> parameter.
     </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-showframe">
+ <refnamediv>
+ <refname>swf_showframe</refname>
+ <refpurpose>Display the current frame</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_showframe</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ The swf_showframe function will output the current frame.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-setframe">
+ <refnamediv>
+ <refname>swf_setframe</refname>
+ <refpurpose>Switch to a specified frame</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_setframe</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>framenumber</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>swf_setframe</function> changes the active frame to
+ the frame specified by <parameter>framenumber</parameter>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <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>
+ <funcsynopsis>
+ <funcdef>int
+ <function>swf_getframe</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ The <function>swf_getframe</function> function gets the number of
+ the current frame.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <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>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_mulcolor</function>
+ </funcdef>
+ <paramdef>float
+ <parameter>r</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>g</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>b</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>a</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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.
+ </para>
     <note>
- <para>
- SWF support was added in PHP4 RC2.
- </para>
+ <para>
+ The <parameter>rgba</parameter> values can be either positive or
+ negative.
+ </para>
     </note>
- </partintro>
+ </refsect1>
+ </refentry>
   
- <refentry id="function.swf-openfile">
- <refnamediv>
- <refname>swf_openfile</refname>
- <refpurpose>
- Open a new Shockwave Flash file
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_openfile</function>
- </funcdef>
- <paramdef>string
- <parameter>filename</parameter>
- </paramdef>
- <paramdef>float
- <parameter>width</parameter>
- </paramdef>
- <paramdef>float
- <parameter>height</parameter>
- </paramdef>
- <paramdef>float
- <parameter>framerate</parameter>
- </paramdef>
- <paramdef>float
- <parameter>r</parameter>
- </paramdef>
- <paramdef>float
- <parameter>g</parameter>
- </paramdef>
- <paramdef>float
- <parameter>b</parameter>
- </paramdef>
- </funcsynopsis>
- <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).
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-closefile">
- <refnamediv>
- <refname>swf_closefile</refname>
- <refpurpose>
- Close the current Shockwave Flash file
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_closefile</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- Close a file that was opened by the <function>swf_openfile</function>
- function.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-labelframe">
- <refnamediv>
- <refname>swf_labelframe</refname>
- <refpurpose>
- Label the current frame
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_labelframe</function>
- </funcdef>
- <paramdef>string
- <parameter>name</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- Label the current frame with the name given by the <parameter>name</parameter>
- parameter.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-showframe">
- <refnamediv>
- <refname>swf_showframe</refname>
- <refpurpose>
- Display the current frame
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_showframe</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- The swf_showframe function will output the current frame.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-setframe">
- <refnamediv>
- <refname>swf_setframe</refname>
- <refpurpose>
- Switch to a specified frame
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_setframe</function>
- </funcdef>
- <paramdef>int
- <parameter>framenumber</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_setframe</function> changes the active frame to
- the frame specified by <parameter>framenumber</parameter>.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>int
- <function>swf_getframe</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- The <function>swf_getframe</function> function gets the number of the
- current frame.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_mulcolor</function>
- </funcdef>
- <paramdef>float
- <parameter>r</parameter>
- </paramdef>
- <paramdef>float
- <parameter>g</parameter>
- </paramdef>
- <paramdef>float
- <parameter>b</parameter>
- </paramdef>
- <paramdef>float
- <parameter>a</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- <note>
- <para>
- The <parameter>rgba</parameter> values can be either positive or negative.
- </para>
- </note>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_addcolor</function>
- </funcdef>
- <paramdef>float
- <parameter>r</parameter>
- </paramdef>
- <paramdef>float
- <parameter>g</parameter>
- </paramdef>
- <paramdef>float
- <parameter>b</parameter>
- </paramdef>
- <paramdef>float
- <parameter>a</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- <note>
- <para>
- The <parameter>rgba</parameter> values can be either positive or negative.
- </para>
- </note>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-placeobject">
- <refnamediv>
- <refname>swf_placeobject</refname>
- <refpurpose>
- Place an object onto the screen
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_placeobject</function>
- </funcdef>
- <paramdef>int
- <parameter>objid</parameter>
- </paramdef>
- <paramdef>int
- <parameter>depth</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </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.
- </para>
- <note>
- <para>
- Full RGBA colors are supported.
- </para>
- </note>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-modifyobject">
- <refnamediv>
- <refname>swf_modifyobject</refname>
- <refpurpose>
- Modify an object.
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_modifyobject</function>
- </funcdef>
- <paramdef>int
- <parameter>depth</parameter>
- </paramdef>
- <paramdef>int
- <parameter>how</parameter>
- </paramdef>
- </funcsynopsis>
- <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).
- </para>
- <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.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-removeobject">
- <refnamediv>
- <refname>swf_removeobject</refname>
- <refpurpose>
- Remove an object
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_removeobject</function>
- </funcdef>
- <paramdef>int
- <parameter>depth</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- Removes the object at the depth specified by <parameter>depth</parameter>.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-nextid">
- <refnamediv>
- <refname>swf_nextid</refname>
- <refpurpose>
- Returns the next free object id
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>int
- <function>swf_nextid</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- The <function>swf_nextid</function> function returns the
- next available object id.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_startdoaction</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-actiongotoframe">
- <refnamediv>
- <refname>swf_actiongotoframe</refname>
- <refpurpose>
- Play a frame and then stop
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actiongotoframe</function>
- </funcdef>
- <paramdef>int
- <parameter>framenumber</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_actionGotoFrame</function> function will go to the
- frame specified by <parameter>framenumber</parameter>, play it, and then stop.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actiongeturl</function>
- </funcdef>
- <paramdef>string
- <parameter>url</parameter>
- </paramdef>
- <paramdef>string
- <parameter>target</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_actionGetUrl</function> function gets the URL specified
- by the parameter <parameter>url</parameter> with the target <parameter>
- target</parameter>.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-actionnextframe">
- <refnamediv>
- <refname>swf_actionnextframe</refname>
- <refpurpose>
- Go foward one frame
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actionnextframe</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- Go foward one frame.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-actionprevframe">
- <refnamediv>
- <refname>swf_actionprevframe</refname>
- <refpurpose>
- Go backwards one frame
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actionprevframe</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actionplay</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- Start playing the flash movie from the current frame.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actionstop</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- Stop playing the flash movie at the current frame.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-actiontogglequality">
- <refnamediv>
- <refname>swf_actiontogglequality</refname>
- <refpurpose>
- Toggle between low and high quality
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actiontogglequality</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- Toggle the flash movie between high and low quality.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actionwaitforframe</function>
- </funcdef>
- <paramdef>int
- <parameter>framenumber</parameter>
- </paramdef>
- <paramdef>int
- <parameter>skipcount</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_actionWaitForFrame</function> function will check to
- see if the frame, specified by the <parameter>framenumber</parameter> parameter
- has been loaded, if not it will skip the number of actions specified by
- the <parameter>skipcount</parameter> parameter. This can be useful for
- "Loading..." type animations.
- </para>
- </refsect1>
- </refentry>
+ <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>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_addcolor</function>
+ </funcdef>
+ <paramdef>float
+ <parameter>r</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>g</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>b</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>a</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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.
+ </para>
+ <note>
+ <para>
+ The <parameter>rgba</parameter> values can be either positive or
+ negative.
+ </para>
+ </note>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-placeobject">
+ <refnamediv>
+ <refname>swf_placeobject</refname>
+ <refpurpose>Place an object onto the screen</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_placeobject</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>objid</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>depth</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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.
+ </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.
+ </para>
+ <note>
+ <para>
+ Full RGBA colors are supported.
+ </para>
+ </note>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-modifyobject">
+ <refnamediv>
+ <refname>swf_modifyobject</refname>
+ <refpurpose>Modify an object</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_modifyobject</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>depth</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>how</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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).
+ </para>
+ <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.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-removeobject">
+ <refnamediv>
+ <refname>swf_removeobject</refname>
+ <refpurpose>Remove an object</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_removeobject</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>depth</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ Removes the object at the depth specified by
+ <parameter>depth</parameter>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-nextid">
+ <refnamediv>
+ <refname>swf_nextid</refname>
+ <refpurpose>Returns the next free object id</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int
+ <function>swf_nextid</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ The <function>swf_nextid</function> function returns the next
+ available object id.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <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>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_startdoaction</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <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.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-actiongotoframe">
+ <refnamediv>
+ <refname>swf_actiongotoframe</refname>
+ <refpurpose>Play a frame and then stop</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actiongotoframe</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>framenumber</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>swf_actionGotoFrame</function> function will go to
+ the frame specified by <parameter>framenumber</parameter>, play
+ it, and then stop.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <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>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actiongeturl</function>
+ </funcdef>
+ <paramdef>string
+ <parameter>url</parameter>
+ </paramdef>
+ <paramdef>string
+ <parameter>target</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>swf_actionGetUrl</function> function gets the URL
+ specified by the parameter <parameter>url</parameter> with the
+ target <parameter> target</parameter>.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-actionnextframe">
+ <refnamediv>
+ <refname>swf_actionnextframe</refname>
+ <refpurpose>Go foward one frame</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actionnextframe</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ Go foward one frame.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-actionprevframe">
+ <refnamediv>
+ <refname>swf_actionprevframe</refname>
+ <refpurpose>Go backwards one frame</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actionprevframe</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ </refsect1>
+ </refentry>
+
+ <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>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actionplay</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ Start playing the flash movie from the current frame.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <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>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actionstop</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ Stop playing the flash movie at the current frame.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-actiontogglequality">
+ <refnamediv>
+ <refname>swf_actiontogglequality</refname>
+ <refpurpose>
+ Toggle between low and high quality
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actiontogglequality</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ Toggle the flash movie between high and low quality.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-actionsettarget">
- <refnamediv>
- <refname>swf_actionsettarget</refname>
- <refpurpose>
- Set the context for actions
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actionsettarget</function>
- </funcdef>
- <paramdef>string
- <parameter>target</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_actionSetTarget</function> function sets the context for
- all actions. You can use this to control other flash movies that are currently
- playing.
- </para>
- </refsect1>
- </refentry>
+ <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>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actionwaitforframe</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>framenumber</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>skipcount</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>swf_actionWaitForFrame</function> function will
+ check to see if the frame, specified by the
+ <parameter>framenumber</parameter> parameter has been loaded, if
+ not it will skip the number of actions specified by the
+ <parameter>skipcount</parameter> parameter. This can be useful
+ for "Loading..." type animations.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-actiongotolabel">
- <refnamediv>
- <refname>swf_actiongotolabel</refname>
- <refpurpose>
- Display a frame with the specified label
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_actiongotolabel</function>
- </funcdef>
- <paramdef>string
- <parameter>label</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_actionGotoLabel</function> function displays the
- frame with the label given by the <parameter>label</parameter>
- parameter and then stops.
- </para>
- </refsect1>
- </refentry>
+ <refentry id="function.swf-actionsettarget">
+ <refnamediv>
+ <refname>swf_actionsettarget</refname>
+ <refpurpose>Set the context for actions</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actionsettarget</function>
+ </funcdef>
+ <paramdef>string
+ <parameter>target</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>swf_actionSetTarget</function> function sets the
+ context for all actions. You can use this to control other flash
+ movies that are currently playing.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-enddoaction">
- <refnamediv>
- <refname>swf_enddoaction</refname>
- <refpurpose>
- End the current action
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_enddoaction</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- Ends the current action started by the <function>swf_startdoaction</function>
- function.
- </para>
- </refsect1>
- </refentry>
+ <refentry id="function.swf-actiongotolabel">
+ <refnamediv>
+ <refname>swf_actiongotolabel</refname>
+ <refpurpose>
+ Display a frame with the specified label
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_actiongotolabel</function>
+ </funcdef>
+ <paramdef>string
+ <parameter>label</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>swf_actionGotoLabel</function> function displays
+ the frame with the label given by the
+ <parameter>label</parameter> parameter and then stops.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-defineline">
- <refnamediv>
- <refname>swf_defineline</refname>
- <refpurpose>
- Define a line
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_defineline</function>
- </funcdef>
- <paramdef>int
- <parameter>objid</parameter>
- </paramdef>
- <paramdef>float
- <parameter>x1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>x2</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y2</parameter>
- </paramdef>
- <paramdef>float
- <parameter>width</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
+ <refentry id="function.swf-enddoaction">
+ <refnamediv>
+ <refname>swf_enddoaction</refname>
+ <refpurpose>End the current action</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_enddoaction</function>
+ </funcdef>
+ <void/>
+ </funcsynopsis>
+ <para>
+ Ends the current action started by the
+ <function>swf_startdoaction</function> function.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-definerect">
- <refnamediv>
- <refname>swf_definerect</refname>
- <refpurpose>
- Define a rectangle.
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_definerect</function>
- </funcdef>
- <paramdef>int
- <parameter>objid</parameter>
- </paramdef>
- <paramdef>float
- <parameter>x1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>x2</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y2</parameter>
- </paramdef>
- <paramdef>float
- <parameter>width</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
+ <refentry id="function.swf-defineline">
+ <refnamediv>
+ <refname>swf_defineline</refname>
+ <refpurpose>Define a line</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_defineline</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>objid</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>x1</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>y1</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>x2</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>y2</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>width</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.swf-definerect">
+ <refnamediv>
+ <refname>swf_definerect</refname>
+ <refpurpose>Define a rectangle</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_definerect</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>objid</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>x1</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>y1</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>x2</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>y2</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>width</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-definepoly">
- <refnamediv>
- <refname>swf_definepoly</refname>
- <refpurpose>
- Define a polygon
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_definepoly</function>
- </funcdef>
- <paramdef>int
- <parameter>objid</parameter>
- </paramdef>
- <paramdef>array
- <parameter>coords</parameter>
- </paramdef>
- <paramdef>int
- <parameter>npoints</parameter>
- </paramdef>
- <paramdef>float
- <parameter>width</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
+ <refentry id="function.swf-definepoly">
+ <refnamediv>
+ <refname>swf_definepoly</refname>
+ <refpurpose>
+ Define a polygon
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_definepoly</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>objid</parameter>
+ </paramdef>
+ <paramdef>array
+ <parameter>coords</parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>npoints</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>width</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-startshape">
- <refnamediv>
- <refname>swf_startshape</refname>
- <refpurpose>
- Start a complex shape
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_startshape</function>
- </funcdef>
- <paramdef>int
- <parameter>objid</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_startshape</function> function starts a complex shape,
- with an object id given by the <parameter>objid</parameter> parameter.
- </para>
- </refsect1>
- </refentry>
+ <refentry id="function.swf-startshape">
+ <refnamediv>
+ <refname>swf_startshape</refname>
+ <refpurpose>Start a complex shape</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_startshape</function>
+ </funcdef>
+ <paramdef>int
+ <parameter>objid</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <para>
+ The <function>swf_startshape</function> function starts a complex
+ shape, with an object id given by the
+ <parameter>objid</parameter> parameter.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-shapelinesold">
- <refnamediv>
- <refname>swf_shapelinesolid</refname>
- <refpurpose>
- Set the current line style
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapelinesolid</function>
- </funcdef>
- <paramdef>float
- <parameter>r</parameter>
- </paramdef>
- <paramdef>float
- <parameter>g</parameter>
- </paramdef>
- <paramdef>float
- <parameter>b</parameter>
- </paramdef>
- <paramdef>float
- <parameter>a</parameter>
- </paramdef>
- <paramdef>float
- <parameter>width</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
+ <refentry id="function.swf-shapelinesold">
+ <refnamediv>
+ <refname>swf_shapelinesolid</refname>
+ <refpurpose>Set the current line style</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>void
+ <function>swf_shapelinesolid</function>
+ </funcdef>
+ <paramdef>float
+ <parameter>r</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>g</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>b</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>a</parameter>
+ </paramdef>
+ <paramdef>float
+ <parameter>width</parameter>
+ </paramdef>
+ </funcsynopsis>
+ <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.
+ </para>
+ </refsect1>
+ </refentry>
       
- <refentry id="function.swf-shapefilloff">
- <refnamediv>
- <refname>swf_shapefilloff</refname>
- <refpurpose>
- Turns off filling
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapefilloff</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- The <function>swf_shapeFillOff</function> function turns off filling for the
- current shape.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapefillsolid</function>
- </funcdef>
- <paramdef>float
- <parameter>r</parameter>
- </paramdef>
- <paramdef>float
- <parameter>g</parameter>
- </paramdef>
- <paramdef>float
- <parameter>b</parameter>
- </paramdef>
- <paramdef>float
- <parameter>a</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-shapefillbitmapclip">
- <refnamediv>
- <refname>swf_shapefillbitmaptile</refname>
- <refpurpose>
- Set current fill mode to clipped bitmap
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapefillbitmapclip</function>
- </funcdef>
- <paramdef>int
- <parameter>bitmapid</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- Sets the fill to bitmap clipped, empty spaces will be filled by the
- bitmap given by the <parameter>bitmapid</parameter> parameter.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-shapefillbitmaptile">
- <refnamediv>
- <refname>swf_shapefillbitmaptile</refname>
- <refpurpose>
- Set current fill mode to tiled bitmap
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapefillbitmaptile</function>
- </funcdef>
- <paramdef>int
- <parameter>bitmapid</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- Sets the fill to bitmap tile, empty spaces will be filled by the
- bitmap given by the <parameter>bitmapid</parameter> parameter (tiled).
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-shapemoveto">
- <refnamediv>
- <refname>swf_shapemoveto</refname>
- <refpurpose>
- Move the current position
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapemoveto</function>
- </funcdef>
- <paramdef>float
- <parameter>x</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-shapelineto">
- <refnamediv>
- <refname>swf_shapelineto</refname>
- <refpurpose>
- Draw a line
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapelineto</function>
- </funcdef>
- <paramdef>float
- <parameter>x</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_shapeLineTo</function> draws a line to the x,y coordinates given by
- the <parameter>x</parameter> parameter & the <parameter>y</parameter> parameter. The
- current position is then set to the x,y parameters.
- </para>
- </refsect1>
- </refentry>
-
- <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>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapecurveto</function>
- </funcdef>
- <paramdef>float
- <parameter>x1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>x2</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y2</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_shapecurveto</function> function draws a quadratic bezier curve
- from 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
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-shapecurveto3">
- <refnamediv>
- <refname>swf_shapecurveto3</refname>
- <refpurpose>
- Draw a cubic bezier curve
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapecurveto3</function>
- </funcdef>
- <paramdef>float
- <parameter>x1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>x2</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y2</parameter>
- </paramdef>
- <paramdef>float
- <parameter>x3</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y3</parameter>
- </paramdef>
- </funcsynopsis>
- <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>.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-shapearc">
- <refnamediv>
- <refname>swf_shapearc</refname>
- <refpurpose>
- Draw a circular arc
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_shapearc</function>
- </funcdef>
- <paramdef>float
- <parameter>x</parameter>
- </paramdef>
- <paramdef>float
- <parameter>y</parameter>
- </paramdef>
- <paramdef>float
- <parameter>r</parameter>
- </paramdef>
- <paramdef>float
- <parameter>ang1</parameter>
- </paramdef>
- <paramdef>float
- <parameter>ang2</parameter>
- </paramdef>
- </funcsynopsis>
- <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.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-endshape">
- <refnamediv>
- <refname>swf_endshape</refname>
- <refpurpose>
- Completes the definition of the current shape
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_endshape</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- The <function>swf_endshape</function> completes the definition of
- the current shape.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-definefont">
- <refnamediv>
- <refname>swf_definefont</refname>
- <refpurpose>
- Defines a font
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_definefont</function>
- </funcdef>
- <paramdef>int
- <parameter>fontid</parameter>
- </paramdef>
- <paramdef>string
- <parameter>fontname</parameter>
- </paramdef>
- </funcsynopsis>
- <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>
- fontname</parameter> to the current font.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-setfont">
- <refnamediv>
- <refname>swf_setfont</refname>
- <refpurpose>
- Change the current font.
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_setfont</function>
- </funcdef>
- <paramdef>int
- <parameter>fontid</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_setfont</function> sets the current font to the value given by
- the <parameter>fontid</parameter> parameter.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-fontsize">
- <refnamediv>
- <refname>swf_fontsize</refname>
- <refpurpose>
- Change the font size
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_fontsize</function>
- </funcdef>
- <paramdef>float
- <parameter>size</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- The <function>swf_fontsize</function> function changes the font size to the value given
- by the <parameter>size</parameter> parameter.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-fontslant">
- <refnamediv>
- <refname>swf_fontslant</refname>
- <refpurpose>
- Set the font slant
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_fontslant</function>
- </funcdef>
- <paramdef>float
- <parameter>slant</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- Set the current font slant to the angle indicated by the <parameter>slant</parameter>
- parameter. Positive values create a foward slant, negative values create a negative
- slant.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-fonttracking">
- <refnamediv>
- <refname>swf_fonttracking</refname>
- <refpurpose>
- Set the current font tracking
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>void
- <function>swf_fonttracking</function>
- </funcdef>
- <paramdef>float
- <parameter>tracking</parameter>
- </paramdef>
- </funcsynopsis>
- <para>
- Set the font tracking to the value specified by the <parameter>tracking</parameter>
- parameter. This function is used to increase the spacing between letters and
- text, positive values increase the space and negative values decrease the space between
- letters.
- </para>
- </refsect1>
- </refentry>
-
- <refentry id="function.swf-getfontinfo">
- <refnamediv>
- <refname>swf_getfontinfo</refname>
- <refpurpose>
- The height in pixels of a capital A and a lowercase x
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <funcsynopsis>
- <funcdef>array
- <function>swf_getfontinfo</function>
- </funcdef>
- <void/>
- </funcsynopsis>
- <para>
- The <function>swf_getfontinfo</function> function returns an associative array
- with the following parameters:
- <itemizedlist>
- <listitem>
- <simpara>
- Aheight - The height in pixels of a capital A.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- xheight - The height in pixels o