Class DesktopOptions

Namespace: MicroEngine.Raylib
Assembly: MicroEngine.Raylib.dll
Guide: Backends and platforms

Window options of a raylib platform created directly (browser hosts); hosts with a PlatformRequest use #ctor. Every option is set by name (new DesktopOptions { Hidden = true, Mute = true }): there is no positional constructor, so a call written for the earlier positional shape (whose third argument was a fixed-step flag) fails to compile instead of meaning something else.

C#

public sealed record DesktopOptions : IEquatable<DesktopOptions>

Inheritance

object ← DesktopOptions

Implements

IEquatable<DesktopOptions>

Constructors

DesktopOptions()

C#

public DesktopOptions()

Properties

CaptureScale

Size factor of screenshots (3 by default).

C#

public int CaptureScale { get; init; }

Property Value

int

Hidden

Renders into a hidden window, which never waits for the display (false by default).

C#

public bool Hidden { get; init; }

Property Value

bool

Icon

The window’s icon (the game’s Icon); ignored in browsers.

C#

public PixelImage? Icon { get; init; }

Property Value

PixelImage?

Mute

Opens no audio device (false by default).

C#

public bool Mute { get; init; }

Property Value

bool

Scale

Window scale; null (the default) uses Scale.

C#

public int? Scale { get; init; }

Property Value

int?

WaitForDisplay

Whether a visible desktop window’s frames may wait for the display (true by default; see WaitForDisplay).

C#

public bool WaitForDisplay { get; init; }

Property Value

bool

Methods

<Clone>$()

C#

public DesktopOptions <Clone>$()

Returns

DesktopOptions

Equals(object?)

C#

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(DesktopOptions?)

C#

public bool Equals(DesktopOptions? other)

Parameters

other DesktopOptions?

Returns

bool

GetHashCode()

C#

public override int GetHashCode()

Returns

int

ToString()

C#

public override string ToString()

Returns

string

Operators

operator ==(DesktopOptions?, DesktopOptions?)

C#

public static bool operator ==(DesktopOptions? left, DesktopOptions? right)

Parameters

left DesktopOptions?

right DesktopOptions?

Returns

bool

operator !=(DesktopOptions?, DesktopOptions?)

C#

public static bool operator !=(DesktopOptions? left, DesktopOptions? right)

Parameters

left DesktopOptions?

right DesktopOptions?

Returns

bool