InterlockedCompareStore function

Compares the input to the comparison value, atomically.

Syntax

void InterlockedCompareStore(
  in UINT dest,
  in UINT compare_value,
  in UINT value
);

Parameters

dest [in]

Type: UINT

The destination address.

compare_value [in]

Type: UINT

The comparison value.

value [in]

Type: UINT

The input value.

Return value

This function does not return a value.

Remarks

This operation can only be performed on int or uint typed resources and shared memory variables. There are three possible uses for this function. The first is when R is a shared memory variable type. In this case, the function performs the operation on the shared memory register referenced by dest. The second scenario is when R is a resource variable type. In this scenario, the function performs the operation on the resource location referenced by dest. Finally, the third scenario is when R is a local variable type. In this scenario, the function reduces to the operation performed using local operations.

This function is supported in the following types of shaders:

See also

RWByteAddressBuffer

Shader Model 5