Platform SDK: DirectX

D3DXGetCurrentVideoMode

The D3DXGetCurrentVideoMode function retrieves the current video mode for the specified device.

HRESULT D3DXGetCurrentVideoMode(
  DWORD deviceIndex,
  D3DX_VIDMODEDESC* pVidMode
); 

Parameters

deviceIndex
An index value specifying the device. Using D3DX_DEFAULT for this parameter specifies the device with the highest acceleration level afforded on the primary surface.
pVidMode
A pointer to a D3DX_VIDMODEDESC structure that returns with a description of the current display mode.

Return Values

If the function succeeds, the return value is S_OK.

If the function fails, the return value may be one of the following values:

D3DXERR_D3DXNOTSTARTEDYET
D3DXERR_INITFAILED
D3DXERR_INVALIDD3DXDEVICEINDEX
D3DXERR_NULLPOINTER

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Version: Requires DirectX 7.0.
  Header: Declared in d3dxcore.h.
  Library: Use d3dx.lib.

See Also

D3DXGetMaxNumVideoModes, D3DXGetVideoMode