fox-toolkit.org - Documentation

00001 /********************************************************************************
00002 *                                                                               *
00003 *                       T A R G A  I m a g e   O b j e c t                      *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2001,2006 by Janusz Ganczarski.   All Rights Reserved.          *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (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 GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 *********************************************************************************
00022 * $Id: FXTGAImage.h,v 1.18 2006/01/22 17:58:10 fox Exp $                        *
00023 ********************************************************************************/
00024 #ifndef FXTGAIMAGE_H
00025 #define FXTGAIMAGE_H
00026 
00027 #ifndef FXIMAGE_H
00028 #include "FXImage.h"
00029 #endif
00030 
00031 namespace FX {
00032 
00033 
00034 /// TARGA graphics file
00035 class FXAPI FXTGAImage : public FXImage {
00036   FXDECLARE(FXTGAImage)
00037 protected:
00038   FXTGAImage(){}
00039 private:
00040   FXTGAImage(const FXTGAImage&);
00041   FXTGAImage &operator=(const FXTGAImage&);
00042 public:
00043   static const FXchar fileExt[];
00044   static const FXchar mimeType[];
00045 public:
00046 
00047   /// Construct image from memory stream formatted in TARGA file
00048   FXTGAImage(FXApp* a,const void *pix=NULL,FXuint opts=0,FXint w=1,FXint h=1);
00049 
00050   /// Save pixels into stream in TARGA file
00051   virtual bool savePixels(FXStream& store) const;
00052 
00053   /// Load pixels from stream in TARGA format
00054   virtual bool loadPixels(FXStream& store);
00055 
00056   /// Destroy image
00057   virtual ~FXTGAImage();
00058   };
00059 
00060 
00061 /**
00062 * Check if stream contains a TARGA, return TRUE if so.
00063 */
00064 extern FXAPI bool fxcheckTGA(FXStream& store);
00065 
00066 
00067 /**
00068 * Load an TARGA file from a stream.
00069 * Upon successful return, the pixel array and size are returned.
00070 * If an error occurred, the pixel array is set to NULL.
00071 */
00072 extern FXAPI bool fxloadTGA(FXStream& store,FXColor*& data,FXint& width,FXint& height);
00073 
00074 
00075 /**
00076 * Save an TARGA file to a stream.
00077 */
00078 extern FXAPI bool fxsaveTGA(FXStream& store,const FXColor *data,FXint width,FXint height);
00079 
00080 }
00081 
00082 #endif