gzTexture.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzTexture.h
// Module       : 
// Description  : Class definition of the gzTexture class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990210  Created file    
// LJH  041029  Added comments
//
//******************************************************************************
#ifndef __GZ_TEXTURE_H__
#define __GZ_TEXTURE_H__

#include "gzObject.h"
#include "gzMatrix.h"
#include "gzImage.h"

enum gzTextureMagFilter
{
    GZ_TEXTURE_MAG_NEAREST  =GZ_NEAREST,        
    GZ_TEXTURE_MAG_LINEAR   =GZ_LINEAR,         
};

enum gzTextureMinFilter
{
    GZ_TEXTURE_MIN_NEAREST                  =GZ_NEAREST,                    
    GZ_TEXTURE_MIN_LINEAR                   =GZ_LINEAR,                     
    GZ_TEXTURE_MIN_NEAREST_MIPMAP_NEAREST   =GZ_NEAREST_MIPMAP_NEAREST,     
    GZ_TEXTURE_MIN_NEAREST_MIPMAP_LINEAR    =GZ_NEAREST_MIPMAP_LINEAR,      
    GZ_TEXTURE_MIN_LINEAR_MIPMAP_NEAREST    =GZ_LINEAR_MIPMAP_NEAREST,      
    GZ_TEXTURE_MIN_LINEAR_MIPMAP_LINEAR     =GZ_LINEAR_MIPMAP_LINEAR,       
};


enum gzTextureWrapMode
{
    GZ_TEXTURE_WRAP_CLAMP           = GZ_CLAMP,             
    GZ_TEXTURE_WRAP_REPEAT          = GZ_REPEAT,            
    GZ_TEXTURE_WRAP_CLAMP_TO_EDGE   = GZ_CLAMP_TO_EDGE,     
    GZ_TEXTURE_WRAP_CLAMP_TO_BORDER = GZ_CLAMP_TO_BORDER,   
    GZ_TEXTURE_WRAP_MIRRORED_REPEAT = GZ_MIRRORED_REPEAT,   
};

class gzContext;

//******************************************************************************
// Class    : gzBindTextureInfo
//                                  
// Purpose  : Keep bind info about texture per context
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030422  Created 
//                                  
//******************************************************************************
class gzBindTextureInfo
{
public:

    gzBindTextureInfo():bindID(0),contextEnumerator(0),isBind(FALSE){};

    gzRefPointer<gzRefIdStorage>    bindPool;
    gzUInt                          bindID;
    gzULong                         contextEnumerator;
    gzBool                          isBind;
};

enum gzGfxInternalTextureFormat
{
    GZ_TEX_FORMAT_LUMINANCE                     =   GZ_LUMINANCE,           
    GZ_TEX_FORMAT_LUMINANCE_ALPHA               =   GZ_LUMINANCE_ALPHA,     
    GZ_TEX_FORMAT_RGB                           =   GZ_RGB,                 
    GZ_TEX_FORMAT_RGBA                          =   GZ_RGBA,                
    
    GZ_TEX_FORMAT_ALPHA                         =   GZ_ALPHA,                       
    GZ_TEX_FORMAT_ALPHA4                        =   GZ_ALPHA4,                      
    GZ_TEX_FORMAT_ALPHA8                        =   GZ_ALPHA8,                      
    GZ_TEX_FORMAT_ALPHA12                       =   GZ_ALPHA12,                     
    GZ_TEX_FORMAT_ALPHA16                       =   GZ_ALPHA16,                     
    GZ_TEX_FORMAT_COMPRESSED_ALPHA              =   GZ_COMPRESSED_ALPHA,            
    GZ_TEX_FORMAT_COMPRESSED_LUMINANCE          =   GZ_COMPRESSED_LUMINANCE,        
    GZ_TEX_FORMAT_COMPRESSED_LUMINANCE_ALPHA    =   GZ_COMPRESSED_LUMINANCE_ALPHA,  
    GZ_TEX_FORMAT_COMPRESSED_INTENSITY          =   GZ_COMPRESSED_INTENSITY,        
    GZ_TEX_FORMAT_COMPRESSED_RGB                =   GZ_COMPRESSED_RGB,              
    GZ_TEX_FORMAT_COMPRESSED_RGBA               =   GZ_COMPRESSED_RGBA,             
    GZ_TEX_FORMAT_DEPTH_COMPONENT               =   GZ_DEPTH_COMPONENT,             
};

