ID3D12GraphicsCommandList::Write32BitValueBottomOfPipeX Method

Writes a 32-bit value at the bottom of the pipeline to a given destination in memory.

Syntax

public:
void Write32BitValueBottomOfPipeX(
         D3D12_GPU_VIRTUAL_ADDRESS Destination,
         UINT Value,
         D3D12XBOX_FLUSH Flush,
         D3D12XBOX_WRITE_VALUE_BOP_FLAGS Flags
)

Parameters

Destination
Type: D3D12_GPU_VIRTUAL_ADDRESS

[in] The base address of graphics memory at which to write the value. The address must be 4-byte aligned.

Value
Type: UINT

[in] The 32-bit value to be written.

Flush
Type: D3D12XBOX_FLUSH

[in] A set of optional flush flags to invalidate the texture cache in conjunction with the write operation, as a bitwise-OR’d combination of D3D12XBOX_FLUSH enumeration constants. Must be one of the following flags:

D3D12XBOX_FLUSH_BOP_TEXTURE_L1_INVALIDATE
D3D12XBOX_FLUSH_BOP_TEXTURE_L1_VOLATILE
D3D12XBOX_FLUSH_BOP_TEXTURE_L2_INVALIDATE
D3D12XBOX_FLUSH_BOP_TEXTURE_L2_VOLATILE
D3D12XBOX_FLUSH_BOP_TEXTURE_L2_WRITEBACK

Flags
Type: D3D12XBOX_WRITE_VALUE_BOP_FLAGS

[in] Flags to control this operation, as a bitwise-OR’d combination of D3D12XBOX_WRITE_VALUE_BOP_FLAGS enumeration constants. Must currently be set to D3D12XBOX_WRITE_VALUE_BOP_FLAG_NONE. The D3D12XBOX_WRITE_VALUE_BOP_FLAG_GPU_TIMESTAMP and D3D12XBOX_WRITE_VALUE_BOP_FLAG_SYSTEM_TIMESTAMP flags request 64-bit timestamp writebacks, and are therefore only supported with ID3D12GraphicsCommandList::Write64BitValueBottomOfPipeX.

Return value

Type: void

Returns nothing.

Remarks

The 32-bit value will be written to memory after the completion of all shader execution and render back-end processing, but potentially before all memory writes generated by preceding draws and dispatches have finished.

When used in conjunction with the method ID3D12GraphicsCommandList::Wait32BitValueX, Write32BitValueBottomOfPipeX can serve as a useful cross-engine intra-command-list synchronization mechanism.

Requirements

Header: Declared in d3d12_x.h.

Library: Use d3d12_x.lib.