This topic has not yet been rated - Rate this topic

pfnReclaimResources routine

Called by the Microsoft DirectX Graphics Infrastructure (DXGI) runtime to reclaim video memory resources that the user-mode display driver previously offered for reuse. Implemented by Windows Display Driver Model (WDDM) 1.2 and later user-mode display drivers.

Syntax

C++


HRESULT __stdcall* pfnReclaimResources(
  DXGI_DDI_ARG_RECLAIMRESOURCES *pResources
);

Parameters

pResources: A pointer to a DXGI_DDI_ARG_RECLAIMRESOURCES structure that defines the video memory resources to reclaim.

Return value

Returns one of the following values.

Return code	Description
S_OK	The video memory resources were successfully reclaimed. This error code is returned if the driver does not need to call the pfnReclaimAllocationsCb function.
E_INVALIDARG	An invalid parameter was supplied. This error code is returned if the driver calls the pfnReclaimAllocationsCb function and that function returns E_INVALIDARG.
D3DDDIERR_DEVICEREMOVED	The video memory manager or display miniport driver could not complete the operation because either a Plug and Play (PnP) Stop event or a Timeout Detection and Recovery (TDR) event occurred. This error code is returned if the driver calls the pfnReclaimAllocationsCb function and that function returns D3DDDIERR_DEVICEREMOVED. If the driver calls pfnReclaimAllocationsCb multiple times and any call returns D3DDDIERR_DEVICEREMOVED, the driver must return that value.

Return code

Description

S_OK

The video memory resources were successfully reclaimed.

This error code is returned if the driver does not need to call the pfnReclaimAllocationsCb function.

E_INVALIDARG

An invalid parameter was supplied.

This error code is returned if the driver calls the pfnReclaimAllocationsCb function and that function returns E_INVALIDARG.

D3DDDIERR_DEVICEREMOVED

The video memory manager or display miniport driver could not complete the operation because either a Plug and Play (PnP) Stop event or a Timeout Detection and Recovery (TDR) event occurred.

This error code is returned if the driver calls the pfnReclaimAllocationsCb function and that function returns D3DDDIERR_DEVICEREMOVED. If the driver calls pfnReclaimAllocationsCb multiple times and any call returns D3DDDIERR_DEVICEREMOVED, the driver must return that value.

Remarks

This function is declared in Dxgiddi.h as follows.


HRESULT ( __stdcall /*APIENTRY*/ * pfnReclaimResources ) (DXGI_DDI_ARG_RECLAIMRESOURCES*);

Requirements