Changeset 4195

Timestamp:

Jun 9, 2005, 11:20:20 AM (21 years ago)

Author:

drobbin

Message:

* empty log message *

Location:

trunk/psLib/src

Files:

• image/psImage.h (modified) (3 diffs)
• mathtypes/psImage.h (modified) (3 diffs)

trunk/psLib/src/image/psImage.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.54 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-07 02:29:44 $
+ *  @version $Revision: 1.55 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-09 21:20:20 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -76 +76 @@
     psArray* children;                 ///< Children of this region.
 
-    psPtr rawDataBuffer;
+    psPtr rawDataBuffer;               ///< Raw data buffer for Allocating/Freeing Images
 }
 psImage;
@@ -151 +151 @@
 );
 
+/** Copy an image to a new buffer
+ *  
+ *  @return True if image copied or false if error
+ */
 bool p_psImageCopyToRawBuffer(
-    void* buffer,
-    const psImage* input,
-    psElemType type
+    void* buffer,                      ///< the buffer used to copy the image
+    const psImage* input,              ///< the input image to be copied
+    psElemType type                    ///< the datatype of the image to be copied
 );
 

trunk/psLib/src/mathtypes/psImage.h

@@ -11 +11 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.54 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-07 02:29:44 $
+ *  @version $Revision: 1.55 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-09 21:20:20 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -76 +76 @@
     psArray* children;                 ///< Children of this region.
 
-    psPtr rawDataBuffer;
+    psPtr rawDataBuffer;               ///< Raw data buffer for Allocating/Freeing Images
 }
 psImage;
@@ -151 +151 @@
 );
 
+/** Copy an image to a new buffer
+ *  
+ *  @return True if image copied or false if error
+ */
 bool p_psImageCopyToRawBuffer(
-    void* buffer,
-    const psImage* input,
-    psElemType type
+    void* buffer,                      ///< the buffer used to copy the image
+    const psImage* input,              ///< the input image to be copied
+    psElemType type                    ///< the datatype of the image to be copied
 );