pfnDestroyOverlayCb routine

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

Syntax


PFND3DDDI_DESTROYOVERLAYCB pfnDestroyOverlayCb;

_checkReturn HRESULT APIENTRY CALLBACK pfnDestroyOverlayCb(
  _In_  HANDLE hDevice,
  _In_  const D3DDDICB_DESTROYOVERLAY *pData
)
{ ... }

Parameters

hDevice [in]

A handle to the display device (graphics context).

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 codeDescription
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.

Examples

The following code example shows how to destroy the overlay object.


HRESULT CD3DContext::DestroyOverlay(CONST D3DDDIARG_DESTROYOVERLAY* pDestroyOverlay)
{
    D3DDDICB_DESTROYOVERLAY DestroyCB;

    DestroyCB.hKernelOverlay = (D3DKMT_HANDLE) g_hOverlay;

    HRESULT hr = m_d3dCallbacks.pfnDestroyOverlayCb(m_hD3D, &DestroyCB);

    return S_OK;
}

Requirements

Version

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

Header

D3dumddi.h (include D3dumddi.h)

See also

D3DDDI_DEVICECALLBACKS
D3DDDICB_DESTROYOVERLAY

 

 

Send comments about this topic to Microsoft

Afficher:
© 2014 Microsoft