Image.hpp

Go to the documentation of this file.

#ifndef GOSU_IMAGE_HPP
#define GOSU_IMAGE_HPP

#include <Gosu/Fwd.hpp>
#include <Gosu/Bitmap.hpp>
#include <Gosu/RotFlip.hpp>
#include <boost/scoped_ptr.hpp>
#include <memory>

namespace Gosu
{
    class Image
    {
        boost::scoped_ptr<ImageData> data;

    public:
        Image(Graphics& graphics, const std::wstring& filename,
              bool tileable = false);
        Image(Graphics& graphics, const std::wstring& filename, unsigned srcX,
              unsigned srcY, unsigned srcWidth, unsigned srcHeight,
              bool tileable = false);
        
        Image(Graphics& graphics, const Bitmap& source,
            bool tileable = false);
        Image(Graphics& graphics, const Bitmap& source, unsigned srcX,
            unsigned srcY, unsigned srcWidth, unsigned srcHeight,
            bool tileable = false);
        
        explicit Image(std::auto_ptr<ImageData> data);

        ~Image();

        unsigned width() const;
        unsigned height() const;

        void draw(double x, double y, ZPos z,
            double factorX = 1, double factorY = 1,
            Color c = Colors::white,
            AlphaMode mode = amDefault) const;
        void drawMod(double x, double y, ZPos z,
            double factorX, double factorY,
            Color c1, Color c2, Color c3, Color c4,
            AlphaMode mode = amDefault) const;

        void drawRot(double x, double y, ZPos z,
            double angle, double centerX = 0.5, double centerY = 0.5,
            double factorX = 1, double factorY = 1,
            Color c = Colors::white,
            AlphaMode mode = amDefault) const;

        #ifndef SWIG
        void drawRotFlip(double x, double y, ZPos z,
            RotFlip rf,
            double factorX = 1, double factorY = 1,
            Color c = Colors::white,
            AlphaMode mode = amDefault) const;
        void drawRotFlipMod(double x, double y, ZPos z,
            RotFlip rf,
            double factorX, double factorY,
            Color c1, Color c2, Color c3, Color c4,
            AlphaMode mode = amDefault) const;

        const ImageData& getData() const;
        #endif
    };

    template<typename Container>
    void imagesFromTiledBitmap(Graphics& graphics, const std::wstring& filename,
        int tileWidth, int tileHeight, bool tileable, Container& appendTo)
    {
        imagesFromTiledBitmap(graphics, quickLoadBitmap(filename), tileWidth, tileHeight, tileable, appendTo);
    }

    template<typename Container>
    void imagesFromTiledBitmap(Graphics& graphics, const Bitmap& bmp,
        int tileWidth, int tileHeight, bool tileable, Container& appendTo)
    {
        int tilesX, tilesY;

        if (tileWidth > 0)
            tilesX = bmp.width() / tileWidth;
        else
        {
            tilesX = -tileWidth;
            tileWidth = bmp.width() / tilesX;
        }
        
        if (tileHeight > 0)
            tilesY = bmp.height() / tileHeight;
        else
        {
            tilesY = -tileHeight;
            tileHeight = bmp.height() / tilesY;
        }
        
        for (int y = 0; y < tilesY; ++y)
            for (int x = 0; x < tilesX; ++x)
                appendTo.push_back(typename Container::value_type(new Image(graphics, bmp,
                    x * tileWidth, y * tileHeight, tileWidth, tileHeight,
                    tileable)));
    }
}

#endif

Documentation not clear enough? Please go to one of the places listed on http://www.libgosu.org/ and leave feedback. Thanks!