Interface IFullscreenProvider

Namespace

SimulationFramework.Components

Assembly

SimulationFramework.dll

Provides Fullscreen functionality to the application.

public interface IFullscreenProvider : ISimulationComponent, IDisposable

Inherited Members

ISimulationComponent.Initialize(MessageDispatcher)

IDisposable.Dispose()

Properties

IsFullscreen

Whether the simulation is currently fullscreen.

bool IsFullscreen { get; }

Property Value

bool

PreferExclusive

Whether to prefer exclusive or borderless fullscreen.

bool PreferExclusive { get; set; }

Property Value

bool

Methods

EnterFullscreen(IDisplay?)

Attempts to enter fullscreen. The fullscreen mode is determined by PreferExclusive.

On some platforms, windowed mode may not be supported. On those platforms, this method does nothing.

To know if this method succeeded, check IsFullscreen on the next frame.

void EnterFullscreen(IDisplay? display)

Parameters

display IDisplay

The display to go fullscreen on. If this is null, the primary display is used.

ExitFullscreen()

Attempts to exit fullscreen.

On some platforms, windowed mode may not be supported. On those platforms, this method does nothing.

To know if this method succeeded, check IsFullscreen on the next frame.

void ExitFullscreen()