Class DisplayMode

Namespace

Microsoft.Xna.Framework.Graphics

Assembly

MonoGame.Framework.dll

Describes the display mode.

[DataContract]
public class DisplayMode

Inheritance

object

DisplayMode

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

AspectRatio

Gets a value indicating the aspect ratio of the display mode

public float AspectRatio { get; }

Property Value

float

Format

Gets a value indicating the surface format of the display mode.

public SurfaceFormat Format { get; }

Property Value

SurfaceFormat

Height

Gets a value indicating the screen height, in pixels.

public int Height { get; }

Property Value

int

TitleSafeArea

Gets the bounds of the display that is guaranteed to be visible by the users screen.

public Rectangle TitleSafeArea { get; }

Property Value

Rectangle

Width

Gets a value indicating the screen width, in pixels.

public int Width { get; }

Property Value

int

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

operator ==(DisplayMode, DisplayMode)

Compares the current instance of the DisplayMode class to another instance to determine whether they are equal.

public static bool operator ==(DisplayMode left, DisplayMode right)

Parameters

left DisplayMode

The DisplayMode object on the left of the equality operator.

right DisplayMode

The DisplayMode object on the right of the equality operator.

Returns

bool

true if the objects are equal; otherwise, false.

operator !=(DisplayMode, DisplayMode)

Compares the current instance of the DisplayMode class to another instance to determine whether they are different.

public static bool operator !=(DisplayMode left, DisplayMode right)

Parameters

left DisplayMode

The DisplayMode object on the left of the inequality operator.

right DisplayMode

The DisplayMode object on the right of the inequality operator.

Returns

bool

true if the objects are different; otherwise, false.