DxgkDdiUpdateOverlay routine
The DxgkDdiUpdateOverlay function modifies the overlay hardware.
Syntax
PDXGKDDI_UPDATEOVERLAY DxgkDdiUpdateOverlay; NTSTATUS APIENTRY DxgkDdiUpdateOverlay( _In_ const HANDLE hOverlay, _In_ const DXGKARG_UPDATEOVERLAY *pUpdateOverlay ) { ... }
Parameters
- hOverlay [in]
-
[in] 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.
- pUpdateOverlay [in]
-
[in] 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 |
|---|---|
|
DxgkDdiUpdateOverlay successfully modified the overlay. |
|
Parameters that were passed to DxgkDdiUpdateOverlay contained errors that prevented it from completing. |
|
DxgkDdiUpdateOverlay could not allocate memory that was required for it to complete. |
|
DxgkDdiUpdateOverlay could not complete because insufficient bandwidth was available or the requested overlay hardware could not complete the task. |
|
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
|
Version | Available in Windows Vista and later versions of the Windows operating systems. |
|---|---|
|
Header |
|
|
IRQL | PASSIVE_LEVEL |
See also
Send comments about this topic to Microsoft
Build date: 11/29/2012
