Class WindowOptions

Namespace

BSGameLib.Game

Assembly

BSGameLib.Game.dll

Options for creating the game window. Pass them to the Game constructor.

public class WindowOptions : IWindowOptions

Inheritance

object

WindowOptions

Implements

IWindowOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowRenderBackendFallback

Whether the game starts on OpenGL when the Vulkan backend fails to start. Vulkan is the default either way. The BSGAMELIB_RENDER_BACKEND_FALLBACK environment variable overrides this.

public bool AllowRenderBackendFallback { get; set; }

Property Value

bool

Borderless

Whether the window has no border or title bar.

public bool Borderless { get; set; }

Property Value

bool

CenterScreen

Whether the window is centred on the screen. When false it opens at the mouse pointer.

public bool CenterScreen { get; set; }

Property Value

bool

Fullscreen

Whether the game goes fullscreen once it starts. Ignored for an offscreen window.

public bool Fullscreen { get; set; }

Property Value

bool

Height

The window's height when it is created.

public int Height { get; set; }

Property Value

int

MouseVisible

Whether the mouse cursor is shown at the start. The mouse manager can change it later.

public bool MouseVisible { get; set; }

Property Value

bool

Offscreen

Whether the window is created hidden and never shown on the desktop.

public bool Offscreen { get; set; }

Property Value

bool

PreferredRenderBackend

The render backend to start, such as Vulkan or OpenGL. Null or blank uses the default. A command-line setting takes precedence.

public string PreferredRenderBackend { get; set; }

Property Value

string

Resizable

Whether the player can resize the window.

public bool Resizable { get; set; }

Property Value

bool

Title

The window's title.

public string Title { get; set; }

Property Value

string

Width

The window's width when it is created.

public int Width { get; set; }

Property Value

int