From 4ed9940e71788f680b5e62037f33ff97db5475c9 Mon Sep 17 00:00:00 2001
From: Robert Osfield <robert@openscenegraph.com>
Date: Thu, 12 Jul 2007 08:29:39 +0000
Subject: [PATCH] Added better description of TransferFunction.

---
 include/osg/TransferFunction | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/include/osg/TransferFunction b/include/osg/TransferFunction
index 03c639cf7..2a06bcd9b 100644
--- a/include/osg/TransferFunction
+++ b/include/osg/TransferFunction
@@ -20,8 +20,11 @@
 namespace osg {
 
 
-/** TransferFunction used to manage the mapping for 1D, 2D or 3D input to output Vec4 values.
-  */
+/** TransferFunction is a class that provide a 1D,2D or 3D colour look up table
+  * that can be used on the GPU as a 1D, 2D or 3D texture.  
+  * Typically uses include mapping heights to colours when contouring terrain, 
+  * or mapping intensities to colours when volume rendering.
+*/
 class OSG_EXPORT TransferFunction : public osg::Referenced
 {
     public :
@@ -49,6 +52,7 @@ class OSG_EXPORT TransferFunction : public osg::Referenced
 
 };
 
+/** 1D variant of TransferFunction. */
 class OSG_EXPORT TransferFunction1D : public osg::TransferFunction
 {
     public: