Edit

DXGKDDI_CREATEOVERLAY callback function (d3dkmddi.h)

  • Article

The DxgkDdiCreateOverlay function enables the overlay hardware if the hardware is capable.

Syntax

DXGKDDI_CREATEOVERLAY DxgkddiCreateoverlay;

NTSTATUS DxgkddiCreateoverlay(
  [in]     IN_CONST_HANDLE hAdapter,
  [in/out] INOUT_PDXGKARG_CREATEOVERLAY pCreateOverlay
)
{...}

Parameters

[in] hAdapter

A handle to a context block that is associated with a display adapter. The display miniport driver previously provided this handle to the Microsoft DirectX graphics kernel subsystem in the MiniportDeviceContext output parameter of the DxgkDdiAddDevice function.

[in/out] pCreateOverlay

A pointer to a DXGKARG_CREATEOVERLAY structure that describes the overlay.

Return value

DxgkDdiCreateOverlay returns one of the following values:

Return code Description
STATUS_SUCCESS DxgkDdiCreateOverlay successfully created the overlay.
STATUS_INVALID_PARAMETER Parameters that were passed to DxgkDdiCreateOverlay contained errors that prevented it from completing.
STATUS_NO_MEMORY DxgkDdiCreateOverlay could not allocate memory that was required for it to complete.
STATUS_INSUFFICIENT_RESOURCES DxgkDdiCreateOverlay could not complete because insufficient bandwidth was available or the requested overlay hardware could not complete the task.
STATUS_GRAPHICS_DRIVER_MISMATCH The display miniport driver is not compatible with the user-mode display driver that initiated the call to DxgkDdiCreateOverlay.

Remarks

DxgkDdiCreateOverlay should be made pageable.

Requirements

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

See also

DXGKARG_CREATEOVERLAY

DxgkDdiAddDevice