DXGI_MODE_DESC structure

Describes a display mode.

Syntax

c++

typedef struct DXGI_MODE_DESC {
  UINT                     Width;
  UINT                     Height;
  DXGI_RATIONAL            RefreshRate;
  DXGI_FORMAT              Format;
  DXGI_MODE_SCANLINE_ORDER ScanlineOrdering;
  DXGI_MODE_SCALING        Scaling;
} DXGI_MODE_DESC;

Members

• Width
  Type: UINT

  A value that describes the resolution width. If you specify the width as zero when you call the IDXGIFactory::CreateSwapChain method to create a swap chain, the runtime obtains the width from the output window and assigns this width value to the swap-chain description. You can subsequently call the IDXGISwapChain::GetDesc method to retrieve the assigned width value.

• Height
  Type: UINT

  A value describing the resolution height. If you specify the height as zero when you call the IDXGIFactory::CreateSwapChain method to create a swap chain, the runtime obtains the height from the output window and assigns this height value to the swap-chain description. You can subsequently call the IDXGISwapChain::GetDesc method to retrieve the assigned height value.

• RefreshRate
  Type: DXGI_RATIONAL

  A DXGI_RATIONAL structure describing the refresh rate in hertz

• Format
  Type: DXGI_FORMAT

  A DXGI_FORMAT structure describing the display format.

• ScanlineOrdering
  Type: DXGI_MODE_SCANLINE_ORDER

  A member of the DXGI_MODE_SCANLINE_ORDER enumerated type describing the scanline drawing mode.

• Scaling
  Type: DXGI_MODE_SCALING

  A member of the DXGI_MODE_SCALING enumerated type describing the scaling mode.

Remarks

This structure is used by the GetDisplayModeList and FindClosestMatchingMode methods.

The following format values are valid for display modes and when you create a bit-block transfer (bitblt) model swap chain. The valid values depend on the feature level that you are working with.

• Feature level >= 9.1

  • DXGI_FORMAT_R8G8B8A8_UNORM
  • DXGI_FORMAT_R8G8B8A8_UNORM_SRGB
  • DXGI_FORMAT_B8G8R8A8_UNORM (except 10.x on Windows Vista)
  • DXGI_FORMAT_B8G8R8A8_UNORM_SRGB (except 10.x on Windows Vista)

• Feature level >= 10.0

  • DXGI_FORMAT_R16G16B16A16_FLOAT
  • DXGI_FORMAT_R10G10B10A2_UNORM

• Feature level >= 11.0

  • DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM

You can pass one of these format values to ID3D11Device::CheckFormatSupport to determine if it is a valid format for displaying on screen. If ID3D11Device::CheckFormatSupport returns D3D11_FORMAT_SUPPORT_DISPLAY in the bit field to which the pFormatSupport parameter points, the format is valid for displaying on screen.

Starting with Windows 8 for a flip model swap chain (that is, a swap chain that has the DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL value set in the SwapEffect member of DXGI_SWAP_CHAIN_DESC), you must set the Format member of DXGI_MODE_DESC to DXGI_FORMAT_R16G16B16A16_FLOAT, DXGI_FORMAT_B8G8R8A8_UNORM, or DXGI_FORMAT_R8G8B8A8_UNORM.

Because of the relaxed render target creation rules that Direct3D 11 has for back buffers, applications can create a DXGI_FORMAT_B8G8R8A8_UNORM_SRGB render target view from a DXGI_FORMAT_B8G8R8A8_UNORM swap chain so they can use automatic color space conversion when they render the swap chain.

Requirements

Header

DXGI.h

See also

DXGI Structures