Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 4.88 KB

nc-d3dumddi-pfnd3dddi_makeresidentcb.md

File metadata and controls

79 lines (60 loc) · 4.88 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NC:d3dumddi.PFND3DDDI_MAKERESIDENTCB
PFND3DDDI_MAKERESIDENTCB (d3dumddi.h)
PFND3DDDI_MAKERESIDENTCB instructs the OS to add a resource to the device residency list and to increment the residency reference count on this allocation.
display\pfnmakeresidentcb.htm
display
05/10/2018
PFND3DDDI_MAKERESIDENTCB callback function
PFND3DDDI_MAKERESIDENTCB, PFND3DDDI_MAKERESIDENTCB callback, d3dumddi/pfnMakeResidentCb, display.pfnmakeresidentcb, pfnMakeResidentCb, pfnMakeResidentCb callback function [Display Devices]
d3dumddi.h
D3dumddi.h
Desktop
Windows 10
Windows Server 2016
Windows
PFND3DDDI_MAKERESIDENTCB
d3dumddi/PFND3DDDI_MAKERESIDENTCB
APIRef
kbSyntax
UserDefined
d3dumddi.h
PFND3DDDI_MAKERESIDENTCB

PFND3DDDI_MAKERESIDENTCB callback function

-description

pfnMakeResidentCb is used to instruct the OS to add a resource to the device residency list and increment the residency reference count on this allocation.

-parameters

-param hDevice

A handle to the display device.

-param unnamedParam2

pData [in, out]

A pointer to a D3DDDI_MAKERESIDENT structure that describes the memory pages to make resident.

-returns

pfnMakeResidentCb returns one of the following values:

Return code Description
S_OK All allocations have been made resident on the GPU upon the exit from this function and are ready to be accessed immediately.
E_PENDING The allocations have been added to the device residency requirement list but still have pending paging operations to complete before they can be successfully accessed. In this case the user mode driver must wait for the PagingFenceValue on the monitored fence sync object associated with hPagingQueue to be signaled prior to submitting command buffers that reference allocations or a GPU page fault may occur.
E_OUTOFMEMORY The video memory manager can’t make every requested allocation resident. When this happens, no allocation in the provided list will see their residency count modified. In other word this is an atomic operation where either all of the allocation get their residency count increased, or none of them. Further, NumBytesToTrim indicates to the driver how many bytes must be trimmed from the device residency requirement list, by calling pfnEvictCb, before attempting to made the failed allocations resident again.
The memory budget associated with an application can change asynchronously with the application running. As a consequence of this, trimming the requested number of bytes will not guarantee that the next attempt to make the set of allocations resident will succeed as the memory budget for the application may have decreased. Because of this a driver should ensure that it attempts residency request in a loop, trimming between each iteration, until the request either succeeds or the driver has trimmed everything it possibly can to make forward progress on a single operation and use the required resource on that final attempt. If that final attempt fails, the underlying device will be put in error and the user mode driver should abort the request and return back to the application. No further submissions to any of the contexts belonging to a device in error will be allowed by the kernel.
For the DirectX 12.0 user mode driver, pfnMakeResidentCb behaves slightly differently because it is no longer responsible for trimming or paging in allocations. This is done to ensure that the state of all allocations after returning from the call remain the same as before the call. This means that if E_OUTOFMEMORY is returned from the function:
- All of the allocations remain in their original state.
- The allocations were not made resident.
- PagingFenceValue should be ignored.
If the driver needs to perform pfnMakeResidentCb calls in multiple batches to accommodate resource-to-allocation translation, the driver should undo any prior calls to pfnMakeResidentCb with equivalent calls to pfnEvictCb, and propagate the error code back to the runtime.

-see-also

D3DDDI_MAKERESIDENT

pfnEvictCb