RenderWindow.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/RenderTarget.hpp>
 
#include <SFML/Window/ContextSettings.hpp>
#include <SFML/Window/VideoMode.hpp>
#include <SFML/Window/Window.hpp>
#include <SFML/Window/WindowEnums.hpp>
#include <SFML/Window/WindowHandle.hpp>
 
#include <SFML/System/Vector2.hpp>
 
#include <cstdint>
 
 
namespace sf
{
class Image;
class String;

class SFML_GRAPHICS_API RenderWindow : public Window, public RenderTarget
{
public:
    RenderWindow() = default;

    RenderWindow(VideoMode              mode,
                 const String&          title,
                 std::uint32_t          style    = Style::Default,
                 State                  state    = State::Windowed,
                 const ContextSettings& settings = {});

    RenderWindow(VideoMode mode, const String& title, State state, const ContextSettings& settings = {});

    explicit RenderWindow(WindowHandle handle, const ContextSettings& settings = {});

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

    void setIcon(const Image& icon);
    using Window::setIcon;

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

    [[nodiscard]] bool setActive(bool active = true) override;
 
protected:
    void onCreate() override;

    void onResize() override;
 
private:
    // Member data
    unsigned int m_defaultFrameBuffer{}; 
};
 
} // namespace sf