Surface.h

Go to the documentation of this file.

//**********************************************************************
//
//  REGCOM: Regimental Command
//  Copyright (C) 2008 Randi J. Relander
//    <rjrelander@users.sourceforge.net>
//
//  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 3
//  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, see 
//  <http://www.gnu.org/licenses/>.
//  
//**********************************************************************

#ifndef REGCOM_GUI_SURFACE_H
#define REGCOM_GUI_SURFACE_H

// SYSTEM INCLUDES
#include <string>

// LIBRARY INCLUDES
#include "SDL.h"

// NAMESPACES
namespace regcom {
namespace gui {

// FORWARD REFERENCES
class Rect;
class Color;

//  CLASS: Surface
class Surface
{
public:

    // PUBLIC METHODS

    Surface();

    virtual ~Surface();

    int Create(int w, int h);

    int Load(const std::string& rPath, const std::string& rName);

    int Load(const std::string& rName);

    int SetColorKey(int r, int g, int b);

    int DisplayFormat();

    int DisplayFormatAlpha();

    int Blit(Surface* surface, Rect* src, int x, int y);

    int LowerBlit(Surface* surface, Rect* src, int x, int y);

    int FillRect(const Rect& rRect, const Color& rColor);

    int Transparent(int x, int y);

    Uint32 GetPixel(int x, int y);

    int Width();

    int Height();

    int Depth();

    int Pitch();
    
    void* Pixels();

    int Lock();

    int Unlock();

    int GetPalette(Surface* surface);

    void SetSurface(SDL_Surface* pSurface)
    {
        if (m_pSurface) SDL_FreeSurface(m_pSurface);
        m_pSurface = pSurface;
    }

    Uint32 MapRGB(Uint8 red, Uint8 green, Uint8 blue) const 
    { 
        if (!m_pSurface) return 0;
        return SDL_MapRGB(m_pSurface->format, red, green, blue);
    }

    Uint32 MapRGBA(Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha) const 
    { 
        if (!m_pSurface) return 0;
        return SDL_MapRGBA(m_pSurface->format, red, green, blue, alpha);
    }

protected:

    // MEMBER VARIABLES

    SDL_Surface* m_pSurface;
};

} // namespace gui
} // namespace regcom

#endif

Navigation

Home Page
Screen Shots
Developers
Documentation

Doxygen

Namespace List
Class List
Class Hierarchy
File List
Todo List

Links

SDL Library
License
SourceForge Project
Forums
Download

Regimental Command
Copyright © 2008
Randi J. Relander