UpdateOverlay routine
The UpdateOverlay function reconfigures or moves an overlay that is being displayed.
Syntax
PFND3DDDI_UPDATEOVERLAY UpdateOverlay;
__checkReturn HRESULT APIENTRY UpdateOverlay(
_In_ HANDLE hDevice,
_In_ const D3DDDIARG_UPDATEOVERLAY *pData
)
{ ... }
Parameters
- hDevice [in]
-
A handle to the display device (graphics context).
- pData [in]
-
A pointer to a D3DDDIARG_UPDATEOVERLAY structure that describes how to reconfigure the overlay.
Return value
UpdateOverlay returns one of the following values:
| Return code | Description |
|---|---|
|
The overlay is successfully modified. |
|
UpdateOverlay could not complete because of insufficient memory. |
|
UpdateOverlay could not complete because insufficient bandwidth was available or the requested overlay hardware was unavailable. |
|
The specified overlay format is not supported by the overlay hardware. |
|
The overlay hardware is not supported for the specified size and display mode. |
Remarks
Overlays are independent from the resources that are displayed by using the overlays.
Requirements
|
Version | Available in Windows Vista and later versions of the Windows operating systems. |
|---|---|
|
Header |
|
See also
Send comments about this topic to Microsoft
Build date: 11/29/2012
