projects
/
libdcp.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Fix code and tests so that SubtitleString::v_position is between 0 and 1 (not a perce...
[libdcp.git]
/
src
/
xyz_frame.h
diff --git
a/src/xyz_frame.h
b/src/xyz_frame.h
index e825b0a96434e9295c8677b7c737f6d1a6b1bedf..8ba829b2c6302ecde5e08ca3bc6c2b07ae6409f3 100644
(file)
--- a/
src/xyz_frame.h
+++ b/
src/xyz_frame.h
@@
-17,12
+17,21
@@
*/
*/
-#include <openjpeg.h>
+/** @file src/xyz_frame.h
+ * @brief XZYFrame class.
+ */
+
#include "util.h"
#include "util.h"
+#include <openjpeg.h>
namespace dcp {
namespace dcp {
-class XYZFrame
+/** @class XYZFrame
+ * @brief An image in XYZ colour.
+ *
+ * This class is a thin wrapper of libopenjpeg's opj_image_t.
+ */
+class XYZFrame : public boost::noncopyable
{
public:
XYZFrame (opj_image_t *);
{
public:
XYZFrame (opj_image_t *);
@@
-32,12
+41,15
@@
public:
int* data (int) const;
dcp::Size size () const;
int* data (int) const;
dcp::Size size () const;
+ /** @return Pointer to opj_image_t struct. The caller
+ * must not delete this.
+ */
opj_image_t* opj_image () const {
return _opj_image;
}
private:
opj_image_t* opj_image () const {
return _opj_image;
}
private:
- opj_image_t* _opj_image;
+ opj_image_t* _opj_image;
///< opj_image_t that we are managing
};
}
};
}