Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXDDSImage.h

Go to the documentation of this file.
00001 /********************************************************************************
00002 *                                                                               *
00003 *                            D D S   I m a g e   O b j e c t                    *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2008,2009 by Jeroen van der Zijp.   All Rights Reserved.        *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or modify          *
00009 * it under the terms of the GNU Lesser General Public License as published by   *
00010 * the Free Software Foundation; either version 3 of the License, or             *
00011 * (at your option) any later version.                                           *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                 *
00016 * GNU Lesser General Public License for more details.                           *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public License      *
00019 * along with this program.  If not, see <http://www.gnu.org/licenses/>          *
00020 *********************************************************************************
00021 * $Id: FXDDSImage.h,v 1.6 2009/01/06 13:07:22 fox Exp $                         *
00022 ********************************************************************************/
00023 #ifndef FXDDSIMAGE_H
00024 #define FXDDSIMAGE_H
00025 
00026 #ifndef FXIMAGE_H
00027 #include "FXImage.h"
00028 #endif
00029 
00030 namespace FX {
00031 
00032 
00033 /**
00034 * The DDS Image class is a convenience class for working with images in the
00035 * Direct Draw Surface (DDS) file format.
00036 */
00037 class FXAPI FXDDSImage : public FXImage {
00038   FXDECLARE(FXDDSImage)
00039 protected:
00040   FXDDSImage(){}
00041 private:
00042   FXDDSImage(const FXDDSImage&);
00043   FXDDSImage &operator=(const FXDDSImage&);
00044 public:
00045   static const FXchar fileExt[];
00046   static const FXchar mimeType[];
00047 public:
00048 
00049   /// Construct image from memory stream formatted in DDS format
00050   FXDDSImage(FXApp* a,const void *pix=NULL,FXuint opts=0,FXint w=1,FXint h=1);
00051 
00052   /// Save pixels into stream in DDS format
00053   virtual FXbool savePixels(FXStream& store) const;
00054 
00055   /// Load pixels from stream in DDS format
00056   virtual FXbool loadPixels(FXStream& store);
00057 
00058   /// Destroy icon
00059   virtual ~FXDDSImage();
00060   };
00061 
00062 
00063 /**
00064 * Check if stream contains a DDS format, return true if so.
00065 */
00066 extern FXAPI FXbool fxcheckDDS(FXStream& store);
00067 
00068 
00069 /**
00070 * Load an DDS (Direct Draw Surface) file from a stream.
00071 * Upon successful return, the pixel array and size are returned.
00072 * If an error occurred, the pixel array is set to NULL.
00073 */
00074 extern FXAPI FXbool fxloadDDS(FXStream& store,FXColor*& data,FXint& width,FXint& height,FXint& depth);
00075 
00076 /**
00077 * Save a DDS (Direct Draw Surface) file to a stream.
00078 */
00079 extern FXAPI FXbool fxsaveDDS(FXStream& store,FXColor* data,FXint width,FXint height,FXint depth);
00080 
00081 }
00082 
00083 #endif

Copyright © 1997-2009 Jeroen van der Zijp