Edit

PFND3DDDI_CREATEOVERLAY callback function (d3dumddi.h)

  • Article

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

Syntax

PFND3DDDI_CREATEOVERLAY Pfnd3dddiCreateoverlay;

HRESULT Pfnd3dddiCreateoverlay(
  HANDLE hDevice,
  D3DDDIARG_CREATEOVERLAY *unnamedParam2
)
{...}

Parameters

hDevice

A handle to the display device (graphics context).

unnamedParam2

pData [in, out]

A pointer to a D3DDDIARG_CREATEOVERLAY structure that describes the overlay.

Return value

CreateOverlay returns one of the following values:

Return code Description
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

Requirement Value
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dumddi.h (include D3dumddi.h)

See also

D3DDDIARG_CREATEOVERLAY

D3DDDI_DEVICEFUNCS