Blt
Expand Minimize

CreateOverlay routine

The CreateOverlay function allocates overlay hardware and makes the overlay visible.

Syntax


PFND3DDDI_CREATEOVERLAY CreateOverlay;

__checkReturn HRESULT APIENTRY CreateOverlay(
  _In_     HANDLE hDevice,
  _Inout_  D3DDDIARG_CREATEOVERLAY *pData
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

pData [in, out]

A pointer to a D3DDDIARG_CREATEOVERLAY structure that describes the overlay.

Return value

CreateOverlay returns one of the following values:

Return codeDescription
S_OK

The overlay is successfully created.

E_OUTOFMEMORY

CreateOverlay could not complete because of insufficient memory.

D3DDDIERR_NOTAVAILABLE

CreateOverlay 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

Version

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

Header

D3dumddi.h (include D3dumddi.h)

See also

D3DDDIARG_CREATEOVERLAY
D3DDDI_DEVICEFUNCS

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft