Interface IWindowOptions

Namespace

BSGameLib.Game

Assembly

BSGameLib.Game.dll

The settings a game's window is created with.

public interface IWindowOptions

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.

bool AllowRenderBackendFallback { get; set; }

Property Value

bool

Borderless

Whether the window has no border or title bar.

bool Borderless { get; set; }

Property Value

bool

CenterScreen

Whether the window starts in the centre of its display.

bool CenterScreen { get; set; }

Property Value

bool

Fullscreen

Whether the window starts fullscreen.

bool Fullscreen { get; set; }

Property Value

bool

Height

The height of the window, in pixels.

int Height { get; set; }

Property Value

int

MouseVisible

Whether the mouse cursor is shown over the window.

bool MouseVisible { get; set; }

Property Value

bool

Offscreen

Whether the window is created offscreen: it is rendered to but not shown.

bool Offscreen { get; set; }

Property Value

bool

PreferredRenderBackend

The render backend to start with, by name: Vulkan or OpenGL. A render backend given on the command line takes precedence. Null or blank keeps the default.

string PreferredRenderBackend { get; set; }

Property Value

string

Resizable

Whether the user can resize the window.

bool Resizable { get; set; }

Property Value

bool

Title

The text in the window's title bar.

string Title { get; set; }

Property Value

string

Width

The width of the window, in pixels.

int Width { get; set; }

Property Value

int