Class DxgiOutput

An IDXGIOutput interface represents an adapter output (such as a monitor).

Inheritance

object

DXComObject

DxgiObject

DxgiOutput

Implements

IDisposable

Inherited Members

DxgiObject.DxgiObjectGuid

DxgiObject.SetPrivateDataText(in Guid, string)

DxgiObject.SetPrivateDataText(in Guid, ReadOnlySpan<char>)

DxgiObject.GetPrivateDataText(in Guid)

DxgiObject.GetPrivateDataTextCharCount(in Guid)

DxgiObject.GetPrivateDataTextChars(in Guid, Span<char>)

DxgiObject.GetParent(in Guid)

DXComObject.Handle

DXComObject.Dispose()

DXComObject.AddRef()

DXComObject.Release()

DXComObject.QueryInterface(in Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

[SecurityCritical]
public class DxgiOutput : DxgiObject, IDisposable

Constructors

DxgiOutput(nint)

Initializes a new instance of the DxgiOutput class.

Declaration

public DxgiOutput(nint comPtr)

Parameters

Type	Name	Description
nint	comPtr

Fields

DxgiOutputGuid

The interface GUID.

Declaration

public static readonly Guid DxgiOutputGuid

Field Value

Type	Description
Guid

Properties

Description

Gets a description of the output.

Declaration

public DxgiOutputDesc Description { get; }

Property Value

Type	Description
DxgiOutputDesc

Methods

FindClosestMatchingMode(in DxgiModeDesc, nint)

Finds the display mode that most closely matches the requested display mode.

Declaration

public DxgiModeDesc FindClosestMatchingMode(in DxgiModeDesc modeToMatch, nint concernedDevice)

Parameters

Type	Name	Description
DxgiModeDesc	modeToMatch	The desired display mode.
nint	concernedDevice	The Direct3D device interface. If this parameter is null, only modes whose format matches that of modeToMatch will be returned; otherwise, only those formats that are supported for scan-out by the device are returned.

Returns

Type	Description
DxgiModeDesc	The mode that most closely matches modeToMatch.

GetDisplayModeList(DxgiFormat, DxgiEnumModes)

Gets the display modes that match the requested format and other input options.

Declaration

public DxgiModeDesc[] GetDisplayModeList(DxgiFormat format, DxgiEnumModes modes)

Parameters

Type	Name	Description
DxgiFormat	format	The color format.
DxgiEnumModes	modes	Options for modes to include.

Returns

Type	Description
DxgiModeDesc[]	An array of DxgiModeDesc structure.

GetDisplayModeList(DxgiFormat, DxgiEnumModes, Span<DxgiModeDesc>)

Gets the display modes that match the requested format and other input options.

Declaration

public int GetDisplayModeList(DxgiFormat format, DxgiEnumModes modes, Span<DxgiModeDesc> displayModes)

Parameters

Type	Name	Description
DxgiFormat	format	The color format.
DxgiEnumModes	modes	Options for modes to include.
Span<DxgiModeDesc>	displayModes	An span of DxgiModeDesc structure.

Returns

Type	Description
int	The count of structure.

GetDisplayModeListCount(DxgiFormat, DxgiEnumModes)

Gets the display modes count that match the requested format and other input options.

Declaration

public int GetDisplayModeListCount(DxgiFormat format, DxgiEnumModes modes)

Parameters

Type	Name	Description
DxgiFormat	format	The color format.
DxgiEnumModes	modes	Options for modes to include.

Returns

Type	Description
int	The count.

GetDisplaySurfaceData(DxgiSurface?)

Gets a copy of the current display surface.

Declaration

public void GetDisplaySurfaceData(DxgiSurface? destination)

Parameters

Type	Name	Description
DxgiSurface	destination	A destination surface.

GetFrameStatistics()

Gets statistics about recently rendered frames.

Declaration

public DxgiFrameStatistics GetFrameStatistics()

Returns

Type	Description
DxgiFrameStatistics	The frame statistics.

WaitForVBlank()

Halt a thread until the next vertical blank occurs.

Declaration

public void WaitForVBlank()

Implements

IDisposable