Class GameWindow

Inheritance
Object
GameWindow
Inherited Members
Namespace: Microsoft.Xna.Framework
Assembly: MonoGame.Framework.dll
Syntax
public abstract class GameWindow

Constructors

GameWindow()

Declaration
protected GameWindow()

Properties

AllowAltF4

Gets or sets a bool that enables usage of Alt+F4 for window closing on desktop platforms. Value is true by default.

Declaration
public virtual bool AllowAltF4 { get; set; }
Property Value
Type Description
Boolean

AllowUserResizing

Declaration
public abstract bool AllowUserResizing { get; set; }
Property Value
Type Description
Boolean

ClientBounds

Declaration
public abstract Rectangle ClientBounds { get; }
Property Value
Type Description
Rectangle

CurrentOrientation

Declaration
public abstract DisplayOrientation CurrentOrientation { get; }
Property Value
Type Description
DisplayOrientation

Handle

Declaration
public abstract IntPtr Handle { get; }
Property Value
Type Description
IntPtr

IsBorderless

Determines whether the border of the window is visible. Currently only supported on the WinDX and WinGL/Linux platforms.

Declaration
public virtual bool IsBorderless { get; set; }
Property Value
Type Description
Boolean
Exceptions
Type Condition
NotImplementedException

Thrown when trying to use this property on a platform other than the WinDX and WinGL/Linux platforms.

Position

The location of this window on the desktop, eg: global coordinate space which stretches across all screens.

Declaration
public abstract Point Position { get; set; }
Property Value
Type Description
Point

ScreenDeviceName

Declaration
public abstract string ScreenDeviceName { get; }
Property Value
Type Description
String

Title

Gets or sets the title of the game window.

Declaration
public string Title { get; set; }
Property Value
Type Description
String
Remarks

For Windows 8 and Windows 10 UWP this has no effect. For these platforms the title should be set by using the DisplayName property found in the app manifest file.

Methods

BeginScreenDeviceChange(Boolean)

Declaration
public abstract void BeginScreenDeviceChange(bool willBeFullScreen)
Parameters
Type Name Description
Boolean willBeFullScreen

Create(Game, Int32, Int32)

Declaration
public static GameWindow Create(Game game, int width, int height)
Parameters
Type Name Description
Game game
Int32 width
Int32 height
Returns
Type Description
GameWindow

EndScreenDeviceChange(String)

Declaration
public void EndScreenDeviceChange(string screenDeviceName)
Parameters
Type Name Description
String screenDeviceName

EndScreenDeviceChange(String, Int32, Int32)

Declaration
public abstract void EndScreenDeviceChange(string screenDeviceName, int clientWidth, int clientHeight)
Parameters
Type Name Description
String screenDeviceName
Int32 clientWidth
Int32 clientHeight

OnActivated()

Declaration
protected void OnActivated()

OnDeactivated()

Declaration
protected void OnDeactivated()

OnOrientationChanged()

Declaration
protected void OnOrientationChanged()

OnPaint()

Declaration
protected void OnPaint()

OnScreenDeviceNameChanged()

Declaration
protected void OnScreenDeviceNameChanged()

SetSupportedOrientations(DisplayOrientation)

Declaration
protected abstract void SetSupportedOrientations(DisplayOrientation orientations)
Parameters
Type Name Description
DisplayOrientation orientations

SetTitle(String)

Declaration
protected abstract void SetTitle(string title)
Parameters
Type Name Description
String title

Events

ClientSizeChanged

Declaration
public event EventHandler<EventArgs> ClientSizeChanged
Event Type
Type Description
EventHandler<EventArgs>

KeyDown

Buffered keyboard KeyDown event.

Declaration
public event EventHandler<InputKeyEventArgs> KeyDown
Event Type
Type Description
EventHandler<InputKeyEventArgs>

KeyUp

Buffered keyboard KeyUp event.

Declaration
public event EventHandler<InputKeyEventArgs> KeyUp
Event Type
Type Description
EventHandler<InputKeyEventArgs>

OrientationChanged

Declaration
public event EventHandler<EventArgs> OrientationChanged
Event Type
Type Description
EventHandler<EventArgs>

ScreenDeviceNameChanged

Declaration
public event EventHandler<EventArgs> ScreenDeviceNameChanged
Event Type
Type Description
EventHandler<EventArgs>

TextInput

Use this event to retrieve text for objects like textbox's. This event is not raised by noncharacter keys. This event also supports key repeat. For more information this event is based off: http://msdn.microsoft.com/en-AU/library/system.windows.forms.control.keypress.aspx

Declaration
public event EventHandler<TextInputEventArgs> TextInput
Event Type
Type Description
EventHandler<TextInputEventArgs>
Remarks

This event is only supported on the Windows DirectX, Windows OpenGL and Linux platforms.