Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 2.77 KB

nf-iddcx-iddcxswapchaininsystemmemory.md

File metadata and controls

72 lines (56 loc) · 2.77 KB
UID title ms.date tech.root targetos description req.assembly req.construct-type req.ddi-compliance req.dll req.header req.idl req.include-header req.irql req.kmdf-ver req.lib req.max-support req.namespace req.redist req.target-min-winverclnt req.target-min-winversvr req.target-type req.type-library req.umdf-ver req.unicode-ansi topic_type api_type api_location api_name f1_keywords dev_langs
NF:iddcx.IddCxSwapChainInSystemMemory
IddCxSwapChainInSystemMemory
10/20/2020
display
Windows
Learn more about the IddCxSwapChainInSystemMemory function.
function
iddcx.h
Windows Server 2022
apiref
DllExport
iddcx.h
IddCxSwapChainInSystemMemory
IddCxSwapChainInSystemMemory
iddcx/IddCxSwapChainInSystemMemory
c++

-description

IddCxSwapChainInSystemMemory checks whether buffers for a swapchain are resident in system memory.

-parameters

-param SwapChainObject [in]

The IDDCX_SWAPCHAIN object whose allocation is to be checked.

-param pInSystemMemory [out]

The result of the check. Set to TRUE when buffers are resident in system memory; otherwise set to FALSE.

-returns

IddCxSwapChainInSystemMemory returns S_OK on success; otherwise it returns an appropriate error code. Possible errors include SwapChainObject is an invalid swapchain object and pInSystemMemory is a null pointer.

-remarks

The driver can call IddCxSwapChainInSystemMemory at any point after IddCxSwapChainSetDevice has been called to check if the buffers for the swapchain are resident in system memory. It is recommended that drivers call this method when a new swapchain is being assigned, but are free to call it at any point in the lifecycle of the swapchain object.

When IddCxSwapChainInSystemMemory returns TRUE in pInSystemMemory, the driver can use either IddCxSwapChainReleaseAndAcquireBuffer or IddCxSwapChainReleaseAndAcquireSystemBuffer for releasing and acquiring buffers from the swapchain. The driver must continue to use that particular method throughout the lifetime of that particular swapchain.

When IddCxSwapChainInSystemMemory returns FALSE, the driver must use IddCxSwapChainReleaseAndAcquireBuffer to release and acquire buffers from the swapchain.

-see-also

IddCxSwapChainReleaseAndAcquireBuffer

IddCxSwapChainReleaseAndAcquireSystemBuffer