RenderWindow Class

Create the window from an existing control with default creation settings

Create the window from an existing control

Create the window with default style and creation settings

Create the window with default creation settings

Create the window

Capture the current contents of the window into an image

Clear the entire window with black color

Clear the entire window with a single color

Close (destroy) the window. The Window instance remains valid and you can call Create to recreate the window

Handle the destruction of the object

Call the event handlers for each pending event

Display the window on screen

Explicitely dispose the object

Draw a drawable object to the render-target, with default render states

Draw a drawable object to the render-target

Draw primitives defined by an array of vertices, with default render states

Draw primitives defined by an array of vertices

Draw primitives defined by a sub-array of vertices, with default render states

Draw primitives defined by a sub-array of vertices

Determines whether the specified Object is equal to the current Object.

Dispose the object

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Return the current active view

Get the viewport of a view applied to this target

Check whether the window has the input focus

Internal function to get the mouse position relative to the window. This function is public because it is called by another class, it is not meant to be called by users.

Internal function to get the touch position relative to the window. This function is protected because it is called by another class of another module, it is not meant to be called by users.

Internal function to set the mouse position relative to the window. This function is public because it is called by another class, it is not meant to be called by users.

Convert a point from world coordinates to target coordinates, using the current view This function is an overload of the mapCoordsToPixel function that implicitely uses the current view. It is equivalent to: target.MapCoordsToPixel(point, target.GetView());

Convert a point from world coordinates to target coordinates This function finds the pixel of the render-target that matches the given 2D point. In other words, it goes through the same process as the graphics card, to compute the final position of a rendered point. Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render-target, this assertion is not true anymore, ie. a point located at (150, 75) in your 2D world may map to the pixel (10, 50) of your render-target -- if the view is translated by (140, 25). This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render-target.

Convert a point from target coordinates to world coordinates, using the current view This function is an overload of the MapPixelToCoords function that implicitely uses the current view. It is equivalent to: target.MapPixelToCoords(point, target.GetView());

Convert a point from target coordinates to world coordinates This function finds the 2D position that matches the given pixel of the render-target. In other words, it does the inverse of what the graphics card does, to find the initial position of a rendered pixel. Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render-target, this assertion is not true anymore, ie. a point located at (10, 50) in your render-target may map to the point (150, 75) in your 2D world -- if the view is translated by (140, 25). For render-windows, this function is typically used to find which point (or object) is located below the mouse cursor. This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render-target.

Creates a shallow copy of the current Object.

Internal function to get the next event

Restore the previously saved OpenGL render states and matrices. See the description of PushGLStates to get a detailed description of these functions.

Save the current OpenGL render states and matrices. This function can be used when you mix SFML drawing and direct OpenGL rendering. Combined with PopGLStates, it ensures that: \li SFML's internal states are not messed up by your OpenGL code \li your OpenGL states are not modified by a call to a SFML function More specifically, it must be used around code that calls Draw functions. Example: // OpenGL code here... window.PushGLStates(); window.Draw(...); window.Draw(...); window.PopGLStates(); // OpenGL code here... Note that this function is quite expensive: it saves all the possible OpenGL states and matrices, even the ones you don't care about. Therefore it should be used wisely. It is provided for convenience, but the best results will be achieved if you handle OpenGL states yourself (because you know which states have really changed, and need to be saved and restored). Take a look at the ResetGLStates function if you do so.

Request the current window to be made the active foreground window

Reset the internal OpenGL states so that the target is ready for drawing. This function can be used when you mix SFML drawing and direct OpenGL rendering, if you choose not to use PushGLStates/PopGLStates. It makes sure that all OpenGL states needed by SFML are set, so that subsequent Draw() calls will work as expected. Example: // OpenGL code here... glPushAttrib(...); window.ResetGLStates(); window.Draw(...); window.Draw(...); glPopAttrib(...); // OpenGL code here...

Activate the window as the current target for rendering

Activate of deactivate the window as the current target for rendering

Limit the framerate to a maximum fixed frequency

Change the window's icon

Change the joystick threshold, ie. the value below which no move event will be generated

Enable or disable automatic key-repeat. Automatic key-repeat is enabled by default

Show or hide the mouse cursor

Change the title of the window

Enable / disable vertical synchronization

Change the current active view

Show or hide the window

Provide a string describing the object

Wait for a new event and dispatch it to the corresponding event handler

Internal function to get the next event (blocking)

Access to the internal pointer of the object. For internal use only

Default view of the window

Tell whether or not the window is opened (ie. has been created). Note that a hidden window (Show(false)) will still return true

Position of the window

Creation settings of the window

Size of the rendering region of the window

OS-specific handle of the window

Event handler for the Closed event

Event handler for the GainedFocus event

Event handler for the JoystickButtonPressed event

Event handler for the JoystickButtonReleased event

Event handler for the JoystickConnected event

Event handler for the JoystickDisconnected event

Event handler for the JoystickMoved event

Event handler for the KeyPressed event

Event handler for the KeyReleased event

Event handler for the LostFocus event

Event handler for the MouseButtonPressed event

Event handler for the MouseButtonReleased event

Event handler for the MouseEntered event

Event handler for the MouseLeft event

Event handler for the MouseMoved event

Event handler for the MouseWheelMoved event

Event handler for the Resized event

Event handler for the SensorChanged event

Event handler for the TextEntered event

Event handler for the TouchBegan event

Event handler for the TouchEnded event

Event handler for the TouchMoved event