DXGKDDI_UPDATEOVERLAY callback function (d3dkmddi.h)

Article
02/22/2024

The DxgkDdiUpdateOverlay function modifies the overlay hardware.

Syntax

DXGKDDI_UPDATEOVERLAY DxgkddiUpdateoverlay;

NTSTATUS DxgkddiUpdateoverlay(
  [in] IN_CONST_HANDLE hOverlay,
  [in] IN_CONST_PDXGKARG_UPDATEOVERLAY pUpdateOverlay
)
{...}

Parameters

[in] hOverlay

A handle to the overlay to modify. 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 that pCreateOverlay points to.

[in] pUpdateOverlay

A pointer to a DXGKARG_UPDATEOVERLAY structure that describes how to modify the overlay hardware.

Return value

DxgkDdiUpdateOverlay returns one of the following values:

Return code	Description
STATUS_SUCCESS	DxgkDdiUpdateOverlay successfully modified the overlay.
STATUS_INVALID_PARAMETER	Parameters that were passed to DxgkDdiUpdateOverlay contained errors that prevented it from completing.
STATUS_NO_MEMORY	DxgkDdiUpdateOverlay could not allocate memory that was required for it to complete.
STATUS_INSUFFICIENT_RESOURCES	DxgkDdiUpdateOverlay 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 DxgkDdiUpdateOverlay.

Remarks

DxgkDdiUpdateOverlay should be made pageable.

Requirements

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