sdl-window.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_PLATFORM_SDL_WINDOW_H
#define BACKENDS_PLATFORM_SDL_WINDOW_H

#include "backends/platform/sdl/sdl-sys.h"

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

class SdlWindow {
public:
    SdlWindow();
    virtual ~SdlWindow();

    virtual void setupIcon();

    void setWindowCaption(const Common::String &caption);

    void setResizable(bool resizable);

    void grabMouse(bool grab);

    void setMouseRect(const Common::Rect &rect);

    bool lockMouse(bool lock);

    bool hasMouseFocus() const;

    bool warpMouseInWindow(int x, int y);

    void iconifyWindow();

#if !SDL_VERSION_ATLEAST(3, 0, 0)

    bool getSDLWMInformation(SDL_SysWMinfo *info) const;
#endif

    /*
     * Retrieve the current desktop resolution.
     */
    Common::Rect getDesktopResolution();

    /*
     * Get the scaling between the SDL Window size and the SDL
     * drawable area size. On some system, when HiDPI support is
     * enabled, those two sizes are different.
     *
     * To convert from window coordinate to drawable area coordinate,
     * multiple the coordinate by this scaling factor. To convert
     * from drawable area coordinate to window coordinate, divide the
     * coordinate by this scaling factor.
     */
    float getSdlDpiScalingFactor() const;

    virtual float getDpiScalingFactor() const;

    bool resizable() const {
#if SDL_VERSION_ATLEAST(2, 0, 0)
        if (_window) {
            return SDL_GetWindowFlags(_window) & SDL_WINDOW_RESIZABLE;
        }
#endif
        return _resizable;
    }

    bool mouseIsGrabbed() const {
#if SDL_VERSION_ATLEAST(3, 0, 0)
        if (_window) {
            return SDL_GetWindowMouseGrab(_window);
        }
#elif SDL_VERSION_ATLEAST(2, 0, 0)
        if (_window) {
            return SDL_GetWindowGrab(_window) == SDL_TRUE;
        }
#endif
        return _inputGrabState;
    }

    bool mouseIsLocked() const {
#if SDL_VERSION_ATLEAST(3, 0, 0)
        return SDL_GetWindowRelativeMouseMode(_window);
#elif SDL_VERSION_ATLEAST(2, 0, 0)
        return SDL_GetRelativeMouseMode() == SDL_TRUE;
#else
        return _inputLockState;
#endif
    }

private:
    Common::Rect _desktopRes;
    bool _resizable;
    bool _inputGrabState, _inputLockState;
    SDL_Rect grabRect;

protected:
    void getDisplayDpi(float *dpi, float *defaultDpi) const;

#if SDL_VERSION_ATLEAST(2, 0, 0)
public:
    SDL_Window *getSDLWindow() const { return _window; }

    int getDisplayIndex() const;

    virtual bool createOrUpdateWindow(int width, int height, uint32 flags);

    void destroyWindow();

protected:
    SDL_Window *_window;

private:
    uint32 _lastFlags;

    int _lastX, _lastY;

    Common::String _windowCaption;
#endif
};

class SdlIconlessWindow : public SdlWindow {
public:
    virtual void setupIcon() {}
};

#endif