DXGKDDI_DESTROYOVERLAY callback function (d3dkmddi.h)

The DxgkDdiDestroyOverlay function disables overlay hardware and deletes the specified overlay handle.

Syntax

DXGKDDI_DESTROYOVERLAY DxgkddiDestroyoverlay;

NTSTATUS DxgkddiDestroyoverlay(
  [in] IN_CONST_HANDLE hOverlay
)
{...}

Parameters

[in] hOverlay

A handle to the overlay to destroy. The display miniport driver's DxgkDdiCreateOverlay function previously provided this handle to the Microsoft DirectX graphics kernel subsystem in the hOverlay member of the DXGKARG_CREATEOVERLAY structure.

Return value

DxgkDdiDestroyOverlay returns STATUS_SUCCESS, or an appropriate error result if overlay hardware is not successfully disabled.

Remarks

DxgkDdiDestroyOverlay should be made pageable.

Requirements

Requirement Value
Minimum supported client Windows Vista
Target Platform Desktop
Header d3dkmddi.h
IRQL PASSIVE_LEVEL

See also

DXGKARG_CREATEOVERLAY

DxgkDdiCreateOverlay