devicecaps.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_DEVICECAPS_H
#define FIFE_DEVICECAPS_H

// Standard C++ library includes
#include <string>
#include <vector>

// Platform specific includes

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/structures/rect.h"

namespace FIFE {

    class ScreenMode {
    public:
        ScreenMode();
        ScreenMode(uint16_t width, uint16_t height, uint16_t bpp, uint32_t SDLFlags);
        ScreenMode(uint16_t width, uint16_t height, uint16_t bpp, uint16_t rate, uint32_t SDLFlags);
        ScreenMode(const ScreenMode& rhs);

        ~ScreenMode() {};

        bool operator <(const ScreenMode& rhs) const;

        uint16_t getWidth() const { return m_width; };

        uint16_t getHeight() const { return m_height; };

        uint16_t getBPP() const { return m_bpp; };

        uint16_t getRefreshRate() const { return m_refreshRate; }

        uint32_t getSDLFlags() const { return m_SDLFlags; };

        bool isFullScreen() const { return (m_SDLFlags & SDL_WINDOW_FULLSCREEN) ? true : false;};

        bool isOpenGL() const { return (m_SDLFlags & SDL_WINDOW_OPENGL) ? true : false; };

        bool isSDL() const { return (!(m_SDLFlags & SDL_WINDOW_OPENGL)) ? true : false; };

        void setFormat(uint32_t format) { m_format = format;}

        uint32_t getFormat() const { return m_format; }

        void setDisplay(uint8_t display) { m_display = display; }

        uint8_t getDisplay() const { return m_display; }
        
        void setRenderDriverName(const std::string driver) { m_renderDriver = driver; }

        const std::string& getRenderDriverName() const { return m_renderDriver; }

        void setRenderDriverIndex(int8_t index) { m_renderDriverIndex = index; }

        int8_t getRenderDriverIndex() const { return m_renderDriverIndex; }

        //OpenGL, windowed
        static const uint32_t WINDOWED_OPENGL = SDL_WINDOW_OPENGL;
        //OpenGL, fullscreen
        static const uint32_t FULLSCREEN_OPENGL = SDL_WINDOW_OPENGL | SDL_WINDOW_FULLSCREEN;
        //SDL, windowed
        static const uint32_t WINDOWED_SDL = 0;
        //SDL, fullscreen
        static const uint32_t FULLSCREEN_SDL = SDL_WINDOW_FULLSCREEN;

    private:
        uint16_t m_width;
        uint16_t m_height;
        uint16_t m_bpp;
        uint16_t m_refreshRate;
        uint32_t m_SDLFlags;
        uint32_t m_format;
        uint8_t m_display;
        std::string m_renderDriver;
        int8_t m_renderDriverIndex;
    };  //ScreenMode

    class DeviceCaps {
    public:
        DeviceCaps();

        ~DeviceCaps();

        void fillDeviceCaps();

        void reset();

        std::vector<std::string> getAvailableVideoDrivers() const { return m_availableVideoDrivers; };

        std::vector<std::string> getAvailableRenderDrivers() const { return m_availableRenderDrivers; };

        std::vector<ScreenMode> getSupportedScreenModes() const { return m_screenModes; };

        ScreenMode getNearestScreenMode(uint16_t width, uint16_t height, uint16_t bpp, const std::string& renderer, bool fs) const;

        ScreenMode getNearestScreenMode(uint16_t width, uint16_t height, uint16_t bpp, const std::string& renderer, bool fs, uint16_t refresh, uint8_t display = 0) const;

        std::string getVideoDriverName() const { return m_videoDriverName; }

        void setVideoDriverName(const std::string& driver) { m_videoDriverName = driver; }

        std::string getRenderDriverName() const { return m_renderDriverName; }

        void setRenderDriverName(const std::string& driver);

        uint8_t getDisplayCount() const;

        std::string getDisplayName(uint8_t display = 0) const;

        uint32_t getDesktopFormat(uint8_t display = 0) const;
        
        int32_t getDesktopRefreshRate(uint8_t display = 0) const;

        int32_t getDesktopWidth(uint8_t display = 0) const;

        int32_t getDesktopHeight(uint8_t display = 0) const;

        Rect getDisplayBounds(uint8_t display = 0) const;

    private:
        std::vector<ScreenMode> m_screenModes;
        std::string m_videoDriverName;
        std::vector<std::string> m_availableVideoDrivers;

        std::string m_renderDriverName;
        int8_t m_renderDriverIndex;
        std::vector<std::string> m_availableRenderDrivers;

        void fillAvailableDrivers();
    }; //DeviceCaps
} //FIFE



#endif //FIFE_DEVICECAPS_H