sdl-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_SDL_SDLGRAPHICS_H
#define BACKENDS_GRAPHICS_SDL_SDLGRAPHICS_H

#include "backends/graphics/windowed.h"
#include "backends/platform/sdl/sdl-window.h"

#include "common/events.h"
#include "common/rect.h"

class SdlEventSource;

#define USE_OSD 1

class SdlGraphicsManager : virtual public WindowedGraphicsManager, public Common::EventObserver {
public:
    SdlGraphicsManager(SdlEventSource *source, SdlWindow *window);
    virtual ~SdlGraphicsManager() {}

    virtual void activateManager();

    virtual void deactivateManager();

    virtual void notifyVideoExpose() = 0;

    virtual void notifyResize(const int width, const int height) {}

    virtual bool notifyMousePosition(Common::Point &mouse);

    virtual bool showMouse(bool visible) override;
    bool lockMouse(bool lock) override;

    virtual bool saveScreenshot(const Common::Path &filename) const { return false; }
    void saveScreenshot() override;

    bool setRotationMode(Common::RotationMode rotation) override { _rotationMode = rotation; return true; }

    // Override from Common::EventObserver
    bool notifyEvent(const Common::Event &event) override;

    struct State {
        int screenWidth, screenHeight;
        bool aspectRatio;
        bool fullscreen;
        bool cursorPalette;
        bool vsync;
        Common::RotationMode rotation;

#ifdef USE_RGB_COLOR
        Graphics::PixelFormat pixelFormat;
#endif
    };

    State getState() const;

    bool setState(const State &state);

    SdlWindow *getWindow() const { return _window; }

    void initSizeHint(const Graphics::ModeList &modes) override;

    Common::Keymap *getKeymap();

protected:
    enum CustomEventAction {
        kActionToggleFullscreen = 100,
        kActionToggleMouseCapture,
        kActionToggleResizableWindow,
        kActionSaveScreenshot,
        kActionToggleAspectRatioCorrection,
        kActionToggleFilteredScaling,
        kActionCycleStretchMode,
        kActionIncreaseScaleFactor,
        kActionDecreaseScaleFactor,
        kActionNextScaleFilter,
        kActionPreviousScaleFilter
    };

    Common::Rect getPreferredFullscreenResolution();

    bool defaultGraphicsModeConfig() const;

    void getWindowSizeFromSdl(int *width, int *height) const {
#if SDL_VERSION_ATLEAST(3, 0, 0)
        assert(_window);
        SDL_GetWindowSizeInPixels(_window->getSDLWindow(), width, height);
#elif SDL_VERSION_ATLEAST(2, 0, 0)
        assert(_window);
        SDL_GL_GetDrawableSize(_window->getSDLWindow(), width, height);
#else
        assert(_hwScreen);

        if (width) {
            *width = _hwScreen->w;
        }

        if (height) {
            *height = _hwScreen->h;
        }
#endif
    }

    virtual void showSystemMouseCursor(bool visible);

    void setSystemMousePosition(const int x, const int y) override;

    void notifyActiveAreaChanged() override;

    void handleResizeImpl(const int width, const int height) override;

#if SDL_VERSION_ATLEAST(2, 0, 0)
public:
    void unlockWindowSize() {
        _allowWindowSizeReset = true;
        _hintedWidth = 0;
        _hintedHeight = 0;
    }

    // Called by SdlWindow when the window is about to be destroyed
    virtual void destroyingWindow() {}

protected:
    Uint32 _lastFlags;
    bool _allowWindowSizeReset;
    int _hintedWidth, _hintedHeight;

    bool createOrUpdateWindow(const int width, const int height, const Uint32 flags);
#endif

    SDL_Surface *_hwScreen;
    SdlEventSource *_eventSource;
    SdlWindow *_window;

    virtual bool canSwitchFullscreen() const { return false; }

private:
    void toggleFullScreen();

#if defined(USE_IMGUI) && SDL_VERSION_ATLEAST(2, 0, 0)
public:
    void setImGuiCallbacks(const ImGuiCallbacks &callbacks) override;

protected:
    ImGuiCallbacks _imGuiCallbacks;
    bool _imGuiReady = false;
    bool _imGuiInited = false;
    SDL_Renderer *_imGuiSDLRenderer = nullptr;

    void initImGui(SDL_Renderer *renderer, void *glContext);
    void renderImGui();
    void destroyImGui();
#endif

};

#endif