bitmap.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/>.
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_BITMAP_H
#define SWORD25_BITMAP_H

#include "sword25/kernel/common.h"
#include "sword25/gfx/graphicengine.h"
#include "sword25/gfx/renderobject.h"

namespace Sword25 {

class Bitmap : public RenderObject {
protected:
    Bitmap(RenderObjectPtr<RenderObject> parentPtr, TYPES type, uint handle = 0);

public:

    ~Bitmap() override;

    void setAlpha(int alpha);

    void setModulationColor(uint modulationColor);

    void setScaleFactor(float scaleFactor);

    void setScaleFactorX(float scaleFactorX);

    void setScaleFactorY(float scaleFactorY);

    void setFlipH(bool flipH);

    void setFlipV(bool flipV);

    int getAlpha() {
        return _modulationColor >> BS_ASHIFT;
    }

    int getModulationColor() {
        return _modulationColor & BS_RGBMASK;
    }

    float getScaleFactorX() const {
        return _scaleFactorX;
    }

    float getScaleFactorY() const {
        return _scaleFactorY;
    }

    bool isFlipH() {
        return _flipH;
    }

    bool isFlipV() {
        return _flipV;
    }

    // -----------------------------------------------------------------------------
    // Die folgenden Methoden müssen alle BS_Bitmap-Klassen implementieren
    // -----------------------------------------------------------------------------

    virtual uint getPixel(int x, int y) const = 0;

    virtual bool    setContent(const byte *pixeldata, uint size, uint offset = 0, uint stride = 0) = 0;

    virtual bool    isScalingAllowed() const = 0;
    virtual bool    isAlphaAllowed() const = 0;
    virtual bool    isColorModulationAllowed() const = 0;
    virtual bool    isSetContentAllowed() const = 0;

    bool    persist(OutputPersistenceBlock &writer) override;
    bool    unpersist(InputPersistenceBlock &reader) override;

protected:
    bool  _flipH;
    bool  _flipV;
    float _scaleFactorX;
    float _scaleFactorY;
    uint32  _modulationColor;
    int32   _originalWidth;
    int32   _originalHeight;
};

} // End of namespace Sword25

#endif