Edit

Share via

IDirect3D9::GetAdapterDisplayMode method (d3d9helper.h)

  • Article

Retrieves the current display mode of the adapter.

Syntax

HRESULT GetAdapterDisplayMode(
  [in]      UINT           Adapter,
  [in, out] D3DDISPLAYMODE *pMode
);

Parameters

[in] Adapter

Type: UINT

Ordinal number that denotes the display adapter to query. D3DADAPTER_DEFAULT is always the primary display adapter.

[in, out] pMode

Type: D3DDISPLAYMODE*

Pointer to a D3DDISPLAYMODE structure, to be filled with information describing the current adapter's mode.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK.

If Adapter is out of range or pMode is invalid, this method returns D3DERR_INVALIDCALL.

Remarks

GetAdapterDisplayMode will not return the correct format when the display is in an extended format, such as 2:10:10:10. Instead, it returns the format X8R8G8B8.

Requirements

Requirement Value
Target Platform Windows
Header d3d9helper.h (include D3D9.h)
Library D3D9.lib

See also

IDirect3D9