Edit

Share via

D3DKMT_GETOVERLAYSTATE structure (d3dkmthk.h)

  • Article

The D3DKMT_GETOVERLAYSTATE structure describes parameters that the D3DKMTGetOverlayState function uses to retrieve status about an overlay.

Syntax

typedef struct _D3DKMT_GETOVERLAYSTATE {
  [in]  D3DKMT_HANDLE hDevice;
  [in]  D3DKMT_HANDLE hOverlay;
  [out] BOOLEAN       OverlayEnabled;
} D3DKMT_GETOVERLAYSTATE;

Members

[in] hDevice

A D3DKMT_HANDLE data type that represents the kernel-mode handle to the device that the overlay is associated with.

[in] hOverlay

A D3DKMT_HANDLE data type that represents the kernel-mode handle that is returned by the create-overlay function and that identifies the kernel-mode overlay object to retrieve status about.

[out] OverlayEnabled

A Boolean variable that receives TRUE if the overlay is enabled and FALSE if the overlay is disabled.

Requirements

Requirement Value
Minimum supported client D3DKMT_GETOVERLAYSTATE is supported beginning with the Windows 7 operating system.
Header d3dkmthk.h (include D3dkmthk.h)

See also

D3DKMTGetOverlayState