RenderTarget.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// 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.
//
 
#pragma once

// Headers
#include <SFML/Graphics/Export.hpp>
 
#include <SFML/Graphics/BlendMode.hpp>
#include <SFML/Graphics/Color.hpp>
#include <SFML/Graphics/CoordinateType.hpp>
#include <SFML/Graphics/PrimitiveType.hpp>
#include <SFML/Graphics/Rect.hpp>
#include <SFML/Graphics/RenderStates.hpp>
#include <SFML/Graphics/StencilMode.hpp>
#include <SFML/Graphics/Vertex.hpp>
#include <SFML/Graphics/View.hpp>
 
#include <SFML/System/Vector2.hpp>
 
#include <array>
 
#include <cstddef>
#include <cstdint>
 
 
namespace sf
{
class Drawable;
class Shader;
class Texture;
class Transform;
class VertexBuffer;

class SFML_GRAPHICS_API RenderTarget
{
public:
    virtual ~RenderTarget() = default;

    RenderTarget(const RenderTarget&) = delete;

    RenderTarget& operator=(const RenderTarget&) = delete;

    RenderTarget(RenderTarget&&) noexcept = default;

    RenderTarget& operator=(RenderTarget&&) noexcept = default;

    void clear(Color color = Color::Black);

    void clearStencil(StencilValue stencilValue);

    void clear(Color color, StencilValue stencilValue);

    void setView(const View& view);

    [[nodiscard]] const View& getView() const;

    [[nodiscard]] const View& getDefaultView() const;

    [[nodiscard]] IntRect getViewport(const View& view) const;

    [[nodiscard]] IntRect getScissor(const View& view) const;

    [[nodiscard]] Vector2f mapPixelToCoords(Vector2i point) const;

    [[nodiscard]] Vector2f mapPixelToCoords(Vector2i point, const View& view) const;

    [[nodiscard]] Vector2i mapCoordsToPixel(Vector2f point) const;

    [[nodiscard]] Vector2i mapCoordsToPixel(Vector2f point, const View& view) const;

    void draw(const Drawable& drawable, const RenderStates& states = RenderStates::Default);

    void draw(const Vertex*       vertices,
              std::size_t         vertexCount,
              PrimitiveType       type,
              const RenderStates& states = RenderStates::Default);

    void draw(const VertexBuffer& vertexBuffer, const RenderStates& states = RenderStates::Default);

    void draw(const VertexBuffer& vertexBuffer,
              std::size_t         firstVertex,
              std::size_t         vertexCount,
              const RenderStates& states = RenderStates::Default);

    [[nodiscard]] virtual Vector2u getSize() const = 0;

    [[nodiscard]] virtual bool isSrgb() const;

    [[nodiscard]] virtual bool setActive(bool active = true);

    void pushGLStates();

    void popGLStates();

    void resetGLStates();
 
protected:
    RenderTarget() = default;

    void initialize();
 
private:
    void applyCurrentView();

    void applyBlendMode(const BlendMode& mode);

    void applyStencilMode(const StencilMode& mode);

    void applyTransform(const Transform& transform);

    void applyTexture(const Texture* texture, CoordinateType coordinateType = CoordinateType::Pixels);

    void applyShader(const Shader* shader);

    void setupDraw(bool useVertexCache, const RenderStates& states);

    void drawPrimitives(PrimitiveType type, std::size_t firstVertex, std::size_t vertexCount);

    void cleanupDraw(const RenderStates& states);

    struct StatesCache
    {
        bool                  enable{};                
        bool                  glStatesSet{};           
        bool                  viewChanged{};           
        bool                  scissorEnabled{};        
        bool                  stencilEnabled{};        
        BlendMode             lastBlendMode;           
        StencilMode           lastStencilMode;         
        std::uint64_t         lastTextureId{};         
        CoordinateType        lastCoordinateType{};    
        bool                  texCoordsArrayEnabled{}; 
        bool                  useVertexCache{};        
        std::array<Vertex, 4> vertexCache{};           
    };

    // Member data
    View          m_defaultView; 
    View          m_view;        
    StatesCache   m_cache{};     
    std::uint64_t m_id{};        
};
 
} // namespace sf