sf::RenderWindow Class Reference

Window that can serve as a target for 2D drawing. More...

#include <RenderWindow.hpp>

Inheritance diagram for sf::RenderWindow:

Collaboration diagram for sf::RenderWindow:

Public Member Functions
	RenderWindow ()
	Default constructor. More...
	RenderWindow (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())
	Construct a new window. More...
	RenderWindow (WindowHandle handle, const ContextSettings &settings=ContextSettings())
	Construct the window from an existing control. More...
virtual	~RenderWindow ()
	Destructor. More...
virtual Vector2u	getSize () const
	Get the size of the rendering region of the window. More...
bool	setActive (bool active=true)
	Activate or deactivate the window as the current target for OpenGL rendering. More...
SFML_DEPRECATED Image	capture () const
	Copy the current contents of the window to an image. More...
Public Member Functions inherited from sf::Window
	Window ()
	Default constructor. More...
	Window (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())
	Construct a new window. More...
	Window (WindowHandle handle, const ContextSettings &settings=ContextSettings())
	Construct the window from an existing control. More...
virtual	~Window ()
	Destructor. More...
void	create (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())
	Create (or recreate) the window. More...
void	create (WindowHandle handle, const ContextSettings &settings=ContextSettings())
	Create (or recreate) the window from an existing control. More...
void	close ()
	Close the window and destroy all the attached resources. More...
bool	isOpen () const
	Tell whether or not the window is open. More...
const ContextSettings &	getSettings () const
	Get the settings of the OpenGL context of the window. More...
bool	pollEvent (Event &event)
	Pop the event on top of the event queue, if any, and return it. More...
bool	waitEvent (Event &event)
	Wait for an event and return it. More...
Vector2i	getPosition () const
	Get the position of the window. More...
void	setPosition (const Vector2i &position)
	Change the position of the window on screen. More...
Vector2u	getSize () const
	Get the size of the rendering region of the window. More...
void	setSize (const Vector2u &size)
	Change the size of the rendering region of the window. More...
void	setTitle (const String &title)
	Change the title of the window. More...
void	setIcon (unsigned int width, unsigned int height, const Uint8 *pixels)
	Change the window's icon. More...
void	setVisible (bool visible)
	Show or hide the window. More...
void	setVerticalSyncEnabled (bool enabled)
	Enable or disable vertical synchronization. More...
void	setMouseCursorVisible (bool visible)
	Show or hide the mouse cursor. More...
void	setMouseCursorGrabbed (bool grabbed)
	Grab or release the mouse cursor. More...
void	setMouseCursor (const Cursor &cursor)
	Set the displayed cursor to a native system cursor. More...
void	setKeyRepeatEnabled (bool enabled)
	Enable or disable automatic key-repeat. More...
void	setFramerateLimit (unsigned int limit)
	Limit the framerate to a maximum fixed frequency. More...
void	setJoystickThreshold (float threshold)
	Change the joystick threshold. More...
bool	setActive (bool active=true) const
	Activate or deactivate the window as the current target for OpenGL rendering. More...
void	requestFocus ()
	Request the current window to be made the active foreground window. More...
bool	hasFocus () const
	Check whether the window has the input focus. More...
void	display ()
	Display on screen what has been rendered to the window so far. More...
WindowHandle	getSystemHandle () const
	Get the OS-specific handle of the window. More...
Public Member Functions inherited from sf::RenderTarget
virtual	~RenderTarget ()
	Destructor. More...
void	clear (const Color &color=Color(0, 0, 0, 255))
	Clear the entire target with a single color. More...
void	setView (const View &view)
	Change the current active view. More...
const View &	getView () const
	Get the view currently in use in the render target. More...
const View &	getDefaultView () const
	Get the default view of the render target. More...
IntRect	getViewport (const View &view) const
	Get the viewport of a view, applied to this render target. More...
Vector2f	mapPixelToCoords (const Vector2i &point) const
	Convert a point from target coordinates to world coordinates, using the current view. More...
