Merge master.

[libdcp.git] / src / argb_frame.h

diff --git a/src/argb_frame.h b/src/argb_frame.h
index 2ad6f69d2aa636e4dd70f9585c132f7e0de12a08..419227bbbb19bd1504d18ae661db4cbd9944d831 100644 (file)
--- a/src/argb_frame.h
+++ b/src/argb_frame.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -18,11 +18,11 @@
 */
 
 /** @file  src/argb_frame.h
- *  @brief Container for a single image from a picture asset.
+ *  @brief ARGBFrame class. 
  */
 
-#include <stdint.h>
 #include "util.h"
+#include <stdint.h>
 
 namespace dcp
 {
@@ -42,26 +42,28 @@ namespace dcp
  *
  *  Lines are packed so that the second row directly follows the first.
  */
-class ARGBFrame
+class ARGBFrame : boost::noncopyable
 {
 public:
        ARGBFrame (Size size);
        ~ARGBFrame ();
 
+       /** @return pointer to the image data */
        uint8_t* data () const {
                return _data;
        }
 
-       /** Length of one picture row in bytes */
+       /** @return length of one picture row in bytes */
        int stride () const;
 
+       /** @return size of the picture in pixels */
        Size size () const {
                return _size;
        }
 
 private:
-       Size _size;
-       uint8_t* _data;
+       Size _size;     ///< frame size in pixels
+       uint8_t* _data; ///< pointer to image data
 };
 
 }