SFML.Net
| Window Class |
Window is a rendering window ; it can create a new window
or connect to an existing one
Inheritance HierarchyNamespace: SFML.Window
Assembly: sfmlnet-window-2 (in sfmlnet-window-2.dll) Version: 2.2.0.0 (2.2.0)
SyntaxThe Window type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Window(IntPtr) |
Create the window from an existing control with default creation settings
|
| Window(IntPtr, ContextSettings) |
Create the window from an existing control
|
 | Window(IntPtr, Int32) |
Constructor for derived classes
|
| Window(VideoMode, String) |
Create the window with default style and creation settings
|
| Window(VideoMode, String, Styles) |
Create the window with default creation settings
|
| Window(VideoMode, String, Styles, ContextSettings) |
Create the window
|
Methods| Name | Description | |
|---|---|---|
| Close |
Close (destroy) the window.
The Window instance remains valid and you can call
Create to recreate the window
|
| Destroy |
Handle the destruction of the object
(Overrides ObjectBaseDestroy(Boolean).) |
| DispatchEvents |
Call the event handlers for each pending event
|
| Display |
Display the window on screen
|
| Dispose |
Explicitely dispose the object
(Inherited from ObjectBase.) |
| Equals |
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.) |
| Finalize |
Dispose the object
(Inherited from ObjectBase.) |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| HasFocus |
Check whether the window has the input focus
|
| InternalGetMousePosition |
Internal function to get the mouse 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.
|
| InternalGetTouchPosition |
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 |
Internal function to set the mouse 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.
|
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| PollEvent |
Internal function to get the next event (non-blocking)
|
| RequestFocus |
Request the current window to be made the active
foreground window
|
| SetActive |
Activate the window as the current target
for rendering
|
| SetActive(Boolean) |
Activate of deactivate the window as the current target
for rendering
|
| SetFramerateLimit |
Limit the framerate to a maximum fixed frequency
|
| SetIcon |
Change the window's icon
|
| SetJoystickThreshold |
Change the joystick threshold, ie. the value below which
no move event will be generated
|
| SetKeyRepeatEnabled |
Enable or disable automatic key-repeat.
Automatic key-repeat is enabled by default
|
| SetMouseCursorVisible |
Show or hide the mouse cursor
|
| SetTitle |
Change the title of the window
|
| SetVerticalSyncEnabled |
Enable / disable vertical synchronization
|
| SetVisible |
Show or hide the window
|
| ToString |
Provide a string describing the object
(Overrides ObjectToString.) |
| WaitAndDispatchEvents |
Wait for a new event and dispatch it to the corresponding
event handler
|
| WaitEvent |
Internal function to get the next event (blocking)
|
Properties| Name | Description | |
|---|---|---|
 | CPointer |
Access to the internal pointer of the object.
For internal use only
(Inherited from ObjectBase.) |
| IsOpen |
Tell whether or not the window is opened (ie. has been created).
Note that a hidden window (Show(false))
will still return true
|
| Position |
Position of the window
|
| Settings |
Creation settings of the window
|
| Size |
Size of the rendering region of the window
|
| SystemHandle |
OS-specific handle of the window
|
Events| Name | Description | |
|---|---|---|
 | Closed | Event handler for the Closed event |
| GainedFocus | Event handler for the GainedFocus event |
| JoystickButtonPressed | Event handler for the JoystickButtonPressed event |
| JoystickButtonReleased | Event handler for the JoystickButtonReleased event |
| JoystickConnected | Event handler for the JoystickConnected event |
| JoystickDisconnected | Event handler for the JoystickDisconnected event |
| JoystickMoved | Event handler for the JoystickMoved event |
| KeyPressed | Event handler for the KeyPressed event |
| KeyReleased | Event handler for the KeyReleased event |
| LostFocus | Event handler for the LostFocus event |
| MouseButtonPressed | Event handler for the MouseButtonPressed event |
| MouseButtonReleased | Event handler for the MouseButtonReleased event |
| MouseEntered | Event handler for the MouseEntered event |
| MouseLeft | Event handler for the MouseLeft event |
| MouseMoved | Event handler for the MouseMoved event |
| MouseWheelMoved | Event handler for the MouseWheelMoved event |
| Resized | Event handler for the Resized event |
| SensorChanged | Event handler for the SensorChanged event |
| TextEntered | Event handler for the TextEntered event |
| TouchBegan | Event handler for the TouchBegan event |
| TouchEnded | Event handler for the TouchEnded event |
| TouchMoved | Event handler for the TouchMoved event |
See Also