renderbackend.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_VIDEO_RENDERBACKEND_H
#define FIFE_VIDEO_RENDERBACKEND_H

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

// Platform specific includes
#include "util/base/fife_stdint.h"

// 3rd party library includes
#include <SDL.h>
#include <SDL_video.h>

// 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/base/singleton.h"
#include "util/structures/point.h"
#include "util/structures/rect.h"
#include "video/devicecaps.h"

#include "image.h"
#include "color.h"

#ifdef HAVE_OPENGL
#include "video/opengl/fife_opengl.h"
#endif

namespace FIFE {

    class Image;

#ifdef HAVE_OPENGL
    enum GLConstants {
        KEEP = GL_KEEP,
        ZERO = GL_ZERO,
        REPLACE = GL_REPLACE,
        INCR = GL_INCR,
        DECR = GL_DECR,
        INVERT = GL_INVERT,
        NEVER = GL_NEVER,
        LESS = GL_LESS,
        LEQUAL = GL_LEQUAL,
        GREATER = GL_GREATER,
        GEQUAL = GL_GEQUAL,
        EQUAL = GL_EQUAL,
        NOTEQUAL = GL_NOTEQUAL,
        ALWAYS = GL_ALWAYS
    };
#else
    enum GLConstants {
        KEEP = 0,
        ZERO,
        REPLACE,
        INCR,
        DECR,
        INVERT,
        NEVER,
        LESS,
        LEQUAL,
        GREATER,
        GEQUAL,
        EQUAL,
        NOTEQUAL,
        ALWAYS
    };
#endif
    
    enum OverlayType {
        OVERLAY_TYPE_NONE = 0,
        OVERLAY_TYPE_COLOR = 1,
        OVERLAY_TYPE_COLOR_AND_TEXTURE = 2,
        OVERLAY_TYPE_TEXTURES_AND_FACTOR = 3
    };

    enum TextureFiltering {
        TEXTURE_FILTER_NONE = 0,
        TEXTURE_FILTER_BILINEAR = 1,
        TEXTURE_FILTER_TRILINEAR = 2,
        TEXTURE_FILTER_ANISOTROPIC = 3
    };

    enum RenderDataType {
        RENDER_DATA_WITHOUT_Z = 0,
        RENDER_DATA_TEXTURE_Z = 1,
        RENDER_DATA_TEXCOLOR_Z = 2,
        RENDER_DATA_MULTITEXTURE_Z = 3
    };

    class GuiVertex {
    public:
        DoublePoint position;
        Color color;
        DoublePoint texCoords;
    };

    class RenderBackend: public DynamicSingleton<RenderBackend> {
    public:
        RenderBackend(const SDL_Color& colorkey);

        virtual ~RenderBackend();

        virtual const std::string& getName() const = 0;

        virtual void startFrame();

        virtual void endFrame();

        virtual void init(const std::string& driver) = 0;

        virtual void clearBackBuffer() = 0;

        virtual void setLightingModel(uint32_t lighting) = 0;

        virtual uint32_t getLightingModel() const = 0;

        virtual void setLighting(float red, float green, float blue) = 0;

        virtual void resetLighting() = 0;

        virtual void resetStencilBuffer(uint8_t buffer) = 0;

        virtual void changeBlending(int32_t scr, int32_t dst) = 0;

        void deinit();

        virtual void createMainScreen(const ScreenMode& mode, const std::string& title, const std::string& icon) = 0;

        virtual void setScreenMode(const ScreenMode& mode) = 0;

        virtual Image* createImage(IResourceLoader* loader = 0) = 0;
        virtual Image* createImage(const std::string& name, IResourceLoader* loader = 0) = 0;

        virtual Image* createImage(const uint8_t* data, uint32_t width, uint32_t height) = 0;
        virtual Image* createImage(const std::string& name, const uint8_t* data, uint32_t width, uint32_t height) = 0;

        virtual Image* createImage(SDL_Surface* surface) = 0;
        virtual Image* createImage(const std::string& name, SDL_Surface* surface) = 0;

        virtual void renderVertexArrays() = 0;

        virtual void addImageToArray(uint32_t id, const Rect& rec, float const* st, uint8_t alpha, uint8_t const* rgba) = 0;

        virtual void changeRenderInfos(RenderDataType type, uint16_t elements, int32_t src, int32_t dst, bool light, bool stentest, uint8_t stenref, GLConstants stenop, GLConstants stenfunc, OverlayType otype = OVERLAY_TYPE_NONE) = 0;

        virtual void captureScreen(const std::string& filename) = 0;

        virtual void captureScreen(const std::string& filename, uint32_t width, uint32_t height) = 0;

        SDL_Window* getWindow() {return m_window; }

        const ScreenMode& getCurrentScreenMode() const;

        uint32_t getWidth() const;
        uint32_t getHeight() const;
        uint32_t getScreenWidth() const { return getWidth(); }
        uint32_t getScreenHeight() const { return getHeight(); }
        const Rect& getArea() const;

        void pushClipArea(const Rect& cliparea, bool clear=true);

        void popClipArea();