//******************************************************************************
// Class    : gzTexture
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990210  Created 
//                                  
//******************************************************************************
class gzTexture : public gzObject
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzTexture();

    GZ_GRAPH_EXPORT gzTexture( const gzTexture &copy);

    GZ_GRAPH_EXPORT virtual ~gzTexture();

    GZ_GRAPH_EXPORT gzVoid  virtual activate(gzContext *context);
    GZ_GRAPH_EXPORT static gzVoid deactivate(gzContext *context);



    GZ_GRAPH_EXPORT gzImage *           setImage(gzImage *image);

    GZ_GRAPH_EXPORT gzImage *           getImage();


    GZ_GRAPH_EXPORT gzVoid              setComponents(gzUByte count);


    GZ_GRAPH_EXPORT gzVoid              setInternalFormat(gzGfxInternalTextureFormat format);
    


    GZ_GRAPH_EXPORT gzVoid              setWrapS(gzTextureWrapMode wrap);

    GZ_GRAPH_EXPORT gzTextureWrapMode   getWrapS();



    GZ_GRAPH_EXPORT gzVoid              setWrapT(gzTextureWrapMode wrap);

    GZ_GRAPH_EXPORT gzTextureWrapMode   getWrapT();
    


    GZ_GRAPH_EXPORT gzVoid              setMagFilter(gzTextureMagFilter filter);


    GZ_GRAPH_EXPORT gzVoid              setMinFilter(gzTextureMinFilter filter);


    GZ_GRAPH_EXPORT gzVoid      setBorder(gzFloat red , gzFloat green , gzFloat blue , gzFloat alpha); 


    GZ_GRAPH_EXPORT gzVoid      setBorderWidth(gzUShort width);

    GZ_GRAPH_EXPORT gzUShort    getBorderWidth();



    GZ_GRAPH_EXPORT gzVoid      useMipMaps(gzBool on);

    GZ_GRAPH_EXPORT gzVoid      setMipMaps(const gzRefList<gzImage> &imageList);

    GZ_GRAPH_EXPORT gzRefList<gzImage> getMipMaps();


    GZ_GRAPH_EXPORT gzVoid      setBind(gzBool bind);
    GZ_GRAPH_EXPORT gzVoid      reBind();

    GZ_GRAPH_EXPORT gzVoid      disposeImage(gzBool on=FALSE);
    GZ_GRAPH_EXPORT gzVoid      compressImageOnGPU(gzBool on=FALSE);

    GZ_GRAPH_EXPORT gzVoid      createMipMaps(gzBool rebind=TRUE);


    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    GZ_GRAPH_EXPORT virtual gzBool  useDeepCopy();

    // ---------- operators --------------------------------------------

    GZ_GRAPH_EXPORT gzBool operator==(const gzTexture &right) const;


    GZ_GRAPH_EXPORT gzBool operator!=(const gzTexture &right) const { return !operator==(right); }


private:

    gzVoid      transferImage(gzContext *context,gzBool forceImageUpload);
    gzVoid      transferImage(gzImage *image,gzULong level,gzBool fullUpload,gzContext *mainContext);
    gzVoid      checkImagePowerSize();
    

    gzDynamicArray<gzBindTextureInfo>   m_bindInfo;
    
    gzRefList<gzImage>                  m_mipMaps;
    gzRefPointer<gzImage>               m_image;

    gzEnum                              m_wrap_s;
    gzEnum                              m_wrap_t;
    gzEnum                              m_mag_filter;
    gzEnum                              m_min_filter;

    gzULong                             m_texDataSize;
    
    gzLookupUpdateID                    m_updateID;

    gzLateBindData<gzRGBA>              m_border_color;

    gzUShort                            m_borderWidth;

    gzGfxInternalTextureFormat          m_internalFormat;

    gzBool                              m_useMipMap:1;
    gzBool                              m_bind:1;
    gzBool                              m_disposeImage:1;
    gzBool                              m_compressOnGPU:1;
};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzTexture);


#endif

---