IDirect3D9::EnumAdapterModes method (d3d9.h)

Queries the device to determine whether the specified adapter supports the requested format and display mode. This method could be used in a loop to enumerate all the available adapter modes.

Syntax

HRESULT EnumAdapterModes(
  [in]  UINT           Adapter,
  [in]  D3DFORMAT      Format,
  [in]  UINT           Mode,
  [out] D3DDISPLAYMODE *pMode
);

Parameters

[in] Adapter

Type: UINT

Ordinal number denoting the display adapter to enumerate. D3DADAPTER_DEFAULT is always the primary display adapter. This method returns D3DERR_INVALIDCALL when this value equals or exceeds the number of display adapters in the system.

[in] Format

Type: D3DFORMAT

Allowable pixel formats. See Remarks.

[in] Mode

Type: UINT

Represents the display-mode index which is an unsigned integer between zero and the value returned by GetAdapterModeCount minus one.

[out] pMode

Type: D3DDISPLAYMODE*

A pointer to the available display mode of type D3DDISPLAYMODE. See Remarks.

Return value

Type: HRESULT

• If the device can be used on this adapter, D3D_OK is returned.
• If the Adapter equals or exceeds the number of display adapters in the system, D3DERR_INVALIDCALL is returned.
• If either surface format is not supported or if hardware acceleration is not available for the specified formats, D3DERR_NOTAVAILABLE is returned.

Remarks

An application supplies a display mode and a format to EnumAdapterModes which returns a display mode. This method could be used in a loop to enumerate all available display modes.

The application specifies a format and the enumeration is restricted to those display modes that exactly match the format (alpha is ignored). Allowed formats (which are members of D3DFORMAT) are as follows:

• D3DFMT_A1R5G5B5
• D3DFMT_A2R10G10B10
• D3DFMT_A8R8G8B8
• D3DFMT_R5G6B5
• D3DFMT_X1R5G5B5
• D3DFMT_X8R8G8B8

Requirements

See also

IDirect3D9