BackendRenderTarget.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2021 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
 
#ifndef TGUI_BACKEND_RENDER_TARGET_HPP
#define TGUI_BACKEND_RENDER_TARGET_HPP
 
#include <TGUI/Rect.hpp>
#include <TGUI/Color.hpp>
#include <TGUI/Sprite.hpp>
#include <TGUI/Text.hpp>
#include <TGUI/Outline.hpp>
#include <TGUI/RenderStates.hpp>
 
 
namespace tgui
{
 class Widget;
 class RootContainer;
 
 
 class TGUI_API BackendRenderTarget
 {
 public:
 
 virtual ~BackendRenderTarget() = default;
 
 
#ifdef TGUI_NEXT
 virtual void setClearColor(const tgui::Color& color) = 0;
#else
 virtual void setClearColor(const tgui::Color& color) { (void)color; }
#endif
 
#ifdef TGUI_NEXT
 virtual void clearScreen() = 0;
#else
 virtual void clearScreen() {}
#endif
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
 TGUI_DEPRECATED("Use setView(view, viewport, targetSize) instead") virtual void setView(FloatRect view, FloatRect viewport);
#endif
 
 virtual void setView(FloatRect view, FloatRect viewport, Vector2f targetSize);
 
 
 virtual void drawGui(const std::shared_ptr<RootContainer>& root) = 0;
 
 
 virtual void drawWidget(const RenderStates& states, const std::shared_ptr<Widget>& widget);
 
 
 virtual void addClippingLayer(const RenderStates& states, FloatRect rect);
 
 
 virtual void removeClippingLayer();
 
 
 virtual void drawBorders(const RenderStates& states, const Borders& borders, Vector2f size, Color color);
 
 
 virtual void drawFilledRect(const RenderStates& states, Vector2f size, Color color);
 
 
 virtual void drawSprite(const RenderStates& states, const Sprite& sprite);
 
 
 virtual void drawText(const RenderStates& states, const Text& text);
 
 
 TGUI_DEPRECATED("Use drawVertexArray instead") virtual void drawTriangles(const RenderStates& states, const Vertex* vertices, std::size_t vertexCount, const int* indices = nullptr, std::size_t indexCount = 0);
 
 
 void drawTriangles(const RenderStates& states, std::initializer_list<Vertex> vertices, std::initializer_list<int> indices = {});
 
 
 virtual void drawCircle(const RenderStates& states, float size, const Color& backgroundColor, float borderThickness = 0, const Color& borderColor = {});
 
 
 virtual void drawRoundedRectangle(const RenderStates& states, const Vector2f& size, const Color& backgroundColor, float radius,
 const Borders& borders = {0}, const Color& borderColor = Color::Black);
 
 
#ifdef TGUI_NEXT
 virtual void drawVertexArray(const RenderStates& states, const Vertex* vertices, std::size_t vertexCount,
 const int* indices, std::size_t indexCount, const std::shared_ptr<BackendTexture>& texture) = 0;
#else
 virtual void drawVertexArray(const RenderStates& states, const Vertex* vertices, std::size_t vertexCount,
 const int* indices, std::size_t indexCount, const std::shared_ptr<BackendTexture>& texture);
#endif
 
 protected:
 
#ifdef TGUI_NEXT
 virtual void updateClipping(FloatRect clipRect, FloatRect clipViewport) = 0;
#else
 virtual void updateClipping(FloatRect clipRect, FloatRect clipViewport) { (void)clipRect; (void)clipViewport; };
#endif
 
 
 protected:
 
 FloatRect m_viewRect;
 FloatRect m_viewport;
 Vector2f m_targetSize;
 
 std::vector<std::pair<FloatRect, FloatRect>> m_clipLayers;
 };
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
 using BackendRenderTargetBase TGUI_DEPRECATED("BackendRenderTargetBase was renamed to BackendRenderTarget") = BackendRenderTarget;
#endif
 
}
 
 
#endif // TGUI_BACKEND_RENDER_TARGET_HPP