Method | Description | |
---|---|---|
Clear ( ) : void |
Clear the entire window with black color
|
|
Clear ( System.Color color ) : void |
Clear the entire window with a single color
|
|
Close ( ) : void |
Close (destroy) the window. The Window instance remains valid and you can call Create to recreate the window
|
|
Display ( ) : void |
Display the window on screen
|
|
Draw ( Drawable drawable ) : void |
Draw a drawable object to the render-target, with default render states
|
|
Draw ( Drawable drawable, |
Draw a drawable object to the render-target
|
|
Draw ( |
Draw primitives defined by an array of vertices, with default render states
|
|
Draw ( |
Draw primitives defined by an array of vertices
|
|
Draw ( |
Draw primitives defined by a sub-array of vertices, with default render states
|
|
Draw ( |
Draw primitives defined by a sub-array of vertices
|
|
GetView ( ) : |
Return the current active view
|
|
GetViewport ( |
Get the viewport of a view applied to this target
|
|
HasFocus ( ) : bool |
Check whether the window has the input focus
|
|
MapCoordsToPixel ( Vector2f point ) : Vector2i |
Convert a point from world coordinates to target coordinates, using the current view This function is an overload of the mapCoordsToPixel function that implicitly uses the current view. It is equivalent to: target.MapCoordsToPixel(point, target.GetView());
|
|
MapCoordsToPixel ( Vector2f point, |
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.
|
|
MapPixelToCoords ( Vector2i point ) : Vector2f |
Convert a point from target coordinates to world coordinates, using the current view This function is an overload of the MapPixelToCoords function that implicitly uses the current view. It is equivalent to: target.MapPixelToCoords(point, target.GetView());
|
|
MapPixelToCoords ( Vector2i point, |
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.
|
|
PopGLStates ( ) : void |
Restore the previously saved OpenGL render states and matrices. See the description of PushGLStates to get a detailed description of these functions.
|
|
PushGLStates ( ) : void |
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: SFML's internal states are not messed up by your OpenGL code 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. 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. |
|
RenderWindow ( |
Create the window from an existing control with default creation settings
|
|
RenderWindow ( |
Create the window from an existing control
|
|
RenderWindow ( |
Create the window with default style and creation settings
|
|
RenderWindow ( |
Create the window with default creation settings
|
|
RenderWindow ( |
Create the window
|
|
RequestFocus ( ) : void |
Request the current window to be made the active foreground window
|
|
ResetGLStates ( ) : void |
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. |
|
SetActive ( bool active ) : bool |
Activate of deactivate the window as the current target for rendering
|
|
SetFramerateLimit ( uint limit ) : void |
Limit the framerate to a maximum fixed frequency
|
|
SetIcon ( uint width, uint height, byte pixels ) : void |
Change the window's icon
|
|
SetJoystickThreshold ( float threshold ) : void |
Change the joystick threshold, ie. the value below which no move event will be generated
|
|
SetKeyRepeatEnabled ( bool enable ) : void |
Enable or disable automatic key-repeat. Automatic key-repeat is enabled by default
|
|
SetMouseCursorGrabbed ( bool grabbed ) : void |
Grab or release the mouse cursor If set, grabs the mouse cursor inside this window's client area so it may no longer be moved outside its bounds. Note that grabbing is only active while the window has focus and calling this function for fullscreen windows won't have any effect (fullscreen windows always grab the cursor). |
|
SetMouseCursorVisible ( bool visible ) : void |
Show or hide the mouse cursor
|
|
SetTitle ( string title ) : void |
Change the title of the window
|
|
SetVerticalSyncEnabled ( bool enable ) : void |
Enable / disable vertical synchronization
|
|
SetView ( |
Change the current active view
|
|
SetVisible ( bool visible ) : void |
Show or hide the window
|
|
ToString ( ) : string |
Provide a string describing the object
|
Method | Description | |
---|---|---|
Destroy ( bool disposing ) : void |
Handle the destruction of the object
|
|
InternalGetMousePosition ( ) : Vector2i |
Internal function to get the mouse position relative to the window. This function is protected because it is called by another class, it is not meant to be called by users.
|
|
InternalGetTouchPosition ( uint Finger ) : Vector2i |
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.
|
|
InternalSetMousePosition ( Vector2i position ) : void |
Internal function to set the mouse position relative to the window. This function is protected because it is called by another class, it is not meant to be called by users.
|
|
PollEvent ( |
Internal function to get the next event
|
|
WaitEvent ( |
Internal function to get the next event (blocking)
|
Method | Description | |
---|---|---|
Capture ( ) : Image | ||
Initialize ( ) : void |
Do common initializations
|
|
sfMouse_getPositionRenderWindow ( |
||
sfMouse_setPositionRenderWindow ( Vector2i position, |
||
sfRenderWindow_capture ( |
||
sfRenderWindow_clear ( |
||
sfRenderWindow_close ( |
||
sfRenderWindow_create ( |
||
sfRenderWindow_createFromHandle ( |
||
sfRenderWindow_createUnicode ( |
||
sfRenderWindow_destroy ( |
||
sfRenderWindow_display ( |
||
sfRenderWindow_drawPrimitives ( |
||
sfRenderWindow_getDefaultView ( |
||
sfRenderWindow_getFrameTime ( |
||
sfRenderWindow_getPosition ( |
||
sfRenderWindow_getSettings ( |
||
sfRenderWindow_getSize ( |
||
sfRenderWindow_getSystemHandle ( |
||
sfRenderWindow_getView ( |
||
sfRenderWindow_getViewport ( |
||
sfRenderWindow_hasFocus ( |
||
sfRenderWindow_isOpen ( |
||
sfRenderWindow_mapCoordsToPixel ( |
||
sfRenderWindow_mapPixelToCoords ( |
||
sfRenderWindow_pollEvent ( |
||
sfRenderWindow_popGLStates ( |
||
sfRenderWindow_pushGLStates ( |
||
sfRenderWindow_requestFocus ( |
||
sfRenderWindow_resetGLStates ( |
||
sfRenderWindow_restoreGLStates ( |
||
sfRenderWindow_saveGLStates ( |
||
sfRenderWindow_setActive ( |
||
sfRenderWindow_setFramerateLimit ( |
||
sfRenderWindow_setIcon ( |
||
sfRenderWindow_setJoystickThreshold ( |
||
sfRenderWindow_setKeyRepeatEnabled ( |
||
sfRenderWindow_setMouseCursorGrabbed ( |
||
sfRenderWindow_setMouseCursorVisible ( |
||
sfRenderWindow_setPosition ( |
||
sfRenderWindow_setSize ( |
||
sfRenderWindow_setTitle ( |
||
sfRenderWindow_setUnicodeTitle ( |
||
sfRenderWindow_setVerticalSyncEnabled ( |
||
sfRenderWindow_setView ( |
||
sfRenderWindow_setVisible ( |
||
sfRenderWindow_waitEvent ( |
||
sfTouch_getPositionRenderWindow ( uint Finger, |
public Clear ( System.Color color ) : void | ||
color | System.Color | Color to use to clear the window |
return | void |
protected Destroy ( bool disposing ) : void | ||
disposing | bool | Is the GC disposing the object, or is it an explicit call ? |
return | void |
public Draw ( Drawable drawable ) : void | ||
drawable | Drawable | Object to draw |
return | void |
public Draw ( Drawable drawable, |
||
drawable | Drawable | Object to draw |
states | Render states to use for drawing | |
return | void |
public Draw ( |
||
vertices | Pointer to the vertices | |
type | PrimitiveType | Type of primitives to draw |
return | void |
public Draw ( |
||
vertices | Pointer to the vertices | |
type | PrimitiveType | Type of primitives to draw |
states | Render states to use for drawing | |
return | void |
public Draw ( |
||
vertices | Array of vertices to draw | |
start | uint | Index of the first vertex to draw in the array |
count | uint | Number of vertices to draw |
type | PrimitiveType | Type of primitives to draw |
return | void |
public Draw ( |
||
vertices | Pointer to the vertices | |
start | uint | Index of the first vertex to use in the array |
count | uint | Number of vertices to draw |
type | PrimitiveType | Type of primitives to draw |
states | Render states to use for drawing | |
return | void |
public GetViewport ( |
||
view | Target view | |
return | IntRect |
protected InternalGetMousePosition ( ) : Vector2i | ||
return | Vector2i |
protected InternalGetTouchPosition ( uint Finger ) : Vector2i | ||
Finger | uint | Finger index |
return | Vector2i |
protected InternalSetMousePosition ( Vector2i position ) : void | ||
position | Vector2i | Relative mouse position |
return | void |
public MapCoordsToPixel ( Vector2f point ) : Vector2i | ||
point | Vector2f | Point to convert |
return | Vector2i |
public MapCoordsToPixel ( Vector2f point, |
||
point | Vector2f | Point to convert |
view | The view to use for converting the point | |
return | Vector2i |
public MapPixelToCoords ( Vector2i point ) : Vector2f | ||
point | Vector2i | Pixel to convert |
return | Vector2f |
public MapPixelToCoords ( Vector2i point, |
||
point | Vector2i | Pixel to convert |
view | The view to use for converting the point | |
return | Vector2f |
protected PollEvent ( |
||
eventToFill | Variable to fill with the raw pointer to the event structure | |
return | bool |
public RenderWindow ( |
||
handle | Platform-specific handle of the control | |
return | System |
public RenderWindow ( |
||
handle | Platform-specific handle of the control | |
settings | Creation parameters | |
return | System |
public RenderWindow ( |
||
mode | Video mode to use | |
title | string | Title of the window |
return | System |
public RenderWindow ( |
||
mode | Video mode to use | |
title | string | Title of the window |
style | Styles | Window style (Resize | Close by default) |
return | System |
public RenderWindow ( |
||
mode | Video mode to use | |
title | string | Title of the window |
style | Styles | Window style (Resize | Close by default) |
settings | Creation parameters | |
return | System |
public SetActive ( bool active ) : bool | ||
active | bool | True to activate, false to deactivate (true by default) |
return | bool |
public SetFramerateLimit ( uint limit ) : void | ||
limit | uint | Framerate limit, in frames per seconds (use 0 to disable limit) |
return | void |
public SetIcon ( uint width, uint height, byte pixels ) : void | ||
width | uint | Icon's width, in pixels |
height | uint | Icon's height, in pixels |
pixels | byte | Array of pixels, format must be RGBA 32 bits |
return | void |
public SetJoystickThreshold ( float threshold ) : void | ||
threshold | float | New threshold, in range [0, 100] |
return | void |
public SetKeyRepeatEnabled ( bool enable ) : void | ||
enable | bool | True to enable, false to disable |
return | void |
public SetMouseCursorGrabbed ( bool grabbed ) : void | ||
grabbed | bool | True to grab, false to release |
return | void |
public SetMouseCursorVisible ( bool visible ) : void | ||
visible | bool | True to show, false to hide |
return | void |
public SetVerticalSyncEnabled ( bool enable ) : void | ||
enable | bool | True to enable v-sync, false to deactivate |
return | void |
public SetVisible ( bool visible ) : void | ||
visible | bool | True to show the window, false to hide it |
return | void |
protected WaitEvent ( |
||
eventToFill | Variable to fill with the raw pointer to the event structure | |
return | bool |