RmDDSSurface.h

//============================================================================//
// filename: RmDDSSurface.h                                                   //
//                                                                            //
// author:   Toshiaki Tsuji                                                   //
//           ATI Research, Inc.                                               //
//           3D Application Research Group                                    //
//                                                                            //
// description: DDS Surface definition                                        //
//              Written for 3D Labs guys for loading cubemap.                 //
//              Currently only 32 bit texture format is supported.            //
//                                                                            //
//============================================================================//
// $File: //depot/3darg/Tools/RenderMonkey/sdk/Include/Utilities/RmDDSSurface.h $
// $Author: natasha $ $Revision: #3 $
//============================================================================//
//   (C) 2004 ATI Research, Inc.  All rights reserved.                        //
//============================================================================//

#ifndef _RM_UTILITIES_DDS_SURFACE_H_
#define _RM_UTILITIES_DDS_SURFACE_H_

#include "RmDDSLoaderTypes.h"

//============================================================================
//
// DDS Surface
//
// - Note : Surfacde is organized from top-down and left to right.
//          ( same as DirectX surface or Window Bitmap )
//          If you want to use this for OpenGL, you will have to flip
//          y direction.
//============================================================================
class RMUTIL_API RmDDSSurface
{
public :
   RmDDSSurface();
   virtual ~RmDDSSurface();

   //-------------------------------------------------------------------------
   // Creat/Destroy
   //-------------------------------------------------------------------------
   bool Create( RM_DDS_PIXEL_FORMAT pixelFormat, int width, int height );
   void Destroy();

   //-------------------------------------------------------------------------
   // Buffer Accessing
   //-------------------------------------------------------------------------
   RM_DDS_BYTE*       GetBuffer() { return m_pBuffer; };
   const RM_DDS_BYTE* GetBuffer() const { return m_pBuffer; };

   //-------------------------------------------------------------------------
   // Returns the beginning of scanline
   //-------------------------------------------------------------------------
   RM_DDS_BYTE*       GetScanLine( int y );
   const RM_DDS_BYTE* GetScanLine( int y ) const;

   //-------------------------------------------------------------------------
   // Returns the address of pixel at given (x,y)
   //-------------------------------------------------------------------------
   RM_DDS_BYTE*       GetPixel( int x, int y );
   const RM_DDS_BYTE* GetPixel( int x, int y ) const;

   //-------------------------------------------------------------------------
   // Returns the beginning of block ( for DXT )
   //-------------------------------------------------------------------------
   RM_DDS_BYTE*       GetDXTBlock( int bx, int by );
   const RM_DDS_BYTE* GetDXTBlock( int bx, int by ) const;

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

   // For DXT
   int GetBlockWidth() const { return m_blockWidth; };
   int GetBlockHeight() const { return m_blockHeight; };

   // Picth and Bytes Per Pixel are valid in RGB format ( not in DXT )
   int GetPitch() const { return m_pitch; };   
   int GetBytesPerPixel() const { return m_bytesPerPixel; };

   // Valid for DXT format
   int GetDXTBlockSize() const { return m_DXTBlockSize; };

   bool IsRGBAFormat() const;
   bool IsDXTFormat() const;
   bool IsLuminanceFormat() const;

   // Total size ( in bytes )
   int GetTotalSize() const;

   // PixelFormat
   RM_DDS_PIXEL_FORMAT GetPixelFormat() const { return m_pixelFormat; };

   // Change format to RGBA 8888 and returns result surface
   bool ChangeFormatToRGBA( RmDDSSurface *pSurface );

private :
   RM_DDS_PIXEL_FORMAT m_pixelFormat;
   RM_DDS_BYTE        *m_pBuffer;
   int                 m_width;
   int                 m_height;
   int                 m_pitch;  // Bytes per scanline
   int                 m_bytesPerPixel;

   int                 m_blockWidth;
   int                 m_blockHeight;
   int                 m_DXTBlockSize;

   // Decompress DXT block into 4x4 RGBA pixels
   // 
   // - pDestBlock must have enough size to contain 4x4x4 bytes
   bool DecompressToRGBA( RmDDSSurface *pSurface );
   void DecompressDXTBlock( RM_DDS_PIXEL_FORMAT format, RM_DDS_BYTE *pDXTBlock, RM_DDS_BYTE  *pDestBlock );
   void DecompressDXT1Block( RM_DDS_BYTE *pDXTBlock, RM_DDS_BYTE *pDestBlock, bool bUseTransparency );
   void DecompressDXT2_3Block( RM_DDS_BYTE *pDXTBlock, RM_DDS_BYTE *pDestBlock );
   void DecompressDXT4_5Block( RM_DDS_BYTE *pDXTBlock, RM_DDS_BYTE *pDestBlock );

   // Changeformat from luminace to RGBA
   bool LuminanceToRGBA( RmDDSSurface *pSurface );
}; // End of RmDDSSurface


//============================================================================
//
// DDS Texture
//
// - Collection of mip surfaces.  Each successive surface is 1/2 the size
//
//============================================================================
class RMUTIL_API RmDDSTexture
{
public :
   RmDDSTexture();
   virtual ~RmDDSTexture();

   //-------------------------------------------------------------------------
   // Create/Destroy
   //-------------------------------------------------------------------------
   bool Create( RM_DDS_PIXEL_FORMAT pixelFormat, int width, int height,
                int numMipmaps );
   void Destroy();

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

   RmDDSSurface*       GetMipmap( int level );
   const RmDDSSurface* GetMipmap( int level ) const;

   //-------------------------------------------------------------------------
   // Information
   //-------------------------------------------------------------------------
   int GetWidth() const { return m_width; };    // Width of top level mipmap
   int GetHeight() const { return m_height; };  // Height of top level mipmap

   RM_DDS_PIXEL_FORMAT GetPixelFormat() const { return m_pixelFormat; };

private :
   int                 m_numMipmaps;
   RmDDSSurface       *m_pMipmaps;

   RM_DDS_PIXEL_FORMAT m_pixelFormat;
   int                 m_width;
   int                 m_height;
}; // End of RmDDSTexture


//============================================================================
//
// DDS Cubemap
//
// - Collection of six faces of DDSTexture
//
//============================================================================
class RMUTIL_API RmDDSCubemap
{
public :
   RmDDSCubemap();
   virtual ~RmDDSCubemap();

   //-------------------------------------------------------------------------
   // Create/Destroy
   //-------------------------------------------------------------------------
   bool Create( RM_DDS_PIXEL_FORMAT pixelFormat, int width, int height,
                int numMipmaps );
   void Destroy();

   //-------------------------------------------------------------------------
   // Surface accessor
   //-------------------------------------------------------------------------
   RmDDSTexture*       GetFace( RM_DDS_CUBEMAP_FACE  whichFace );
   const RmDDSTexture* GetFace( RM_DDS_CUBEMAP_FACE  whichFace ) const;

   //-------------------------------------------------------------------------
   // Information
   //-------------------------------------------------------------------------
   int GetNumMipmaps() const { return m_numMipmaps; };
   int GetWidth() const { return m_width; };     
   int GetHeight() const { return m_height; };

   RM_DDS_PIXEL_FORMAT GetPixelFormat() const { return m_pixelFormat; };

private :
   RmDDSTexture       *m_pFaces;
   int                 m_numMipmaps;

   RM_DDS_PIXEL_FORMAT m_pixelFormat;
   int                 m_width;
   int                 m_height;
}; // End of RmDDSCubemap

#endif // __RmDDSSurface_H__

---