DXGI Interfaces

IDXGIAdapter Interface

Represents an adapter (typically a video card).

Summary

The IDXGIAdapter interface, inherited from IDXGIDeviceSubObject, represents an adapter (typically a video card) on the system.

Methods

GetDesc

HRESULT GetDesc(DXGI_ADAPTER_DESC *pDesc)

Gets a description of the adapter.

Parameters

  • pDesc [out]
    Type: DXGI_ADAPTER_DESC*
    A pointer to a DXGI_ADAPTER_DESC structure that describes the adapter.

Return Value

Returns S_OK if successful; otherwise, returns DXGI_ERROR_INVALID_CALL if the description structure is not valid, or one of the DXGI error codes.

Remarks

An adapter represents a display device.

The DXGI_ADAPTER_DESC structure contains information such as the description of the adapter, vendor ID, device ID, and memory information.

EnumOutputs

HRESULT EnumOutputs(UINT Output, IDXGIOutput **ppOutput)

Enumerates the outputs (monitors) associated with the adapter.

Parameters

  • Output [in]
    Type: UINT
    The output number.
  • ppOutput [out]
    Type: IDXGIOutput**
    The address of a pointer to the output interface.

Return Value

Returns S_OK if successful; otherwise, returns DXGI_ERROR_NOT_FOUND if there are no more outputs to enumerate, or DXGI_ERROR_MORE_DATA if the buffer is too small, or DXGI_ERROR_INVALID_CALL if the ppOutput parameter is NULL.

Remarks

Call EnumOutputs to get an output interface. This interface represents a display monitor connected to the adapter.

You can call EnumOutputs in a loop to enumerate all outputs. The loop terminates when EnumOutputs returns DXGI_ERROR_NOT_FOUND.

CheckInterfaceSupport

HRESULT CheckInterfaceSupport(REFIID InterfaceName, UINT *pUMDriverVersion, LPWSTR pDeviceName, UINT NameLength)

Checks the support of a graphics interface.

Parameters

  • InterfaceName [in]
    Type: REFIID
    The globally unique identifier (GUID) for the interface.
  • pUMDriverVersion [out]
    Type: UINT*
    The version of the user-mode driver.
  • pDeviceName [out, optional]
    Type: LPWSTR
    The name of the device.
  • NameLength [in]
    Type: UINT
    The length of the device name buffer.

Return Value

Returns S_OK if successful; otherwise, returns one of the DXGI error codes.

Remarks

This method is used to query the driver's support for a particular graphics interface.

See Also

IDXGIDeviceSubObject

DXGI Interfaces