documentation/3.0.0/RenderTexture_8hpp_source.html

//

// 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/RenderTarget.hpp>

#include <SFML/Graphics/Texture.hpp>


#include <SFML/Window/ContextSettings.hpp>


#include <SFML/System/Vector2.hpp>


#include <memory>


namespace sf

{

namespace priv

{

class RenderTextureImpl;

}


class SFML_GRAPHICS_API RenderTexture : public RenderTarget

{

public:

    RenderTexture();


    RenderTexture(Vector2u size, const ContextSettings& settings = {});


    ~RenderTexture() override;


    RenderTexture(const RenderTexture&) = delete;


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


    RenderTexture(RenderTexture&&) noexcept;


    RenderTexture& operator=(RenderTexture&&) noexcept;


    [[nodiscard]] bool resize(Vector2u size, const ContextSettings& settings = {});


    [[nodiscard]] static unsigned int getMaximumAntiAliasingLevel();


    void setSmooth(bool smooth);


    [[nodiscard]] bool isSmooth() const;


    void setRepeated(bool repeated);


    [[nodiscard]] bool isRepeated() const;


    [[nodiscard]] bool generateMipmap();


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


    void display();


    [[nodiscard]] Vector2u getSize() const override;


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


    [[nodiscard]] const Texture& getTexture() const;


private:

    // Member data

    std::unique_ptr<priv::RenderTextureImpl> m_impl;

    Texture                                  m_texture;

};


} // namespace sf


ContextSettings.hpp

Export.hpp

SFML_GRAPHICS_API
#define SFML_GRAPHICS_API
Definition Graphics/Export.hpp:42

RenderTarget.hpp

Texture.hpp

Vector2.hpp

sf::RenderTarget::RenderTarget
RenderTarget(const RenderTarget &)=delete
Deleted copy constructor.

sf::RenderTexture::RenderTexture
RenderTexture()
Default constructor.

sf::RenderTexture::operator=
RenderTexture & operator=(const RenderTexture &)=delete
Deleted copy assignment.

sf::RenderTexture::setActive
bool setActive(bool active=true) override
Activate or deactivate the render-texture for rendering.

sf::RenderTexture::~RenderTexture
~RenderTexture() override
Destructor.

sf::RenderTexture::RenderTexture
RenderTexture(RenderTexture &&) noexcept
Move constructor.

sf::RenderTexture::isSmooth
bool isSmooth() const
Tell whether the smooth filtering is enabled or not.

sf::RenderTexture::getTexture
const Texture & getTexture() const
Get a read-only reference to the target texture.

sf::RenderTexture::RenderTexture
RenderTexture(const RenderTexture &)=delete
Deleted copy constructor.

sf::RenderTexture::getSize
Vector2u getSize() const override
Return the size of the rendering region of the texture.

sf::RenderTexture::isRepeated
bool isRepeated() const
Tell whether the texture is repeated or not.

sf::RenderTexture::generateMipmap
bool generateMipmap()
Generate a mipmap using the current texture data.

sf::RenderTexture::getMaximumAntiAliasingLevel
static unsigned int getMaximumAntiAliasingLevel()
Get the maximum anti-aliasing level supported by the system.

sf::RenderTexture::RenderTexture
RenderTexture(Vector2u size, const ContextSettings &settings={})
Construct a render-texture.

sf::RenderTexture::isSrgb
bool isSrgb() const override
Tell if the render-texture will use sRGB encoding when drawing on it.

sf::RenderTexture::resize
bool resize(Vector2u size, const ContextSettings &settings={})
Resize the render-texture.

sf::RenderTexture::setSmooth
void setSmooth(bool smooth)
Enable or disable texture smoothing.

sf::RenderTexture::setRepeated
void setRepeated(bool repeated)
Enable or disable texture repeating.

sf::RenderTexture::display
void display()
Update the contents of the target texture.

sf::Texture
Image living on the graphics card that can be used for drawing.
Definition Texture.hpp:56

sf
Definition AudioResource.hpp:36

sf::Vector2u
Vector2< unsigned int > Vector2u
Definition Vector2.hpp:209

sf::ContextSettings
Structure defining the settings of the OpenGL context attached to a window.
Definition ContextSettings.hpp:39