null-graphics.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 BACKENDS_GRAPHICS_NULL_H
#define BACKENDS_GRAPHICS_NULL_H

#include "backends/graphics/graphics.h"

class NullGraphicsManager : public GraphicsManager {
public:
    virtual ~NullGraphicsManager() {}

    bool hasFeature(OSystem::Feature f) const override { return false; }
    void setFeatureState(OSystem::Feature f, bool enable) override {}
    bool getFeatureState(OSystem::Feature f) const override { return false; }

#ifdef USE_RGB_COLOR
    Graphics::PixelFormat getScreenFormat() const override {
        return _format;
    }

    Common::List<Graphics::PixelFormat> getSupportedFormats() const override {
        Common::List<Graphics::PixelFormat> list;
        list.push_back(Graphics::PixelFormat(2, 5, 6, 5, 0, 11,  5,  0,  0)); // BBDoU, Frotz, HDB, Hopkins, Nuvie, Petka, Riven, Sherlock (3DO), Titanic, Tony, Ultima 4, Ultima 8, ZVision
        list.push_back(Graphics::PixelFormat(4, 8, 8, 8, 8, 24, 16,  8,  0)); // Full Pipe, Gnap (little endian), Griffon, Groovie 2, SCI32 (HQ videos), Sludge, Sword25, Ultima 8, Wintermute
        list.push_back(Graphics::PixelFormat(4, 8, 8, 8, 8,  0,  8, 16, 24)); // Gnap (big endian)
        list.push_back(Graphics::PixelFormat(2, 5, 5, 5, 0, 10,  5,  0,  0)); // SCUMM HE99+, Last Express
        list.push_back(Graphics::PixelFormat(2, 5, 5, 5, 1, 10,  5,  0, 15)); // Dragons
        list.push_back(Graphics::PixelFormat::createFormatCLUT8());
        return list;
    }
#endif

    void initSize(uint width, uint height, const Graphics::PixelFormat *format = NULL) override {
        _width = width;
        _height = height;
        _format = format ? *format : Graphics::PixelFormat::createFormatCLUT8();
    }

    int getScreenChangeID() const override { return 0; }

    void beginGFXTransaction() override {}
    OSystem::TransactionError endGFXTransaction() override { return OSystem::kTransactionSuccess; }

    int16 getHeight() const override { return _height; }
    int16 getWidth() const override { return _width; }
    void setPalette(const byte *colors, uint start, uint num) override {}
    void grabPalette(byte *colors, uint start, uint num) const override {}
    void copyRectToScreen(const void *buf, int pitch, int x, int y, int w, int h) override {}
    Graphics::Surface *lockScreen() override { return NULL; }
    void unlockScreen() override {}
    void fillScreen(uint32 col) override {}
    void fillScreen(const Common::Rect &r, uint32 col) override {}
    void updateScreen() override {}
    void setShakePos(int shakeXOffset, int shakeYOffset) override {}
    void setFocusRectangle(const Common::Rect& rect) override {}
    void clearFocusRectangle() override {}

    void showOverlay(bool inGUI) override { _overlayVisible = true; }
    void hideOverlay() override { _overlayVisible = false; }
    bool isOverlayVisible() const override { return _overlayVisible; }
    Graphics::PixelFormat getOverlayFormat() const override { return Graphics::PixelFormat(2, 5, 6, 5, 0, 11, 5, 0, 0); }
    void clearOverlay() override {}
    void grabOverlay(Graphics::Surface &surface) const override {}
    void copyRectToOverlay(const void *buf, int pitch, int x, int y, int w, int h) override {}
    int16 getOverlayHeight() const override { return _height; }
    int16 getOverlayWidth() const override { return _width; }

    bool showMouse(bool visible) override { return !visible; }
    void warpMouse(int x, int y) override {}
    void setMouseCursor(const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, bool dontScale = false, const Graphics::PixelFormat *format = NULL, const byte *mask = NULL) override {}
    void setCursorPalette(const byte *colors, uint start, uint num) override {}

private:
    uint _width, _height;
    Graphics::PixelFormat _format;
    bool _overlayVisible;
};

#endif