[Plplot-cvs] SF.net SVN: plplot:[11199] trunk/doc/docbook/src/api.xml

[<hba...@us...>]

Revision: 11199
          http://plplot.svn.sourceforge.net/plplot/?rev=11199&view=rev
Author:   hbabcock
Date:     2010-09-22 15:05:29 +0000 (Wed, 22 Sep 2010)

Log Message:
-----------
Add documentation for the plsmema() function. Tweak documentation for the plsmem() function.

Modified Paths:
--------------
    trunk/doc/docbook/src/api.xml

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2010-09-22 14:40:34 UTC (rev 11198)
+++ trunk/doc/docbook/src/api.xml	2010-09-22 15:05:29 UTC (rev 11199)
@@ -12463,7 +12463,7 @@
 
   <sect1 id="plsmem" renderas="sect3">
     <title>
-      <function>plsmem</function>: Set the memory area to be plotted
+      <function>plsmem</function>: Set the memory area to be plotted (RGB)
     </title>
 
     <para>
@@ -12480,7 +12480,8 @@
     </para>
 
     <para>
-      Set the memory area to be plotted (with the <quote>mem</quote> driver)
+      Set the memory area to be plotted (with the <quote>mem</quote> or
+      <quote>memcairo</quote> driver)
       as the <literal>dev</literal> member of the stream structure.  Also
       set the number of pixels in the memory passed in
       <parameter>plotmem</parameter>, which is a block of memory
@@ -12538,6 +12539,83 @@
 
   </sect1>
 
+  <sect1 id="plsmema" renderas="sect3">
+    <title>
+      <function>plsmema</function>: Set the memory area to be plotted (RGBA)
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plsmema</function>
+	  </funcdef>
+	  <paramdef><parameter>maxx</parameter></paramdef>
+	  <paramdef><parameter>maxy</parameter></paramdef>
+	  <paramdef><parameter>plotmem</parameter></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Set the memory area to be plotted (with the <quote>memcairo</quote> 
+      driver) as the <literal>dev</literal> member of the stream structure.
+      Also set the number of pixels in the memory passed in
+      <parameter>plotmem</parameter>, which is a block of memory
+      <parameter>maxy</parameter> by <parameter>maxx</parameter> by 4 bytes
+      long, say: 480 x 640 x 4 (Y, X, RGBA)
+    </para>
+
+    <para>
+      This memory will have to be freed by the user!
+    </para>
+
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>maxx</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Size of memory area in the X coordinate.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>maxy</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Size of memory area in the Y coordinate.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>plotmem</parameter>
+	  (<literal>void *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Pointer to the beginning of the user-supplied memory area.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>
+      Redacted form: <function>plsmema(maxx, maxy, plotmem)</function>
+    </para>
+
+    <para>
+      This function is not used in any examples.
+    </para>
+
+  </sect1>
+
   <sect1 id="plsmin" renderas="sect3">
     <title>
       <function>plsmin</function>: Set length of minor ticks


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.