Class Screen

Helper class to access display information.

System.Object
Screen
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[DebugCommand]
[Unmanaged]
public static class Screen : Object

Properties

CursorLock

Gets or sets the cursor lock mode.

Declaration
[Unmanaged]
public static CursorLockMode CursorLock { get; set; }
Property Value
CursorLockMode

CursorVisible

Gets or sets the cursor visible flag.

Declaration
[Unmanaged]
public static bool CursorVisible { get; set; }
Property Value
System.Boolean

GameWindowMode

Gets or sets the game window mode.

Declaration
[Unmanaged]
public static GameWindowMode GameWindowMode { get; set; }
Property Value
GameWindowMode

IsFullscreen

Gets or sets the fullscreen mode.

Declaration
[Unmanaged]
public static bool IsFullscreen { get; set; }
Property Value
System.Boolean

MainWindow

Gets the main window.

Declaration
[Unmanaged]
public static Window MainWindow { get; }
Property Value
Window

Size

Gets or sets the window size (in screen-space, includes DPI scale).

Declaration
[Unmanaged]
public static Float2 Size { get; set; }
Property Value
Float2

Methods

GameViewportToScreen(Float2)

Converts the game viewport position to the screen-space position.

Declaration
[Unmanaged]
public static Float2 GameViewportToScreen(Float2 viewportPos)
Parameters
Float2 viewportPos

The game viewport position.
Returns
Float2

The screen-space position.

ScreenToGameViewport(Float2)

Converts the screen-space position to the game viewport position.

Declaration
[Unmanaged]
public static Float2 ScreenToGameViewport(Float2 screenPos)
Parameters
Float2 screenPos

The screen-space position.
Returns
Float2

The game viewport position.