msurface.h

/* 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 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 MADS_MSURFACE_H
#define MADS_MSURFACE_H

#include "common/scummsys.h"
#include "common/path.h"
#include "common/rect.h"
#include "graphics/screen.h"
#include "mads/palette.h"

namespace MADS {

class MADSEngine;
class MSprite;
class DepthSurface;

struct SpriteInfo {
    MSprite *sprite;
    int hotX, hotY;
    int width, height;
    int scaleX, scaleY;
    uint8 encoding;
    byte *inverseColorTable;
    byte *palette;
};

/*
 * Base MADS surface class. This derivces from Graphics::Screen
 * because it has logic we'll need for our own Screen class that
 * derives from this one
 */
class BaseSurface : public Graphics::Screen {
private:
    int scaleValue(int value, int scale, int err);
protected:
    static MADSEngine *_vm;
public:
    static void setVm(MADSEngine *vm) { _vm = vm; }

    virtual void load(const Common::Path &resName) {}
public:
    BaseSurface() : Graphics::Screen(0, 0) {
        free();     // Free the 0x0 surface allocated by Graphics::Screen
    }

    BaseSurface(int width, int height) : Graphics::Screen(width, height) {}

    ~BaseSurface() override {}

    Common::Rect getBounds() { return Common::Rect(0, 0, this->w, this->h); }

    inline byte *getPixels() { return (byte *)Graphics::ManagedSurface::getPixels(); }

    inline const void *getPixels() const { return (const byte *)Graphics::ManagedSurface::getPixels(); }

    byte *getBasePtr(int x, int y) { return (byte *)Graphics::ManagedSurface::getBasePtr(x, y); }

    inline const byte *getBasePtr(int x, int y) const { return (const byte *)Graphics::ManagedSurface::getBasePtr(x, y); }

    void drawSprite(const Common::Point &pt, SpriteInfo &info, const Common::Rect &clipRect);

    void scrollX(int xAmount);

    void scrollY(int yAmount);

    void translate(Common::Array<RGB6> &palette);

    void translate(byte map[PALETTE_COUNT]);

    BaseSurface *flipHorizontal() const;

    void copyRectTranslate(BaseSurface &srcSurface, const byte *paletteMap,
        const Common::Point &destPos, const Common::Rect &srcRect);

    void copyFrom(BaseSurface &src, const Common::Point &destPos, int depth, DepthSurface *depthSurface,
        int scale, bool flipped, int transparentColor = -1);
};

class MSurface : public BaseSurface {
protected:
    void addDirtyRect(const Common::Rect &r) override {}
public:
    MSurface() : BaseSurface() {}
    MSurface(int width, int height) : BaseSurface(width, height) {}
};

class DepthSurface : public MSurface {
public:
    int _depthStyle;

    DepthSurface() : MSurface(), _depthStyle(0) {}

    int getDepth(const Common::Point &pt);

    int getDepthHighBit(const Common::Point &pt);
};

} // End of namespace MADS

#endif /* MADS_MSURFACE_H */