Class GraphicsAdapter

Namespace

Microsoft.Xna.Framework.Graphics

Assembly

MonoGame.Framework.dll

public sealed class GraphicsAdapter : IDisposable

Inheritance

object

GraphicsAdapter

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Adapters

public static ReadOnlyCollection<GraphicsAdapter> Adapters { get; }

Property Value

ReadOnlyCollection<GraphicsAdapter>

CurrentDisplayMode

public DisplayMode CurrentDisplayMode { get; }

Property Value

DisplayMode

DefaultAdapter

public static GraphicsAdapter DefaultAdapter { get; }

Property Value

GraphicsAdapter

Description

public string Description { get; }

Property Value

string

DeviceId

public int DeviceId { get; }

Property Value

int

DeviceName

public string DeviceName { get; }

Property Value

string

IsDefaultAdapter

public bool IsDefaultAdapter { get; }

Property Value

bool

IsWideScreen

Returns true if the CurrentDisplayMode is widescreen.

public bool IsWideScreen { get; }

Property Value

bool

Remarks

Common widescreen modes include 16:9, 16:10 and 2:1.

MonitorHandle

public nint MonitorHandle { get; }

Property Value

nint

Revision

public int Revision { get; }

Property Value

int

SubSystemId

public int SubSystemId { get; }

Property Value

int

SupportedDisplayModes

public DisplayModeCollection SupportedDisplayModes { get; }

Property Value

DisplayModeCollection

UseDebugLayers

Used to request the graphics device should be created with debugging features enabled.

public static bool UseDebugLayers { get; set; }

Property Value

bool

UseDriverType

Used to request creation of a specific kind of driver.

public static GraphicsAdapter.DriverType UseDriverType { get; set; }

Property Value

GraphicsAdapter.DriverType

Remarks

These values only work on DirectX platforms and must be defined before the graphics device is created. Hardware by default.

UseReferenceDevice

Used to request creation of the reference graphics device, or the default hardware accelerated device (when set to false).

public static bool UseReferenceDevice { get; set; }

Property Value

bool

Remarks

This only works on DirectX platforms where a reference graphics device is available and must be defined before the graphics device is created. It defaults to false.

VendorId

public int VendorId { get; }

Property Value

int

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

IsProfileSupported(GraphicsProfile)

public bool IsProfileSupported(GraphicsProfile graphicsProfile)

Parameters

graphicsProfile GraphicsProfile

Returns

bool

QueryRenderTargetFormat(GraphicsProfile, SurfaceFormat, DepthFormat, int, out SurfaceFormat, out DepthFormat, out int)

Queries for support of the requested render target format on the adaptor.

public bool QueryRenderTargetFormat(GraphicsProfile graphicsProfile, SurfaceFormat format, DepthFormat depthFormat, int multiSampleCount, out SurfaceFormat selectedFormat, out DepthFormat selectedDepthFormat, out int selectedMultiSampleCount)

Parameters

graphicsProfile GraphicsProfile

The graphics profile.

format SurfaceFormat

The requested surface format.

depthFormat DepthFormat

The requested depth stencil format.

multiSampleCount int

The requested multisample count.

selectedFormat SurfaceFormat

Set to the best format supported by the adaptor for the requested surface format.

selectedDepthFormat DepthFormat

Set to the best format supported by the adaptor for the requested depth stencil format.

selectedMultiSampleCount int

Set to the best count supported by the adaptor for the requested multisample count.

Returns

bool

True if the requested format is supported by the adaptor. False if one or more of the values was changed.