image.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2013 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_VIDEO_IMAGE_H
#define FIFE_VIDEO_IMAGE_H

// Standard C++ library includes
#include <stack>

// 3rd party library includes
#include <SDL.h>
#include <png.h>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/fife_stdint.h"
#include "util/resource/resource.h"
#include "util/structures/point.h"
#include "util/structures/rect.h"

namespace FIFE {
    class Image;
    typedef SharedPtr<Image> ImagePtr;

    class Image : public IResource {
    public:
        Image(IResourceLoader* loader = 0);
        Image(const std::string& name, IResourceLoader* loader = 0);

        Image(SDL_Surface* surface);
        Image(const std::string& name, SDL_Surface* surface);

        Image(const uint8_t* data, uint32_t width, uint32_t height);
        Image(const std::string& name, const uint8_t* data, uint32_t width, uint32_t height);

        virtual ~Image();

        virtual void invalidate() = 0;

        virtual void render(const Rect& rect, uint8_t alpha = 255, uint8_t const* rgb = 0) = 0;
        virtual void render(const Rect& rect, const ImagePtr& overlay, uint8_t alpha = 255, uint8_t const* rgb = 0) {}
        virtual void renderZ(const Rect& rect, float vertexZ, uint8_t alpha = 255, uint8_t const* rgb = 0) {}
        virtual void renderZ(const Rect& rect, float vertexZ, const ImagePtr& overlay, uint8_t alpha = 255, uint8_t const* rgb = 0) {}

        virtual void renderZ(const Rect& rect, float vertexZ, uint8_t alpha = 255, bool forceNewBatch = false, uint8_t const* rgb = 0) {}

        SDL_Surface* detachSurface();

        SDL_Surface* getSurface() { assert(m_surface); return m_surface; }
        const SDL_Surface* getSurface() const { assert(m_surface); return m_surface; }

        virtual void setSurface(SDL_Surface* surface) = 0;

        void saveImage(const std::string& filename);

        static void saveAsPng(const std::string& filename, const SDL_Surface& surface);
        static bool putPixel(SDL_Surface* surface, int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255);

        uint32_t getWidth() const;
        uint32_t getHeight() const;
        const Rect& getArea() const;

        void setXShift(int32_t xshift) {
            m_xshift = xshift;
        }
        int32_t getXShift() const {
            return m_xshift;
        }
        void setYShift(int32_t yshift) {
            m_yshift = yshift;
        }
        int32_t getYShift() const {
            return m_yshift;
        }

        void getPixelRGBA(int32_t x, int32_t y, uint8_t* r, uint8_t* g, uint8_t* b, uint8_t* a);

        virtual size_t getSize();
        virtual void load();
        virtual void free();

        virtual void useSharedImage(const ImagePtr& shared, const Rect& region) = 0;

        virtual void forceLoadInternal() = 0;

        bool isSharedImage() const { return m_shared; }

        const Rect& getSubImageRect() const { return m_subimagerect; }

        virtual void copySubimage(uint32_t xoffset, uint32_t yoffset, const ImagePtr& img);

    protected:
        // The SDL Surface used.
        SDL_Surface* m_surface;
        // The X shift of the Image
        int32_t m_xshift;
        // The Y shift of the Image
        int32_t m_yshift;

        void reset(SDL_Surface* surface);

        // Does this image share data with another
        bool m_shared;
        // Area which this image occupy in shared image
        Rect m_subimagerect;

    private:
        std::string createUniqueImageName();
    };
}

#endif