graphics.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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 2 of the License, or
 *  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/>.
 */
 
#pragma once
 
#include "resources/image.h"
 
#include <SDL.h>
 
#include <guichan/color.hpp>
#include <guichan/graphics.hpp>
 
#include <memory>
#include <optional>
 
struct TextFormat;
 
enum class FillMode
{
    Stretch,
    Repeat,
};
 
struct ImageRect
{
    std::unique_ptr<Image> image;
    int top = 0;
    int left = 0;
    int bottom = 0;
    int right = 0;
    FillMode fillMode = FillMode::Stretch;
 
    int minWidth() const { return left + right; }
    int minHeight() const { return top + bottom; }
};
 
class Graphics : public gcn::Graphics
{
    public:
        Graphics() = default;
 
        virtual void setVSync(bool sync) = 0;
 
        virtual void updateSize(int width, int height, float scale);
 
        using gcn::Graphics::drawImage;
 
        bool drawImage(const Image *image, int x, int y);
 
        bool drawImageF(const Image *image, float x, float y);
 
        bool drawRescaledImage(const Image *image, int x, int y, int width, int height);
 
        virtual bool drawRescaledImage(const Image *image,
                                       int srcX, int srcY,
                                       int dstX, int dstY,
                                       int width, int height,
                                       int desiredWidth, int desiredHeight,
                                       bool useColor = false) = 0;
 
        virtual bool drawRescaledImageF(const Image *image, int srcX, int srcY,
                                        float dstX, float dstY,
                                        int width, int height,
                                        float desiredWidth, float desiredHeight,
                                        bool useColor = false);
 
        virtual bool drawImage(const Image *image,
                               int srcX, int srcY,
                               int dstX, int dstY,
                               int width, int height,
                               bool useColor = false);
 
        virtual bool drawImageF(const Image *image,
                                int srcX, int srcY,
                                float dstX, float dstY,
                                int width, int height,
                                bool useColor = false);
 
        virtual void drawImagePattern(const Image *image,
                                      int x, int y,
                                      int w, int h);
 
        void drawRescaledImagePattern(const Image *image,
                                      int x, int y,
                                      int w, int h,
                                      int scaledWidth,
                                      int scaledHeight);
 
        virtual void drawRescaledImagePattern(const Image *image,
                                              int srcX, int srcY,
                                              int srcW, int srcH,
                                              int dstX, int dstY,
                                              int dstW, int dstH,
                                              int scaledWidth,
                                              int scaledHeight) = 0;
 
        void drawImageRect(const ImageRect &imgRect, int x, int y, int w, int h);
 
        void drawImageRect(const ImageRect &imgRect, const gcn::Rectangle &area)
        {
            drawImageRect(imgRect, area.x, area.y, area.width, area.height);
        }
 
        using gcn::Graphics::drawText;
 
        void drawText(const std::string &text,
                      int x, int y,
                      gcn::Graphics::Alignment alignment,
                      const gcn::Color &color,
                      gcn::Font *font,
                      bool outline = false,
                      bool shadow = false,
                      const std::optional<gcn::Color> &outlineColor = {},
                      const std::optional<gcn::Color> &shadowColor = {});
 
        void drawText(const std::string &text,
                      int x,
                      int y,
                      gcn::Graphics::Alignment align,
                      gcn::Font *font,
                      const TextFormat &format);
 
        virtual void updateScreen() = 0;
 
        int getWidth() const { return mWidth; }
 
        int getHeight() const { return mHeight; }
 
        float getScale() const { return mScale; }
 
        virtual void windowToLogical(int windowX, int windowY,
                                     float &logicalX, float &logicalY) const = 0;
 
        void _beginDraw() override;
        void _endDraw() override;
 
        virtual SDL_Surface *getScreenshot() = 0;
 
        gcn::Font *getFont() const { return mFont; }
 
        void drawImage(const gcn::Image *image,
                       int srcX, int srcY,
                       int dstX, int dstY,
                       int width, int height) override {}   // not used
 
        void setColor(const gcn::Color &color) override
        {
            mColor = color;
        }
 
        const gcn::Color &getColor() const final
        {
            return mColor;
        }
 
        void pushClipRect(const gcn::Rectangle &rect);
        void popClipRect();
 
    protected:
        virtual void updateClipRect() = 0;
 
        int mWidth = 0;
        int mHeight = 0;
        float mScale = 1.0f;
        gcn::Color mColor;
 
        // Actual clipping rects. Clipping by gcn::Graphics::mClipStack is disabled.
        std::stack<gcn::Rectangle> mClipRects;
};
 
extern Graphics *graphics;