Window
Summary
Remarks
Danger
All calls made within this class MUST be performed on the Master Thread. See Threads.RunLater on how to safely call this from an asynchronous thread. Failure to comply with this can cause catastrophical failures as the engine is not designed for this.
Important
This class MUST be disposed manually.
Definition
Namespace: SDT4.Managed.Windowing
Assembly: SDT4.Managed.Windowing.dll
sealed class WindowObject ➔ Window
Implements:
IDisposable, IDisposeTracker<Window>
Fields
| Name | Type | Description |
|---|---|---|
Properties
| Name | Type | Description |
|---|---|---|
public get; NativeHandle |
IntPtr | |
public get; WindowMonitor |
Monitor | The monitor that the window resides in. This is NULL if the window is not in fullscreen mode! |
public get; set; Size |
Vector2i | Size of the window in pixels |
public get; FramebufferSize |
Vector2i | The renderable framebuffer region of the window in pixels |
public get; set; Position |
Vector2i | Position of the window relative to the workspace |
public get; set; Borderless |
Boolean | If the window has the title bar visible or not. |
public get; set; Resizable |
Boolean | If the window has the title bar visible or not. |
NativeHandle Remarks
Warning
Not for public access, usually not needed anyway.
Size Remarks
Warning
Do not use Window.Size for determining the size of the renderable region. Use Window.FramebufferSize to determine appropriate renderable regions for render targets.
Methods
public Void Maximize()
Summary: Maximises the window
public Void Minimize()
Summary: Minimises the window
public Void Restore()
Summary: Restores the window after minimisation.
public Void Close()
Summary: Closes window immediately
public Void SetMonitor(Monitor? monitor, VideoMode mode)
Summary: Sets the fullscreen display monitor with the specified window mode. If monitor is NULL then it will revert to windowed mode.
Parameters:
-
monitor(Monitor?): The monitor to place the window in fullscreen, null if revert to windowed. -
mode(VideoMode): Closest video mode to choose. Colour bits are ignored, and refresh rate is only applicable in fullscreen mode
public Void Dispose()
public virtual Boolean Equals(Object? obj)
Parameters:
obj(Object?):
Returns:
public virtual Int32 GetHashCode()
Returns:
public virtual String ToString()
Returns: