IddCxSwapChainInSystemMemory function (iddcx.h)

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

Syntax

HRESULT IddCxSwapChainInSystemMemory(
  [in]  IDDCX_SWAPCHAIN SwapChainObject,
  [out] BOOL            *pInSystemMemory
);

Parameters

[in] SwapChainObject

The IDDCX_SWAPCHAIN object whose allocation is to be checked.

[out] pInSystemMemory

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

Return value

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.

Requirements

See also

IddCxSwapChainReleaseAndAcquireBuffer

IddCxSwapChainReleaseAndAcquireSystemBuffer