Class DxgiOutput3

Represents an adapter output (such as a monitor). The IDXGIOutput2 interface exposes a method to check for multi-plane overlay support on the primary output adapter.

Inheritance

object

DxgiObject

DxgiOutput3

Implements

IDisposable

IDxgiReleasable

Inherited Members

DxgiObject.ToBoolean()

DxgiObject.Dispose()

DxgiObject.Release()

DxgiObject.SetPrivateDataText(Guid, string)

DxgiObject.GetPrivateDataText(Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: JeremyAnsel.DirectX.Dxgi

Assembly: JeremyAnsel.DirectX.Dxgi.dll

Syntax

public sealed class DxgiOutput3 : DxgiObject, IDisposable, IDxgiReleasable

Properties

Description

Gets a description of the output.

Declaration

public DxgiOutputDesc Description { get; }

Property Value

Type	Description
DxgiOutputDesc

Handle

Gets an handle representing the DXGI object interface.

Declaration

public override object Handle { get; }

Property Value

Type	Description
object

Overrides

DxgiObject.Handle

SupportsOverlays

Gets a value indicating whether the output adapter supports multi-plane overlay.

Declaration

public bool SupportsOverlays { get; }

Property Value

Type	Description
bool

Methods

FindClosestMatchingMode(DxgiModeDesc1, object)

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

Declaration

public DxgiModeDesc1 FindClosestMatchingMode(DxgiModeDesc1 modeToMatch, object concernedDevice)

Parameters

Type	Name	Description
DxgiModeDesc1	modeToMatch	The desired display mode.
object	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
DxgiModeDesc1	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 DxgiModeDesc1[] GetDisplayModeList(DxgiFormat format, DxgiEnumModes modes)

Parameters

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

Returns

Type	Description
DxgiModeDesc1[]	An array of DxgiModeDesc structure.

GetDisplaySurfaceData(DxgiResource3)

Copies the display surface (front buffer) to a user-provided resource.

Declaration

public void GetDisplaySurfaceData(DxgiResource3 destination)

Parameters

Type	Name	Description
DxgiResource3	destination	A resource interface that represents the resource to which copies the display 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

IDxgiReleasable