PFND3DDDI_DESTROYOVERLAYCB callback function (d3dumddi.h)

The pfnDestroyOverlayCb function disables the overlay hardware and destroys the kernel-mode overlay object.

Syntax

PFND3DDDI_DESTROYOVERLAYCB Pfnd3dddiDestroyoverlaycb;

HRESULT Pfnd3dddiDestroyoverlaycb(
  HANDLE hDevice,
  const D3DDDICB_DESTROYOVERLAY *unnamedParam2
)
{...}

Parameters

hDevice

A handle to the display device (graphics context).

unnamedParam2

pData [in]

A pointer to a D3DDDICB_DESTROYOVERLAY structure that contains a handle to the overlay object to be disabled.

Return value

pfnDestroyOverlayCb returns one of the following values:

Return code	Description
S_OK	The overlay object was successfully disabled.
E_INVALIDARG	Parameters were validated and determined to be incorrect.

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_DESTROYOVERLAY

D3DDDI_DEVICECALLBACKS