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

/*
    BS_Image
    --------

    Autor: Malte Thiesen
*/

#ifndef SWORD25_IMAGE_H
#define SWORD25_IMAGE_H

// Includes
#include "sword25/kernel/common.h"
#include "common/rect.h"
#include "sword25/gfx/graphicengine.h"

namespace Sword25 {

class RectangleList;

class Image {
public:
    virtual ~Image() {}


    virtual int getWidth() const = 0;

    virtual int getHeight() const = 0;



    virtual bool blit(int posX = 0, int posY = 0,
                      int flipping = Graphics::FLIP_NONE,
                      Common::Rect *pPartRect = NULL,
                      uint color = BS_ARGB(255, 255, 255, 255),
                      int width = -1, int height = -1,
                      RectangleList *updateRects = 0) = 0;

    virtual bool fill(const Common::Rect *pFillRect = 0, uint color = BS_RGB(0, 0, 0)) = 0;

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

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


    virtual bool isBlitSource() const = 0;

    virtual bool isBlitTarget() const = 0;

    virtual bool isScalingAllowed() const = 0;

    virtual bool isFillingAllowed() const = 0;

    virtual bool isAlphaAllowed() const = 0;

    virtual bool isColorModulationAllowed() const = 0;

    virtual bool isSetContentAllowed() const = 0;

    virtual bool isSolid() const { return false; }

};

} // End of namespace Sword25

#endif