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

__checkReturn HRESULT 
  (APIENTRY *PFND3DDDI_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:

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.

Comments

Overlays are independent from the resources that are displayed by using the overlays.

Requirements

Headers: Declared in D3dumddi.h. Include D3dumddi.h.

See Also

D3DDDIARG_CREATEOVERLAY, D3DDDI_DEVICEFUNCS