Export (0) Print
Expand All

IDirect3D9ExOverlayExtension::CheckDeviceOverlayType method

Queries the overlay hardware capabilities of a Direct3D device.


HRESULT CheckDeviceOverlayType(
  [in]   UINT Adapter,
  [in]   D3DDEVTYPE DevType,
  [in]   UINT OverlayWidth,
  [in]   UINT OverlayHeight,
  [in]   D3DFORMAT OverlayFormat,
  [in]   D3DDISPLAYMODEEX *pDisplayMode,
  [in]   D3DDISPLAYROTATION DisplayRotation,
  [out]  D3DOVERLAYCAPS *pOverlayCaps


Adapter [in]

An ordinal number that denotes the display adapter. D3DADAPTER_DEFAULT is always the primary display adapter.

DevType [in]

Specifies the Direct3D device type as a member of the D3DDEVTYPE enumerated type.

OverlayWidth [in]

The width of the overlay to create, in pixels.

OverlayHeight [in]

The height of the overlay to create, in pixels.

OverlayFormat [in]

The surface format of the overlay.

pDisplayMode [in]

A pointer to a D3DDISPLAYMODEEX structure that specifies the display mode that will be used. If this parameter is NULL, the current display mode is assumed.

DisplayRotation [in]

Specifies the display rotation mode as a member of the D3DDISPLAYROTATION enumerated type.

pOverlayCaps [out]

A pointer to a D3DOVERLAYCAPS structure. If the driver supports the overlay settings specified in the input parameters, the method fills this structure with the capabilities of the overlay hardware.

Return value

This method can return one of these values.

Return codeDescription

Invalid parameter, or the device does not support hardware overlay.


The device does not support overlay for the specified size or display mode.


The device does not support overlay for the specified surface format.



Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]



See also

Hardware Overlay Support



Community Additions

© 2014 Microsoft