        const Rect& getClipArea() const;

        virtual bool putPixel(int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawLine(const Point& p1, const Point& p2, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawThickLine(const Point& p1, const Point& p2, uint8_t width, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawPolyLine(const std::vector<Point>& points, uint8_t width, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawBezier(const std::vector<Point>& points, int32_t steps, uint8_t width, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawTriangle(const Point& p1, const Point& p2, const Point& p3, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawRectangle(const Point& p, uint16_t w, uint16_t h, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void fillRectangle(const Point& p, uint16_t w, uint16_t h, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255)  = 0;

        virtual void drawQuad(const Point& p1, const Point& p2, const Point& p3, const Point& p4,  uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawVertex(const Point& p, const uint8_t size, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawCircle(const Point& p, uint32_t radius, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawFillCircle(const Point& p, uint32_t radius, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawCircleSegment(const Point& p, uint32_t radius, int32_t sangle, int32_t eangle, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawFillCircleSegment(const Point& p, uint32_t radius, int32_t sangle, int32_t eangle, uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255) = 0;

        virtual void drawLightPrimitive(const Point& p, uint8_t intensity, float radius, int32_t subdivisions, float xstretch, float ystretch, uint8_t red, uint8_t green, uint8_t blue) = 0;

        virtual void enableScissorTest() = 0;
        
        virtual void disableScissorTest() = 0;

        void setAlphaOptimizerEnabled(bool enabled){ m_isalphaoptimized = enabled; }

        bool isAlphaOptimizerEnabled() const { return m_isalphaoptimized; }

        void setImageCompressingEnabled(bool enabled) { m_compressimages = enabled; }

        bool isImageCompressingEnabled() const { return m_compressimages; }

        void setFramebufferEnabled(bool enabled) { m_useframebuffer = enabled; }

        bool isFramebufferEnabled() const { return m_useframebuffer; }

        void setNPOTEnabled(bool enabled) { m_usenpot = enabled; }

        bool isNPOTEnabled() const { return m_usenpot; }

        void setTextureFiltering(TextureFiltering filter);

        TextureFiltering getTextureFiltering() const;

        void setMipmappingEnabled(bool enabled);

        bool isMipmappingEnabled() const;
        
        int32_t getMaxAnisotropy() const;

        void setMonochromeEnabled(bool enabled);

        bool isMonochromeEnabled() const;

        void setDepthBufferEnabled(bool enabled);

        bool isDepthBufferEnabled() const;

        void setAlphaTestValue(float alpha);

        float getAlphaTestValue() const;

        void setColorKeyEnabled(bool colorkeyenable);

        bool isColorKeyEnabled() const;

        void setColorKey(const SDL_Color& colorkey);

        const SDL_Color& getColorKey() const;

        void setBackgroundColor(uint8_t r, uint8_t g, uint8_t b);

        void resetBackgroundColor();

        const SDL_PixelFormat& getPixelFormat() const;

        void setVSyncEnabled(bool vsync);

        bool isVSyncEnabled() const;

        void setFrameLimitEnabled(bool limited);

        bool isFrameLimitEnabled() const;

        void setFrameLimit(uint16_t framelimit);

        uint16_t getFrameLimit() const;

         SDL_Surface* getScreenSurface();

        SDL_Surface* getRenderTargetSurface();

        virtual void attachRenderTarget(ImagePtr& img, bool discard) = 0;

        virtual void detachRenderTarget() = 0;
        
        virtual void renderGuiGeometry(const std::vector<GuiVertex>& vertices, const std::vector<int>& indices, const DoublePoint& translation, ImagePtr texture) = 0;
        
        Point getBezierPoint(const std::vector<Point>& points, int32_t elements, float t);

        void addControlPoints(const std::vector<Point>& points, std::vector<Point>& newPoints);

    protected:
        
        virtual void setClipArea(const Rect& cliparea, bool clear) = 0;

        SDL_Window* m_window;
        SDL_Surface* m_screen;
        SDL_Surface* m_target;
        bool m_compressimages;
        bool m_useframebuffer;
        bool m_usenpot;
        bool m_isalphaoptimized;
        bool m_iscolorkeyenabled;
        SDL_Color m_colorkey;
        ScreenMode m_screenMode;
        SDL_PixelFormat m_rgba_format;

        bool m_isbackgroundcolor;
        SDL_Color m_backgroundcolor;

        // mipmapping
        bool m_isMipmapping;
        // texture filter
        TextureFiltering m_textureFilter;
        // max anisotropy
        int32_t m_maxAnisotropy;
        // monochrome rendering
        bool m_monochrome;
        // depth buffer rendering
        bool m_isDepthBuffer;
        // alpha test value
        float m_alphaValue;
        // vsync value
        bool m_vSync;

        void clearClipArea();

        class ClipInfo {
        public:
            Rect r;
            bool clearing;
        };
        std::stack<ClipInfo> m_clipstack;

        ClipInfo m_guiClip;
    private:
        bool m_isframelimit;
        uint32_t m_frame_start;
        uint16_t m_framelimit;
        
    };
}

#endif