texData.h

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////
// 9/6/02       Aaron Lefohn    Scientific Computing and Imaging Institute
// School of Computing          University of Utah
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef GLIFT_TEXDATA_H_
#define GLIFT_TEXDATA_H_

#include "../core/gliftObject.h"
#include <GL/glew.h>
#include "../util/gliftDecl.h"
#include <mathGutz.h>
#include <vector>

namespace glift {

   /// Typedefs
class TexData;
typedef std::vector<TexData>    VecTexData;
typedef std::vector<TexData*>   VecTexDataP;

//////////////////////////////////////////////////////////////////////////
///
/// TexData 
///         - Base wrapper class used to set texture data
///                - 'setTexData(...)' calls glTexImage*D(...)
///                - This class stores all information necessary to describe the data to OpenGL.
///                - If mipmap generation is desired, include a 'AutoMipGen' TexState in the texState
///                  passed to the 'SingleTex' that will use this data. 
///                - Note that this does a SHALLOW copy of the input data!!\
///                - Use subclasses to provide constructors for your favorite data structures
///                - NOTE: To have OpenGL compress a texture image, pass in a compressed format \n 
///           for the internal type
///
/// To pass OpenGL a pre-compressed texture image, use the 2 default parameters in the ctor
///                
/// TexData - Wrapper for texture data. Makes the OpenGL calls to set the texture data
//////////////////////////////////////////////////////////////////////////////////
class _export_ TexData : public GliftObject
{
public: 
   TexData( GLenum   texDimenName, 
      const    gutz::vec3i& origin,
      const    gutz::vec3i& dimen, 
      int      borderW,                 
      GLenum   internalFormat, 
      GLenum   dataFormat, 
      GLenum   dataType, 
      void*    data,
      bool        isCompressed = false, // Use these 2 parameters for pre-compressed texture images
      int         numDataBytes = 0 );

   /// Default copy constructor and assignment operator
   virtual ~TexData() {}

   /// Make the OpenGL call to 'glTexImage*D(...)' or 'glTexSubImage*D(...)'
   void setTexData( GLenum texType, int mipLevel=0 ); /// Uses 'texType' for target

   /// Accessors
   GLenum                       texType()          const {return m_texDimenName;}
   gutz::vec3i  dimen()            const {return m_dimen;}
   void*                        data()             const {return m_data;}

   // Set functions
   void                 dataPtr(void* d)                                {m_data = d;}
   void                 orig( const gutz::vec3i& orig ) {m_texOrigin = orig;}
   void                 dimen(const gutz::vec3i& dim  ) {m_dimen = dim;}

private:
   void*                        m_data;                 /// the data
   GLenum                       m_texDimenName; /// 1D, 2D, or 3D
   GLenum                       m_glFormat;             /// internal format OpenGL
   GLenum                       m_dataFormat;   /// external format OpenGL
   GLenum                       m_dataType;             /// data type OpenGL
   gutz::vec3i      m_texOrigin;        /// location of data origin in texture map
   gutz::vec3i  m_dimen;                /// size of each dimen of the data
   int                  m_borderW;              /// width of border in texels (embedded in data)
   bool                 m_isCompressed; /// Is this a compressed texture?
   int                          m_numBytes;             /// Number of bytes in 'data'

   void checkInput();                                                   /// Check the input GLenum's
   void checkDimenName( GLenum texDimenName ); /// Only allow 1D, 2D, or 3D. Use multiple TexData objs for cubeMaps.
   void checkFormatData( GLenum format );
   void checkFormatGL( GLenum format );

   // How many bytes are in 'data'
   int numBytes( const gutz::vec3i& size, GLenum dataFormat, GLenum dataType );

   /// Write the data to texture memory with 'glTexImage*D(...)'
   void texImageND( GLenum texType, int mipLevel );

   /// Replace part of all of the texture with 'glTexSubImage*D(...)'
   void texSubImageND( GLenum texType, int mipLevel );
};

} /// End of namespace glift

#endif

---

Send questions, comments, and bug reports to: