XGMemoryLayout::RelinquishMapping Method

Relinquishes a previously defined mapping, placing its ESRAM and system pages back on the free lists.

Syntax

public:
HRESULT RelinquishMapping(
         const XGMemoryLayoutMapping *pMapping,
         UINT32 Flags
)

Parameters

pMapping
Type: XGMemoryLayoutMapping *

[in] The previously defined mapping to relinquish, as a pointer to an XGMemoryLayoutMapping structure.

Flags
Type: UINT32

Flags to control this method, as a bitwise-OR’d combination of XG_RELINQUISH_MAPPING_FLAGS enumeration constants, such as whether to preserve the mapping of ESRAM pages, and whether to preserve the mapping of system memory pages.

Return value

Type: HRESULT

S_OK, E_INVALIDARG, or E_OUTOFMEMORY, described in Direct3D 11 return codes.

Remarks

This method relinquishes a previously defined mapping, placing its ESRAM and system pages back on the free lists. This does not unmap the pages; the pages are recycled for use in creating future mappings in this layout. Therefore, consider the relinquish of a mapping as a barrier, where use of the memory in the relinquished mapping must strictly precede the use of any of the memory in future mappings.

Requirements