surface.h

Go to the documentation of this file.

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef GRAPHICS_SURFACE_H
#define GRAPHICS_SURFACE_H

#include "common/scummsys.h"
#include "common/list.h"

namespace Common {
struct Rect;
struct Point;
}

#include "graphics/pixelformat.h"

namespace Graphics {

struct Surface {
    /*
     * IMPORTANT implementation specific detail:
     *
     * ARM code relies on the layout of the first 3 of these fields. Do not
     * change them.
     */

    uint16 w;

    uint16 h;

    uint16 pitch;

protected:
    void *pixels;

public:
    PixelFormat format;

    Surface() : w(0), h(0), pitch(0), pixels(0), format() {
    }

    inline const void *getPixels() const {
        return pixels;
    }

    inline void *getPixels() {
        return pixels;
    }

    void setPixels(void *newPixels) { pixels = newPixels; }

    inline const void *getBasePtr(int x, int y) const {
        return (const byte *)(pixels) + y * pitch + x * format.bytesPerPixel;
    }

    inline void *getBasePtr(int x, int y) {
        return static_cast<byte *>(pixels) + y * pitch + x * format.bytesPerPixel;
    }

    void create(uint16 width, uint16 height, const PixelFormat &format);

    void free();

    void init(uint16 width, uint16 height, uint16 pitch, void *pixels, const PixelFormat &format);

    void copyFrom(const Surface &surf);

    Surface getSubArea(const Common::Rect &area);

    const Surface getSubArea(const Common::Rect &area) const;

    void copyRectToSurface(const void *buffer, int srcPitch, int destX, int destY, int width, int height);
    void copyRectToSurface(const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect);

    void convertToInPlace(const PixelFormat &dstFormat, const byte *palette = 0);

    Graphics::Surface *convertTo(const PixelFormat &dstFormat, const byte *palette = 0) const;

    void drawLine(int x0, int y0, int x1, int y1, uint32 color);

    void drawThickLine(int x0, int y0, int x1, int y1, int penX, int penY, uint32 color);

    void hLine(int x, int y, int x2, uint32 color);

    void vLine(int x, int y, int y2, uint32 color);

    void fillRect(Common::Rect r, uint32 color);

    void frameRect(const Common::Rect &r, uint32 color);

    // See comment in graphics/surface.cpp about it
    void move(int dx, int dy, int height);

    void flipVertical(const Common::Rect &r);
};

struct SurfaceDeleter {
    void operator()(Surface *ptr) {
        if (ptr) {
            ptr->free();
        }
        delete ptr;
    }
};

class FloodFill {
public:
    FloodFill(Surface *surface, uint32 oldColor, uint32 fillColor, bool maskMode = false);
    ~FloodFill();

    void addSeed(int x, int y);

    void fill();

    void fillMask();

    Surface *getMask() { return _mask; }

private:
    Common::List<Common::Point *> _queue;
    Surface *_surface;
    Surface *_mask;
    uint32 _oldColor, _fillColor;
    byte *_visited;
    int _w, _h;

    bool _maskMode;
};

} // End of namespace Graphics


#endif