DXGKDDI_FLIPOVERLAY callback function

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

Syntax

DXGKDDI_FLIPOVERLAY DxgkddiFlipoverlay;

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

Parameters

hOverlay

[in] 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.

pFlipOverlay

[in] 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

   
Windows version Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dkmddi.h
IRQL PASSIVE_LEVEL

See Also

DXGKARG_CREATEOVERLAY

DXGKARG_FLIPOVERLAY

DxgkDdiCreateOverlay