PFND3DDDI_UPDATEOVERLAY callback function

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 codeDescription
S_OK

The overlay is successfully modified.

E_OUTOFMEMORY

UpdateOverlay could not complete because of insufficient memory.

D3DDDIERR_NOTAVAILABLE

UpdateOverlay could not complete because insufficient bandwidth was available or the requested overlay hardware was unavailable.

D3DDDIERR_UNSUPPORTEDOVERLAYFORMAT

The specified overlay format is not supported by the overlay hardware.

D3DDDIERR_UNSUPPORTEDOVERLAY

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

Target platform

Desktop

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dumddi.h (include D3dumddi.h)

See also

D3DDDIARG_UPDATEOVERLAY
D3DDDI_DEVICEFUNCS

 

 

Send comments about this topic to Microsoft

Show: