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

DXComObject

DxgiObject

DxgiOutput3

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 DxgiOutput3 : DxgiObject, IDisposable

Constructors

| Edit this page View Source

DxgiOutput3(nint)

Initializes a new instance of the DxgiOutput3 class.

Declaration

public DxgiOutput3(nint comPtr)

Parameters

Type	Name	Description
nint	comPtr

Fields

| Edit this page View Source

DxgiOutput3Guid

The interface GUID.

Declaration

public static readonly Guid DxgiOutput3Guid

Field Value

Type	Description
Guid

Properties

| Edit this page View Source

Description

Gets a description of the output.

Declaration

public DxgiOutputDesc Description { get; }

Property Value

Type	Description
DxgiOutputDesc

| Edit this page View Source

SupportsOverlays

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

Declaration

public bool SupportsOverlays { get; }

Property Value

Type	Description
bool

Methods

| Edit this page View Source

FindClosestMatchingMode(in DxgiModeDesc1, nint)

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

Declaration

public DxgiModeDesc1 FindClosestMatchingMode(in DxgiModeDesc1 modeToMatch, nint concernedDevice)

Parameters

Type	Name	Description
DxgiModeDesc1	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
DxgiModeDesc1	The mode that most closely matches `modeToMatch`.

| Edit this page View Source

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 DxgiModeDesc1 structure.

| Edit this page View Source

GetDisplayModeList(DxgiFormat, DxgiEnumModes, Span<DxgiModeDesc1>)

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

Declaration

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

Parameters

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

Returns

Type	Description
int	The count of structure.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

GetFrameStatistics()

Gets statistics about recently rendered frames.

Declaration

public DxgiFrameStatistics GetFrameStatistics()

Returns

Type	Description
DxgiFrameStatistics	The frame statistics.

| Edit this page View Source

WaitForVBlank()

Halt a thread until the next vertical blank occurs.

Declaration

public void WaitForVBlank()

Implements

IDisposable