Public API Reference

csgfx/imagememory.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 by Jorrit Tyberghein
    Written by Samuel Humphreys

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_CSGFX_MEMIMAGE_H__
#define __CS_CSGFX_MEMIMAGE_H__

#include "csextern.h"
#include "csutil/leakguard.h"
#include "csutil/scf_implementation.h"

#include "csgfx/imagebase.h"
#include "csgfx/imagetools.h"
#include "csgfx/rgbpixel.h"

class CS_CRYSTALSPACE_EXPORT csImageMemory :
  public scfImplementationExt0<csImageMemory, csImageBase>
{
private:
  void ConstructCommon();
  void ConstructWHDF (int width, int height, int depth, int format);
  void ConstructSource (iImage* source);
  void ConstructBuffers (int width, int height, void* buffer, 
    bool destroy, int format, csRGBpixel *palette);
protected:
  int Width;
  int Height;
  int Depth;
  void* Image;
  csRGBpixel *Palette;
  uint8 *Alpha;
  int Format;
  bool has_keycolour;
  csRGBpixel keycolour;
  bool destroy_image;
  csImageType imageType;
  /* @@@ This is not csRefArray<iImage> as this does not return csRef<iImage>&
   * from GetExtend() or operator[], which is needed here.
   */
  csArray<csRef<iImage> > mipmaps;

  csImageMemory (int iFormat);
  void SetDimensions (int newWidth, int newHeight);
  void SetDimensions (int newWidth, int newHeight, int newDepth);

  void AllocImage();
  void EnsureImage();
  void FreeImage ();
public:
  CS_LEAKGUARD_DECLARE (csImageMemory);

  csImageMemory (int width, int height, int format = CS_IMGFMT_TRUECOLOR);
  csImageMemory (int width, int height, int depth, int format);
  csImageMemory (int width, int height, void* buffer, bool destroy,
    int format = CS_IMGFMT_TRUECOLOR, csRGBpixel *palette = 0);
  csImageMemory (int width, int height, const void* buffer, 
    int format = CS_IMGFMT_TRUECOLOR, const csRGBpixel *palette = 0);
  csImageMemory (iImage* source);
  csImageMemory (iImage* source, int newFormat);

  virtual ~csImageMemory ();

  void* GetImagePtr ();
  csRGBpixel* GetPalettePtr ();
  uint8* GetAlphaPtr ();

  virtual const void *GetImageData () { return GetImagePtr(); }
  virtual int GetWidth () const { return Width; }
  virtual int GetHeight () const { return Height; }
  virtual int GetDepth () const { return Depth; }

  virtual int GetFormat () const { return Format; }
  virtual const csRGBpixel* GetPalette () { return GetPalettePtr(); }
  virtual const uint8* GetAlpha () { return GetAlphaPtr(); }

  virtual bool HasKeyColor () const { return has_keycolour; }

  virtual void GetKeyColor (int &r, int &g, int &b) const
  { r = keycolour.red; g = keycolour.green; b = keycolour.blue; }

  void Clear (const csRGBpixel &colour);

  void CheckAlpha ();
  void SetFormat (int iFormat);

  virtual void SetKeyColor (int r, int g, int b);
  virtual void SetKeycolor (int r, int g, int b) { SetKeyColor(r,g,b); }
  virtual void ClearKeyColor ();
  virtual void ClearKeycolor () { ClearKeyColor(); }

  virtual void ApplyKeyColor ();
  virtual void ApplyKeycolor () { ApplyKeyColor(); }

  virtual csImageType GetImageType() const { return imageType; }
  void SetImageType (csImageType type) { imageType = type; }

  virtual uint HasMipmaps () const 
  { 
    size_t num = mipmaps.Length();
    while ((num > 0) && (mipmaps[num-1] == 0)) num--;
    return (uint)num; 
  }
  virtual csRef<iImage> GetMipmap (uint num) 
  { 
    if (num == 0) return this;
    if (num <= mipmaps.Length()) return mipmaps[num-1];
    return 0; 
  }
  bool SetMipmap (uint num, iImage* mip)
  {
    if (num == 0) return false;
    mipmaps.GetExtend (num-1) = mip;
    return true;
  }

  bool Copy (iImage* srcImage, int x, int y, int width, int height);
  bool CopyScale (iImage* srcImage, int x, int y, int width, int height);
  bool CopyTile (iImage* srcImage, int x, int y, int width, int height);

  void ConvertFromRGBA (csRGBpixel* iImage);
  void ConvertFromPal8 (uint8* iImage, uint8* alpha, csRGBpixel* iPalette,
    int nPalColors = 256);
  void ConvertFromPal8 (uint8* iImage, uint8* alpha, 
    const csRGBcolor* iPalette, int nPalColors = 256);
};

#endif // __CS_CSGFX_MEMIMAGE_H__

---