Class GraphicsAdapter

Namespace

Microsoft.Xna.Framework.Graphics

Assembly

MonoGame.Framework.dll

Provides methods to retrieve and manipulate graphics adapters.

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

Gets a read-only collection of available adapters on the system.

public static ReadOnlyCollection<GraphicsAdapter> Adapters { get; }

Property Value

ReadOnlyCollection<GraphicsAdapter>

CurrentDisplayMode

Gets the current display mode.

public DisplayMode CurrentDisplayMode { get; }

Property Value

DisplayMode

DefaultAdapter

Gets the default adapter.

public static GraphicsAdapter DefaultAdapter { get; }

Property Value

GraphicsAdapter

Description

Gets a string used for presentation to the user.

public string Description { get; }

Property Value

string

IsWideScreen

Gets a bool indicating whether CurrentDisplayMode has a Width:Height ratio corresponding to a widescreen DisplayMode. Common widescreen modes include 16:9, 16:10 and 2:1.

public bool IsWideScreen { get; }

Property Value

bool

SupportedDisplayModes

Gets a collection of supported display modes for the current adapter.

public DisplayModeCollection SupportedDisplayModes { get; }

Property Value

DisplayModeCollection

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.

Methods

Dispose()

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

public void Dispose()

IsProfileSupported(GraphicsProfile)

Returns a value that indicates whether the specified graphics profile is supported by the current adapter.

public bool IsProfileSupported(GraphicsProfile graphicsProfile)

Parameters

graphicsProfile GraphicsProfile

The graphics profile to check for support.

Returns

bool

Exceptions

InvalidOperationException

The graphicsProfile parameter is not a valid GraphicsProfile enum value.

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.