DXGKDDI_FLIPOVERLAY callback function (d3dkmddi.h)

Article
02/22/2024

The DxgkDdiFlipOverlay function displays a new allocation by using the specified overlay.

Syntax

DXGKDDI_FLIPOVERLAY DxgkddiFlipoverlay;

NTSTATUS DxgkddiFlipoverlay(
  [in] IN_CONST_HANDLE hOverlay,
  [in] IN_CONST_PDXGKARG_FLIPOVERLAY pFlipOverlay
)
{...}

Parameters

[in] hOverlay

A handle to the overlay to be flipped. 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.

[in] pFlipOverlay

A pointer to a DXGKARG_FLIPOVERLAY structure that describes the new allocation to display by using the overlay.

Return value

DxgkDdiFlipOverlay returns one of the following values:

Return code	Description
STATUS_SUCCESS	DxgkDdiFlipOverlay successfully displays the new allocation.
STATUS_INVALID_PARAMETER	Parameters that were passed to DxgkDdiFlipOverlay contained errors that prevented it from completing.
STATUS_NO_MEMORY	DxgkDdiFlipOverlay could not allocate memory that was required for it to complete.
STATUS_GRAPHICS_DRIVER_MISMATCH	The display miniport driver is not compatible with the user-mode display driver that initiated the call to DxgkDdiFlipOverlay.

Remarks

DxgkDdiFlipOverlay should be made pageable.

Requirements

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