IDXGIOutput Interface

The IDXGIOutput interface represents an output (which is typically a monitor) on an adapter.

Interface

The IDXGIOutput interface is declared in dxgi.h.

interface IDXGIOutput : IUnknown { HRESULT DuplicateOutput( _In_ IUnknown *pDevice, _Outptr_ IDXGIOutputDuplication **ppOutputDuplication ); HRESULT GetDesc( _Out_ DXGI_OUTPUT_DESC *pDesc ); HRESULT GetDisplayModeList( DXGI_FORMAT EnumFormat, UINT Flags, _Inout_ UINT *pNumModes, _Out_writes_opt_(_In_range_(*pNumModes)) DXGI_MODE_DESC *pDesc ); HRESULT FindClosestMatchingMode( _In_ const DXGI_MODE_DESC *pModeToMatch, _Out_ DXGI_MODE_DESC *pClosestMatch, _In_opt_ IUnknown *pDevice ); HRESULT WaitForVBlank(void); HRESULT GetDesc1( _Out_ DXGI_OUTPUT_DESC1 *pDesc ); HRESULT TakeOwnership(void); HRESULT ReleaseOwnership(void); };

Methods

DuplicateOutput

Duplicates an output surface.

HRESULT DuplicateOutput( _In_ IUnknown *pDevice, _Outptr_ IDXGIOutputDuplication **ppOutputDuplication );
  • pDevice: A pointer to the DirectX device.
  • ppOutputDuplication: A pointer to the duplicated output interface.

GetDesc

Gets a description of the output.

HRESULT GetDesc( _Out_ DXGI_OUTPUT_DESC *pDesc );
  • pDesc: A pointer to a DXGI_OUTPUT_DESC structure that receives a description of the output.

GetDisplayModeList

Gets a list of the display modes that the output supports.

HRESULT GetDisplayModeList( DXGI_FORMAT EnumFormat, UINT Flags, _Inout_ UINT *pNumModes, _Out_writes_opt_(_In_range_(*pNumModes)) DXGI_MODE_DESC *pDesc );
  • EnumFormat: A DXGI_FORMAT-typed value that specifies the pixel format of the display modes.
  • Flags: Options for the display mode.
  • pNumModes: The number of display modes in the array.
  • pDesc: A pointer to an array of DXGI_MODE_DESC structures for the display modes.

FindClosestMatchingMode

Finds the display mode that is closest to the requested display mode.

HRESULT FindClosestMatchingMode( _In_ const DXGI_MODE_DESC *pModeToMatch, _Out_ DXGI_MODE_DESC *pClosestMatch, _In_opt_ IUnknown *pDevice );
  • pModeToMatch: A pointer to the desired display mode.
  • pClosestMatch: A pointer to a DXGI_MODE_DESC structure that receives the closest matching display mode.
  • pDevice: A pointer to the DirectX device.

WaitForVBlank

Waits for the vertical blank interval.

HRESULT WaitForVBlank(void);

GetDesc1

Gets a description of the output (DXGI 1.2).

HRESULT GetDesc1( _Out_ DXGI_OUTPUT_DESC1 *pDesc );
  • pDesc: A pointer to a DXGI_OUTPUT_DESC1 structure that receives a description of the output.

TakeOwnership

Takes ownership of the output.

HRESULT TakeOwnership(void);

ReleaseOwnership

Releases ownership of the output.

HRESULT ReleaseOwnership(void);

Remarks

An output is typically a monitor connected to an adapter.

The IDXGIOutput interface is derived from the IUnknown interface.

Requirements

SDK Header Library
dxgi.h dxgi.lib

See Also