IDXGIOutput6::GetDesc1 method (dxgi1_6.h)

Get an extended description of the output that includes color characteristics and connection type.

Syntax

HRESULT GetDesc1(
  [out] DXGI_OUTPUT_DESC1 *pDesc
);

Parameters

[out] pDesc

Type: DXGI_OUTPUT_DESC1*

A pointer to the output description (see DXGI_OUTPUT_DESC1).

Return value

Type: HRESULT

Returns a code that indicates success or failure. S_OK if successful, DXGI_ERROR_INVALID_CALL if pDesc is passed in as NULL.

Remarks

Some scenarios do not have well-defined values for all fields in this struct. For example, if this IDXGIOutput represents a clone/duplicate set, or if the EDID has missing or invalid data. In these cases, the OS will provide some default values that correspond to a standard SDR display.

An output's reported color and luminance characteristics can adjust dynamically while the system is running due to user action or changing ambient conditions. Therefore, apps should periodically query IDXGIFactory::IsCurrent and re-create their IDXGIFactory if it returns FALSE. Then re-query GetDesc1 from the new factory's equivalent output to retrieve the newest color information.

For more details on how to write apps that react dynamically to monitor capabilities, see Using DirectX with high dynamic range displays and Advanced Color.

On a high DPI desktop, GetDesc1 returns the visualized screen size unless the app is marked high DPI aware. For info about writing DPI-aware Win32 apps, see High DPI.

Requirements

See also

DXGI Interfaces

IDXGIOutput6