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

/*
 * GraphicEngine
 * ----------------
 * This the graphics engine interface.
 *
 * Autor: Malte Thiesen
 */

#ifndef SWORD25_GRAPHICENGINE_H
#define SWORD25_GRAPHICENGINE_H

// Includes
#include "common/array.h"
#include "common/rect.h"
#include "common/ptr.h"
#include "common/str.h"
#include "graphics/managed_surface.h"
#include "sword25/kernel/common.h"
#include "sword25/kernel/resservice.h"
#include "sword25/kernel/persistable.h"
#include "sword25/gfx/renderobjectptr.h"
#include "sword25/math/vertex.h"

namespace Sword25 {

class Kernel;
class Image;
class Panel;
class Screenshot;
class RenderObjectManager;

#define BS_ASHIFT 24
#define BS_RSHIFT 16
#define BS_GSHIFT 8
#define BS_BSHIFT 0

#define BS_AMASK 0xFF000000
#define BS_RMASK 0x00FF0000
#define BS_GMASK 0x0000FF00
#define BS_BMASK 0x000000FF

#define BS_RGBMASK (BS_RMASK | BS_GMASK | BS_BMASK)
#define BS_ARGBMASK (BS_AMASK | BS_RMASK | BS_GMASK | BS_BMASK)

#define BS_RGB(R,G,B)       (BS_AMASK | ((R) << BS_RSHIFT) | ((G) << BS_GSHIFT) | ((B) << BS_BSHIFT))
#define BS_ARGB(A,R,G,B)    (((A) << BS_ASHIFT) | ((R) << BS_RSHIFT) | ((G) << BS_GSHIFT) | ((B) << BS_BSHIFT))

class GraphicEngine : public ResourceService, public Persistable {
public:
    // Constructor
    // -----------
    GraphicEngine(Kernel *pKernel);
    ~GraphicEngine() override;

    // Interface
    // ---------

    bool init(int width = 800, int height = 600, int bitDepth = 16, int backbufferCount = 2);

    bool startFrame(bool updateAll = false);

    bool endFrame();

    // Debug methods

    void drawDebugLine(const Vertex &start, const Vertex &end, uint color = BS_RGB(255, 255, 255));

    bool saveThumbnailScreenshot(const Common::String &filename);

    RenderObjectPtr<Panel> getMainPanel();

    int getLastFrameDurationMicro() const {
        if (!_timerActive)
            return 0;
        return _lastFrameDuration;
    }

    float getLastFrameDuration() const {
        if (!_timerActive)
            return 0;
        return static_cast<float>(_lastFrameDuration) / 1000000.0f;
    }

    void stopMainTimer() {
        _timerActive = false;
    }

    void resumeMainTimer() {
        _timerActive = true;
    }

    float getSecondaryFrameDuration() const {
        return static_cast<float>(_lastFrameDuration) / 1000000.0f;
    }

    // Accessor methods

    int getDisplayWidth() const {
        return _width;
    }

    int getDisplayHeight() const {
        return _height;
    }

    Common::Rect &getDisplayRect() {
        return _screenRect;
    }

    int getBitDepth() {
        return _bitDepth;
    }

    void setVsync(bool vsync);

    bool getVsync() const;

    bool isWindowed() {
        return false;
    }

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

    Graphics::ManagedSurface _backSurface;
    Graphics::ManagedSurface *getSurface() { return &_backSurface; }

    Common::SeekableReadStream *_thumbnail;
    Common::SeekableReadStream *getThumbnail() { return _thumbnail; }

    // Access methods

    // Resource-Managing Methods
    // --------------------------
    Resource *loadResource(const Common::String &fileName) override;
    bool canLoadResource(const Common::String &fileName) override;

    // Persistence Methods
    // -------------------
    bool persist(OutputPersistenceBlock &writer) override;
    bool unpersist(InputPersistenceBlock &reader) override;
    bool isRTL();
    static void ARGBColorToLuaColor(lua_State *L, uint color);
    static uint luaColorToARGBColor(lua_State *L, int stackIndex);

protected:

    // Display Variables
    // -----------------
    int _width;
    int _height;
    Common::Rect _screenRect;
    int _bitDepth;

    void updateLastFrameDuration();

private:
    bool registerScriptBindings();
    void unregisterScriptBindings();

    // LastFrameDuration Variables
    // ---------------------------
    uint _lastTimeStamp;
    uint _lastFrameDuration;
    bool _timerActive;
    Common::Array<uint> _frameTimeSamples;
    uint _frameTimeSampleSlot;

private:
    RenderObjectPtr<Panel> _mainPanelPtr;

    Common::ScopedPtr<RenderObjectManager> _renderObjectManagerPtr;

    bool _isRTL;

    struct DebugLine {
        DebugLine(const Vertex &start, const Vertex &end, uint color) :
            _start(start),
            _end(end),
            _color(color) {}
        DebugLine() {}

        Vertex _start;
        Vertex _end;
        uint _color;
    };

    Common::Array<DebugLine> _debugLines;
};

} // End of namespace Sword25

#endif