Class WindowBuilder

Namespace

Pie.Windowing

Assembly

Pie.Windowing.dll

Various parameters used to construct a Window.

public class WindowBuilder

Inheritance

object

WindowBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WindowBuilder()

Create a new WindowBuilder with the default settings.

public WindowBuilder()

Fields

DeviceOptions

The GraphicsDeviceOptions to use when calling Build(out GraphicsDevice)

public GraphicsDeviceOptions DeviceOptions

Field Value

GraphicsDeviceOptions

Various parameters used to construct a .

WindowApi

The GraphicsApi to use.

public GraphicsApi WindowApi

Field Value

GraphicsApi

Various parameters used to construct a .

WindowBorderless

If true, the window should not have a border.

public bool WindowBorderless

Field Value

bool

Various parameters used to construct a .

WindowFullscreenMode

The FullscreenMode to use.

public FullscreenMode WindowFullscreenMode

Field Value

FullscreenMode

Various parameters used to construct a .

WindowHidden

If true, the window will be hidden once built.

public bool WindowHidden

Field Value

bool

Various parameters used to construct a .

WindowIcon

The window icon it should use. This should be an RGBA formatted bitmap. If null, the default window manager icon is used.

public Icon? WindowIcon

Field Value

Icon?

Various parameters used to construct a .

WindowMaximized

If true, the window will be maximized once built.

public bool WindowMaximized

Field Value

bool

Various parameters used to construct a .

WindowMinimized

If true, the window will be minimized once built.

public bool WindowMinimized

Field Value

bool

Various parameters used to construct a .

WindowPosition

The position of the window. If null, the window will be centered on the primary monitor.

public Point? WindowPosition

Field Value

Point?

Various parameters used to construct a .

WindowResizable

If true, the window should be resizable.

public bool WindowResizable

Field Value

bool

Various parameters used to construct a .

WindowSize

The size/resolution of the window, in screen coordinates.

public Size WindowSize

Field Value

Size

Various parameters used to construct a .

WindowTitle

The title of the window.

public string WindowTitle

Field Value

string

Various parameters used to construct a .

Methods

Api(GraphicsApi)

Set the GraphicsApi that will be used for the GraphicsDevice.

public WindowBuilder Api(GraphicsApi api)

Parameters

api GraphicsApi

The GraphicsApi to use.

Returns

WindowBuilder

The window builder.

Borderless()

Hint that the window should not have a border.

public WindowBuilder Borderless()

Returns

WindowBuilder

Various parameters used to construct a .

Build()

Builds the window with the set options.

public Window Build()

Returns

Window

The built window.

Build(out GraphicsDevice)

Builds the window with the set options, as well as creating a graphics device from the given DeviceOptions.

public Window Build(out GraphicsDevice device)

Parameters

device GraphicsDevice

The created GraphicsDevice.

Returns

Window

The built window.

FullscreenMode(FullscreenMode)

Set the window fullscreen mode.

public WindowBuilder FullscreenMode(FullscreenMode fullscreenMode)

Parameters

fullscreenMode FullscreenMode

The FullscreenMode to use.

Returns

WindowBuilder

Various parameters used to construct a .

GraphicsDeviceOptions(in GraphicsDeviceOptions)

The GraphicsDeviceOptions to use when calling Build(out GraphicsDevice)

public WindowBuilder GraphicsDeviceOptions(in GraphicsDeviceOptions options)

Parameters

options GraphicsDeviceOptions

Various parameters used to construct a .

Returns

WindowBuilder

Various parameters used to construct a .

Hidden()

Hint that the window should not be visible once built.

public WindowBuilder Hidden()

Returns

WindowBuilder

Various parameters used to construct a .

Icon(in Icon)

Set the window icon. This must be an RGBA formatted bitmap.

public WindowBuilder Icon(in Icon icon)

Parameters

icon Icon

The icon to use.

Returns

WindowBuilder

Various parameters used to construct a .

Maximized()

If true, the window will be maximized once built.

public WindowBuilder Maximized()

Returns

WindowBuilder

Various parameters used to construct a .

Minimized()

If true, the window will be minimized once built.

public WindowBuilder Minimized()

Returns

WindowBuilder

Various parameters used to construct a .

Position(int, int)

The position of the window.

public WindowBuilder Position(int x, int y)

Parameters

x int

Various parameters used to construct a .

y int

Various parameters used to construct a .

Returns

WindowBuilder

Various parameters used to construct a .

Resizable()

Hint that the window should be resizable.

public WindowBuilder Resizable()

Returns

WindowBuilder

Various parameters used to construct a .

Size(int, int)

The size/resolution of the window, in screen coordinates.

public WindowBuilder Size(int width, int height)

Parameters

width int

Various parameters used to construct a .

height int

Various parameters used to construct a .

Returns

WindowBuilder

Various parameters used to construct a .

Title(string)

The title of the window.

public WindowBuilder Title(string title)

Parameters

title string

Various parameters used to construct a .

Returns

WindowBuilder

Various parameters used to construct a .