ID3D12GraphicsCommandList::Wait64BitValueX Method

Waits on the 64-bit value at a given source location in memory to satisfy a comparison condition.

Syntax

public:
void Wait64BitValueX(
         D3D12_GPU_VIRTUAL_ADDRESS Address,
         D3D12_COMPARISON_FUNC ComparisonFunction,
         UINT64 ReferenceValue,
         D3D12XBOX_WAIT_FLAGS Flags
)

Parameters

Address
Type: D3D12_GPU_VIRTUAL_ADDRESS

[in] The base address of graphics memory containing the evaluation value for the wait. The address must be 8-byte aligned.

ComparisonFunction
Type: D3D12_COMPARISON_FUNC

[in] The function to use as the basis for the wait condition, as a D3D12_COMPARISON_FUNC enumeration constant, such as for “never”, “less than”, or “greater than or equal to”. The value at Address memory location will be tested against ReferenceValue using this function. Waits performed using the PFP engine can only employ a ComparisonFunction of D3D12_COMPARISON_FUNC_GREATER_EQUAL.

ReferenceValue
Type: UINT64

[in] The value to use as the comparison basis for the wait.

Flags
Type: D3D12XBOX_WAIT_FLAGS

[in] A set of optional flags to select the engine used to perform the wait, as a bitwise-OR’d combination of D3D12XBOX_WAIT_FLAGS enumeration constants.

D3D12XBOX_WAIT_FLAG_NONE will perform the wait using the ME engine.
D3D12XBOX_WAIT_FLAG_SELECT_ENGINE_PFP will perform the wait using the PFP engine.

Return value

Type: void

Returns nothing.

Remarks

A wait will be satisfied when (Value-at-Address <ComparisonFunction> ReferenceValue) evaluates as true.

Waits should be issued with care, as failure to satisfy the wait condition will hang the GPU.

Requirements

Header: Declared in d3d12_x.h.

Library: Use d3d12_x.lib.