[Scummvm-cvs-logs] SF.net SVN: scummvm:[39257] scummvm/trunk/sound/timestamp.h

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Mon Mar 9 04:45:40 CET 2009


Revision: 39257
          http://scummvm.svn.sourceforge.net/scummvm/?rev=39257&view=rev
Author:   fingolfin
Date:     2009-03-09 03:45:40 +0000 (Mon, 09 Mar 2009)

Log Message:
-----------
Added some comments to Audio::Timestamp

Modified Paths:
--------------
    scummvm/trunk/sound/timestamp.h

Modified: scummvm/trunk/sound/timestamp.h
===================================================================
--- scummvm/trunk/sound/timestamp.h	2009-03-09 03:45:33 UTC (rev 39256)
+++ scummvm/trunk/sound/timestamp.h	2009-03-09 03:45:40 UTC (rev 39257)
@@ -28,9 +28,14 @@
 
 #include "common/scummsys.h"
 
-
 namespace Audio {
 
+/**
+ * Timestamps allow measuring times with a sub-millisecond granularity,
+ * and without rounding losses. This is achieved by measuring frames
+ * instead of milliseconds: Specify an initial time in milliseconds
+ * plus framerate (in Hertz, so frames per second).
+ */
 class Timestamp {
 protected:
 	uint32 _msecs;
@@ -40,6 +45,12 @@
 
 public:
 	Timestamp();
+	
+	/**
+	 * Set up a timestamp with a given time and framerate.
+	 * @param msecs		staring time in milliseconds
+	 * @param frameRate	number of frames per second
+	 */
 	Timestamp(uint32 msecs, int frameRate);
 	
 	/** Adds a number of frames to a timestamp. */


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




More information about the Scummvm-git-logs mailing list