Vector2f	mapPixelToCoords (const Vector2i &point, const View &view) const
	Convert a point from target coordinates to world coordinates. More...
Vector2i	mapCoordsToPixel (const Vector2f &point) const
	Convert a point from world coordinates to target coordinates, using the current view. More...
Vector2i	mapCoordsToPixel (const Vector2f &point, const View &view) const
	Convert a point from world coordinates to target coordinates. More...
void	draw (const Drawable &drawable, const RenderStates &states=RenderStates::Default)
	Draw a drawable object to the render target. More...
void	draw (const Vertex *vertices, std::size_t vertexCount, PrimitiveType type, const RenderStates &states=RenderStates::Default)
	Draw primitives defined by an array of vertices. More...
void	draw (const VertexBuffer &vertexBuffer, const RenderStates &states=RenderStates::Default)
	Draw primitives defined by a vertex buffer. More...
void	draw (const VertexBuffer &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const RenderStates &states=RenderStates::Default)
	Draw primitives defined by a vertex buffer. More...
virtual Vector2u	getSize () const =0
	Return the size of the rendering region of the target. More...
virtual bool	setActive (bool active=true)
	Activate or deactivate the render target for rendering. More...
void	pushGLStates ()
	Save the current OpenGL render states and matrices. More...
void	popGLStates ()
	Restore the previously saved OpenGL render states and matrices. More...
void	resetGLStates ()
	Reset the internal OpenGL states so that the target is ready for drawing. More...

Protected Member Functions
virtual void	onCreate ()
	Function called after the window has been created. More...
virtual void	onResize ()
	Function called after the window has been resized. More...
virtual void	onCreate ()
	Function called after the window has been created. More...
virtual void	onResize ()
	Function called after the window has been resized. More...
Protected Member Functions inherited from sf::RenderTarget
	RenderTarget ()
	Default constructor. More...
void	initialize ()
	Performs the common initialization step after creation. More...

Detailed Description

Window that can serve as a target for 2D drawing.

sf::RenderWindow is the main class of the Graphics module.

It defines an OS window that can be painted using the other classes of the graphics module.

sf::RenderWindow is derived from sf::Window, thus it inherits all its features: events, window management, OpenGL rendering, etc. See the documentation of sf::Window for a more complete description of all these features, as well as code examples.

On top of that, sf::RenderWindow adds more features related to 2D drawing with the graphics module (see its base class sf::RenderTarget for more details). Here is a typical rendering and event loop with a sf::RenderWindow:

// Declare and create a new render-window
sf::RenderWindow window(sf::VideoMode(800, 600), "SFML window");
 
// Limit the framerate to 60 frames per second (this step is optional)
window.setFramerateLimit(60);
 
// The main loop - ends as soon as the window is closed
while (window.isOpen())
{
   // Event processing
   sf::Event event;
   while (window.pollEvent(event))
   {
       // Request for closing the window
       if (event.type == sf::Event::Closed)
           window.close();
   }
 
   // Clear the whole window before rendering a new frame
   window.clear();
 
   // Draw some graphical entities
   window.draw(sprite);
   window.draw(circle);
   window.draw(text);
 
   // End the current frame and display its contents on screen
   window.display();
}

Like sf::Window, sf::RenderWindow is still able to render direct OpenGL stuff. It is even possible to mix together OpenGL calls and regular SFML drawing commands.

// Create the render window
sf::RenderWindow window(sf::VideoMode(800, 600), "SFML OpenGL");
 
// Create a sprite and a text to display
sf::Sprite sprite;
sf::Text text;
...
 
// Perform OpenGL initializations
glMatrixMode(GL_PROJECTION);
...
 
// Start the rendering loop
while (window.isOpen())
{
    // Process events
    ...
 
    // Draw a background sprite
    window.pushGLStates();
    window.draw(sprite);
    window.popGLStates();
 
    // Draw a 3D object using OpenGL
    glBegin(GL_QUADS);
        glVertex3f(...);
        ...
    glEnd();
 
    // Draw text on top of the 3D object
    window.pushGLStates();
    window.draw(text);
    window.popGLStates();
 
    // Finally, display the rendered frame on screen
    window.display();
}

