---

sdlmm_basesurface.h

Go to the documentation of this file.

/*
 * SDmm - a C++ wrapper for SDL and related libraries
 * Copyright © 2001 David Hedbor <david@hedbor.org>
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 * 
 * This program 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
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */


#ifndef SDLMM_BASESURFACE_H
#define SDLMM_BASESURFACE_H
#include "sdlmm_config.h"
#include "sdlmm_spoint.h"
#include "sdlmm_srect.h"
#include "sdlmm_color.h"
#include "sdlmm_pixelformat.h"
#include <string>

namespace SDLmm {

  class DECLSPEC BaseSurface {

  protected:
    SDL_Surface *me;
    virtual void SetSurface(SDL_Surface *surface) {
      if(me) {
        SDL_FreeSurface(me);
      }
      me = surface;
    }


    explicit BaseSurface(SDL_Surface *surface)
      : me(surface) {
    }
    
    BaseSurface(const BaseSurface& other)
      : me(other.me) {
    }
    
    BaseSurface &operator=(const BaseSurface& other) {
      if(this != &other)
        SetSurface(other.me);
      return *this;
    }
    
  public:

    virtual ~BaseSurface() {
      if(me) {
        SDL_FreeSurface(me);
      }
    }
    
    SDL_Surface *GetSurface() {
      ASSERT(me);
      return me;
    }

    const SDL_Surface *GetSurface() const {
      ASSERT(me);
      return me;
    }

    bool Lock();

    void Unlock();
    



    bool valid() const { return me != 0; }

    Uint32 flags() const { return GetSurface()->flags; }                   

    const PixelFormat GetPixelFormat() const { return PixelFormat(GetSurface()->format); }
    PixelFormat GetPixelFormat() { return PixelFormat(GetSurface()->format); }

    int w() const { return GetSurface()->w; }                      

    int h() const { return GetSurface()->h; }                      

    Uint16 pitch() const { return GetSurface()->pitch; }                   

    const SRect clip_rect() const { return SRect(GetSurface()->clip_rect); } 


    void *pixels() { return GetSurface()->pixels; }


    const void *pixels() const { return GetSurface()->pixels; }

    struct private_hwdata *hwdata() const { return GetSurface()->hwdata; }


    void SetPixel(int x, int y, Color color);


    void SetPixel1(int x, int y, Color color);


    void SetPixel2(int x, int y, Color color);


    void SetPixel3(int x, int y, Color color);


    void SetPixel4(int x, int y, Color color);


    void SetPixel(const SRect& point, Color color) { SetPixel(point.x, point.y, color); }


    Color GetPixel(int x, int y) const;


    Color GetPixel(const SRect& point) const { return GetPixel(point.x, point.y); }


    bool SetColorKey(Uint32 flag, Color key);
      

    bool SetAlpha(Uint32 flag, Uint8 alpha);




    void ResetClipRect();


    void SetClipRect(const SDL_Rect& rect);
    

    void GetClipRect(SDL_Rect& rect) const;




    int Blit(const BaseSurface& src);


    int Blit(const BaseSurface& src, SDL_Rect& dstrect);


    int Blit(const BaseSurface& src, const SPoint& dstpoint, SDL_Rect& dstrect) { dstrect.x = dstpoint.x; dstrect.y = dstpoint.y; return Blit(src, dstrect); }


    int Blit(const BaseSurface& src, const SPoint& dstpoint);


    int Blit(const BaseSurface& src, const SDL_Rect& srcrect, SDL_Rect& dstrect);


    int Blit(const BaseSurface& src, const SDL_Rect& srcrect, const SPoint& dstpoint, SDL_Rect& dstrect) { dstrect.x = dstpoint.x; dstrect.y = dstpoint.y; return Blit(src, srcrect, dstrect); }


    int Blit(const BaseSurface& src, const SDL_Rect& srcrect, const SPoint& dstpoint);


    bool Fill(Color color);


    bool Fill(Uint8 r, Uint8 g, Uint8 b) { return Fill(GetPixelFormat().MapRGB(r, g, b)); }


    bool Fill(Uint8 r, Uint8 g, Uint8 b, Uint8 a) { return Fill(GetPixelFormat().MapRGBA(r, g, b, a)); }


    bool FillRect(SDL_Rect& dstrect, Color color);


    bool FillRect(SDL_Rect& dstrect, Uint8 r, Uint8 g, Uint8 b) { return FillRect(dstrect, GetPixelFormat().MapRGB(r, g, b)); }


    bool FillRect(SDL_Rect& dstrect, Uint8 r, Uint8 g, Uint8 b, Uint8 a) { return FillRect(dstrect, GetPixelFormat().MapRGBA(r, g, b, a)); }



    virtual bool SetDisplayFormat() = 0;


    virtual bool SetDisplayFormatAlpha() = 0;


    bool SaveBMP(const char *file) const;
    

    bool SaveBMP(const std::string& file) const { return SaveBMP(file.c_str()); }
   
  };
}

#endif // SDLMM_BASESURFACE_H

---

Documentation automatically generated by written by Dimitri van Heesch.

Project hosted at