PFND3DDDI_UPDATEOVERLAYCB callback function (d3dumddi.h)

The pfnUpdateOverlayCb function modifies a kernel-mode overlay object.

Syntax

PFND3DDDI_UPDATEOVERLAYCB Pfnd3dddiUpdateoverlaycb;

HRESULT Pfnd3dddiUpdateoverlaycb(
  HANDLE hDevice,
  const D3DDDICB_UPDATEOVERLAY *unnamedParam2
)
{...}

Parameters

hDevice

A handle to the display device (graphics context).

unnamedParam2

pData [in]

A pointer to a D3DDDICB_UPDATEOVERLAY structure that describes how to modify the overlay.

Return value

pfnUpdateOverlayCb returns one of the following values:

Return code Description
S_OK The overlay object was successfully modified.
D3DDDIERR_NOTAVAILABLE pfnUpdateOverlayCb failed because of a lack of overlay hardware or bandwidth.
E_INVALIDARG Parameters were validated and determined to be incorrect.
E_OUTOFMEMORY pfnUpdateOverlayCb could not allocate memory that was required for it to complete.

This function might also return other HRESULT values.

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

D3DDDICB_UPDATEOVERLAY

D3DDDI_DEVICECALLBACKS