See also

sf::Window, sf::RenderTarget, sf::RenderTexture, sf::View

Definition at line 44 of file RenderWindow.hpp.

Constructor & Destructor Documentation

RenderWindow() [1/3]

sf::RenderWindow::RenderWindow

(

)

Default constructor.

This constructor doesn't actually create the window, use the other constructors or call create() to do so.

RenderWindow() [2/3]

sf::RenderWindow::RenderWindow	(	VideoMode	mode,
		const String &	title,
		Uint32	style = Style::Default,
		const ContextSettings &	settings = ContextSettings()
	)

Construct a new window.

This constructor creates the window with the size and pixel depth defined in mode. An optional style can be passed to customize the look and behavior of the window (borders, title bar, resizable, closable, ...).

The fourth parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc. You shouldn't care about these parameters for a regular usage of the graphics module.

Parameters

mode	Video mode to use (defines the width, height and depth of the rendering area of the window)
title	Title of the window
style	Window style, a bitwise OR combination of sf::Style enumerators
settings	Additional settings for the underlying OpenGL context

RenderWindow() [3/3]

sf::RenderWindow::RenderWindow ( WindowHandle  handle, const ContextSettings &  settings = ContextSettings()  )

explicit

Construct the window from an existing control.

Use this constructor if you want to create an SFML rendering area into an already existing control.

The second parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc. You shouldn't care about these parameters for a regular usage of the graphics module.

Parameters

handle	Platform-specific handle of the control (HWND on Windows, Window on Linux/FreeBSD, NSWindow on OS X)
settings	Additional settings for the underlying OpenGL context

~RenderWindow()

virtual sf::RenderWindow::~RenderWindow ( )

virtual

Destructor.

Closes the window and frees all the resources attached to it.

Member Function Documentation

capture()

SFML_DEPRECATED Image sf::RenderWindow::capture

(

)

const

Copy the current contents of the window to an image.

Deprecated:

Use a sf::Texture and its sf::Texture::update(const Window&) function and copy its contents into an sf::Image instead.

sf::Vector2u windowSize = window.getSize();
sf::Texture texture;
texture.create(windowSize.x, windowSize.y);
texture.update(window);
sf::Image screenshot = texture.copyToImage();

This is a slow operation, whose main purpose is to make screenshots of the application. If you want to update an image with the contents of the window and then use it for drawing, you should rather use a sf::Texture and its update(Window&) function. You can also draw things directly to a texture with the sf::RenderTexture class.

Returns

Image containing the captured contents

getSize()

virtual Vector2u sf::RenderWindow::getSize ( ) const

virtual

Get the size of the rendering region of the window.

The size doesn't include the titlebar and borders of the window.

Returns

Size in pixels

Implements sf::RenderTarget.

Here is the caller graph for this function:

onCreate()

virtual void sf::RenderWindow::onCreate ( )

protectedvirtual

Function called after the window has been created.

This function is called so that derived classes can perform their own specific initialization as soon as the window is created.

Reimplemented from sf::Window.

onResize()

virtual void sf::RenderWindow::onResize ( )

protectedvirtual

Function called after the window has been resized.

This function is called so that derived classes can perform custom actions when the size of the window changes.

Reimplemented from sf::Window.

setActive()

bool sf::RenderWindow::setActive ( bool  active = true )

virtual

Activate or deactivate the window as the current target for OpenGL rendering.

A window is active only on the current thread, if you want to make it active on another thread you have to deactivate it on the previous thread first if it was active. Only one window can be active on a thread at a time, thus the window previously active (if any) automatically gets deactivated. This is not to be confused with requestFocus().

Parameters

active

True to activate, false to deactivate

Returns

True if operation was successful, false otherwise

Reimplemented from sf::RenderTarget.

---

The documentation for this class was generated from the following file:

• RenderWindow.hpp