RenderTarget.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2018 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.
//

#ifndef SFML_RENDERTARGET_HPP
#define SFML_RENDERTARGET_HPP

// Headers
#include <SFML/Graphics/Export.hpp>
#include <SFML/Graphics/Color.hpp>
#include <SFML/Graphics/Rect.hpp>
#include <SFML/Graphics/View.hpp>
#include <SFML/Graphics/Transform.hpp>
#include <SFML/Graphics/BlendMode.hpp>
#include <SFML/Graphics/RenderStates.hpp>
#include <SFML/Graphics/PrimitiveType.hpp>
#include <SFML/Graphics/Vertex.hpp>
#include <SFML/System/NonCopyable.hpp>


namespace sf
{
class Drawable;
class VertexBuffer;

class SFML_GRAPHICS_API RenderTarget : NonCopyable
{
public:

    virtual ~RenderTarget();

    void clear(const Color& color = Color(0, 0, 0, 255));

    void setView(const View& view);

    const View& getView() const;

    const View& getDefaultView() const;

    IntRect getViewport(const View& view) const;

    Vector2f mapPixelToCoords(const Vector2i& point) const;

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

    Vector2i mapCoordsToPixel(const Vector2f& point) const;

    Vector2i mapCoordsToPixel(const 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);

    virtual Vector2u getSize() const = 0;

    virtual bool setActive(bool active = true);

    void pushGLStates();

    void popGLStates();

    void resetGLStates();

protected:

    RenderTarget();

    void initialize();

private:

    void applyCurrentView();

    void applyBlendMode(const BlendMode& mode);

    void applyTransform(const Transform& transform);

    void applyTexture(const Texture* texture);

    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
    {
        enum {VertexCacheSize = 4};

        bool      enable;         
        bool      glStatesSet;    
        bool      viewChanged;    
        BlendMode lastBlendMode;  
        Uint64    lastTextureId;  
        bool      texCoordsArrayEnabled; 
        bool      useVertexCache; 
        Vertex    vertexCache[VertexCacheSize]; 
    };

    // Member data
    View        m_defaultView; 
    View        m_view;        
    StatesCache m_cache;       
    Uint64      m_id;          
};

} // namespace sf


#endif // SFML_RENDERTARGET_HPP