summaryrefslogtreecommitdiff
path: root/src/transfer_function.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2015-05-29 10:36:56 +0100
committerCarl Hetherington <cth@carlh.net>2015-05-29 10:36:56 +0100
commit804d2471943581ac3711cd99d9ded75ef650d038 (patch)
tree74a934e557a33d43e8118328ee568faf3dee17af /src/transfer_function.h
parent73f9031ec4a6f37f98ce72fbf8abd48105b85cde (diff)
Some comments.1.0-new-asdcplib
Diffstat (limited to 'src/transfer_function.h')
-rw-r--r--src/transfer_function.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/transfer_function.h b/src/transfer_function.h
index 7f7187b5..c8248cce 100644
--- a/src/transfer_function.h
+++ b/src/transfer_function.h
@@ -17,6 +17,10 @@
*/
+/** @file src/transfer_function.h
+ * @brief TransferFunction class.
+ */
+
#ifndef LIBDCP_TRANSFER_FUNCTION_H
#define LIBDCP_TRANSFER_FUNCTION_H
@@ -27,6 +31,9 @@
namespace dcp {
+/** @class TransferFunction
+ * @brief A transfer function represented by a lookup table.
+ */
class TransferFunction : public boost::noncopyable
{
public:
@@ -38,6 +45,7 @@ public:
virtual bool about_equal (boost::shared_ptr<const TransferFunction> other, double epsilon) const = 0;
protected:
+ /** Make a LUT and return an array allocated by new */
virtual double * make_lut (int bit_depth, bool inverse) const = 0;
private: