driver.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 STARK_GFX_DRIVER_H
#define STARK_GFX_DRIVER_H

#include "common/rect.h"
#include "graphics/pixelformat.h"

namespace Graphics {
struct Surface;
}

namespace Stark {

class VisualActor;
class VisualProp;

namespace Gfx {

class SurfaceRenderer;
class FadeRenderer;
class Bitmap;
class Texture;

class Driver {
public:
    static Driver *create();

    virtual ~Driver() {}

    virtual void init() = 0;

    bool computeScreenViewport();
    virtual void setScreenViewport(bool noScaling) = 0; // deprecated

    virtual void setViewport(const Common::Rect &rect) = 0;

    Common::Rect getScreenViewport() { return _screenViewport; }

    Common::Rect gameViewport() const;

    virtual void clearScreen() = 0;
    virtual void flipBuffer() = 0;

    virtual Texture *createTexture() = 0;

    virtual Bitmap *createBitmap(const Graphics::Surface *surface = nullptr, const byte *palette = nullptr) = 0;

    virtual VisualActor *createActorRenderer() = 0;

    virtual VisualProp *createPropRenderer() = 0;

    virtual SurfaceRenderer *createSurfaceRenderer() = 0;

    virtual FadeRenderer *createFadeRenderer() = 0;

    bool isPosInScreenBounds(const Common::Point &point) const;

    Common::Point convertCoordinateCurrentToOriginal(const Common::Point &point) const;

    uint scaleWidthOriginalToCurrent(uint width) const;

    uint scaleHeightOriginalToCurrent(uint height) const;

    uint scaleWidthCurrentToOriginal(uint width) const;

    uint scaleHeightCurrentToOriginal(uint width) const;

    static const Graphics::PixelFormat getRGBAPixelFormat();

    virtual Graphics::Surface *getViewportScreenshot() const = 0;

    virtual void set3DMode() = 0;
    virtual bool computeLightsEnabled() = 0;

    virtual bool supportsModdedAssets() const { return true; }

    static const int32 kOriginalWidth = 640;
    static const int32 kOriginalHeight = 480;

    static const int32 kTopBorderHeight = 36;
    static const int32 kGameViewportHeight = 365;
    static const int32 kBottomBorderHeight = 79;

    static const int32 kGameViewportWidth = 640;

protected:
    static void flipVertical(Graphics::Surface *s);

    Common::Rect _screenViewport;
    bool         _computeLights;
};

} // End of namespace Gfx
} // End of namespace Stark

#endif // STARK_GFX_DRIVER_H