RmSurface.h

//=============================================================================
// filename: RmSurface.h                                                       
//                                                                             
//           ATI Research, Inc.                                                
//           3D Application Research Group                                     
//                                                                             
// Description: RenderMonkey's Surface Definition                              
//                                                                             
//=============================================================================
//   (C) 2004 ATI Research, Inc.  All rights reserved.                         
//=============================================================================

#ifndef _RM_CORE_SURFACE_H_
#define _RM_CORE_SURFACE_H_

#include <Core/RmTypes.h>
#include <Core/RmDefines.h>
#include <Core/RmEffect.h>
#include <Core/RmMath.h>
#include <Core/RmMatrix.h>

//=============================================================================
//=============================================================================
class RM_API RmSurface
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmSurface();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmSurface();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   bool Create( RmPixelFormatType pixelFormat, int width, int height );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Destroy();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetWidth()  const { return m_width; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetHeight() const { return m_height; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetBytesPerPixel() const { return m_bytesPerPixel; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetPitch() const { return m_pitch; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RM_BYTE*       GetBuffer() { return m_pBuffer; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RM_BYTE* GetBuffer() const { return m_pBuffer; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RM_BYTE*       GetScanLine( int y );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RM_BYTE* GetScanLine( int y ) const;

   //--------------------------------------------------------------------------
   RM_BYTE*       GetPixel( int x, int y );

   //--------------------------------------------------------------------------
   const RM_BYTE* GetPixel( int x, int y ) const;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmPixelFormatType GetPixelFormat() const { return m_pixelFormat; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetTotalSize() const { return m_totalSize; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   bool IsDXTFormat() const;

   //--------------------------------------------------------------------------
   //
   //--------------------------------------------------------------------------
   int  GetDXTBlockSize() const { return m_DXTBlockSize; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int  GetDXTBlockWidth() const { return m_DXTBlockWidth; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int  GetDXTBlockHeight() const { return m_DXTBlockHeight; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RM_BYTE*       GetDXTBlock( int bx, int by );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RM_BYTE* GetDXTBlock( int bx, int by ) const;

private :
   RmPixelFormatType  m_pixelFormat;      
   RM_BYTE           *m_pBuffer;          
   int                m_width;            
   int                m_height;           
   int                m_pitch;            
   int                m_bytesPerPixel;    

   int                m_DXTBlockSize;     
   int                m_DXTBlockWidth;    
   int                m_DXTBlockHeight;   

   int                m_totalSize;        
}; // End of RmSurface


//=============================================================================
//=============================================================================
class RM_API RmTexture
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmTexture() {};

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmTexture() {};
   
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Destroy() {};

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual RmPixelFormatType GetPixelFormat() const = 0;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual RmTextureType     GetTextureType() const = 0;

}; // End of RmTexture


//=============================================================================
//=============================================================================
class RM_API Rm2DTexture : public RmTexture
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   Rm2DTexture();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~Rm2DTexture();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   bool Create( RmPixelFormatType pixelFormat, int width, int height,
                int numMipmaps );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Destroy();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int          GetNumMipmaps() const { return m_numMipmaps; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmSurface*       GetMipmap( int level );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RmSurface* GetMipmap( int level ) const;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmTextureType     GetTextureType() const { return RM_TEXTURE_2D; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetWidth() const { return m_width; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetHeight() const { return m_height; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmPixelFormatType GetPixelFormat() const { return m_pixelFormat; };

private :
   int                 m_numMipmaps;   
   RmSurface          *m_pMipmaps;     
 
   RmPixelFormatType   m_pixelFormat;  
   int                 m_width;        
   int                 m_height;       
}; // End of Rm2DTexture


//=============================================================================
//=============================================================================
class RM_API RmCubemap : public RmTexture
{
public :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmCubemap();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual ~RmCubemap();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   bool Create( RmPixelFormatType pixelFormat, int edgeSize,
                int numMipmaps );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   virtual void Destroy();

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmSurface*       GetFaceSurface( RmCubemapFaceType  whichFace, int mipLevel );

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   const RmSurface* GetFaceSurface( RmCubemapFaceType  whichFace, int mipLevel ) const;

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmTextureType     GetTextureType() const { return RM_TEXTURE_CUBEMAP; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetNumMipmaps() const { return m_numMipmaps; };

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   int GetEdgeSize() const { return m_edgeSize; };     

   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   RmPixelFormatType GetPixelFormat() const { return m_pixelFormat; };

private :
   //--------------------------------------------------------------------------
   //--------------------------------------------------------------------------
   struct Cube
   {
      RmSurface* pFaces[6];
   }; // End of Cube

private :
   Cube               *m_pMipCubes;   
   int                 m_numMipmaps;  

   RmPixelFormatType   m_pixelFormat; 
   int                 m_edgeSize;    
}; // End of RmCubemap

#endif

---