D3D12DDI_NODE_OUTPUT_0108 structure (d3d12umddi.h)

The D3D12DDI_NODE_OUTPUT_0108 structure describes the output of a node in a work graph.

Syntax

typedef struct D3D12DDI_NODE_OUTPUT_0108 {
  D3D12DDI_NODE_ID_0108                    FinalName;
  UINT                                     OutputIndex;
  D3D12DDI_NODE_IO_KIND_0108               NodeIOKind;
  UINT                                     NodeIOFlags;
  UINT                                     RecordSizeInBytes;
  BOOL                                     bAllowSparseNodes;
  const D3D12DDI_RECORD_DISPATCH_GRID_0108 *pRecordDispatchGrid;
  const UINT                               *pMaxRecords;
  const UINT                               *pMaxRecordsSharedWithOutputIndex;
  UINT                                     ArraySize;
  const D3D12DDI_NODE_LIST_ENTRY_0108      *pOutputs;
} D3D12DDI_NODE_OUTPUT_0108;

Members

FinalName

A D3D12DDI_NODE_ID_0108 structure that specifies the final name of the node after any optional renames done at the application level. If ArraySize is greater than 1, this is the NodeID of beginning of the array of nodes being output to.

OutputIndex

Zero-based index of this output in the set of outputs for this node (node array output counts as one entry in this set). This index matches the order the outputs are declared, and how they appear in the pOutputs arrays in D3D12DDI_BROADCASTING_LAUNCH_NODE_PROPERTIES_0108, D3D12DDI_COALESCING_LAUNCH_NODE_PROPERTIES_0108, and D3D12DDI_THREAD_LAUNCH_NODE_PROPERTIES_0108. As such, this value is redundant, but provided for clarity. Other members of this structure reference nodes using this indexing space.

NodeIOKind

A D3D12DDI_NODE_IO_KIND_0108 enumeration that specifies the class of input. See Node output declaration.

NodeIOFlags

Flags that provide additional information about the node's output. See the flags within D3D12DDI_NODE_IO_FLAGS_FLAG_MASK in D3D12DDI_NODE_IO_FLAGS_0108. See also Node input declaration.

RecordSizeInBytes

Size of the output record, in bytes. Can be 0 if NodeIOKind is D3D12DDI_NODE_IO_KIND_EMPTY_OUTPUT_0108.

bAllowSparseNodes

Boolean that specifies whether sparse nodes are allowed. This member maps to the AllowSparseNodes attribute on a node output, or can be overridden at the application level, so the final status is indicated here.

pRecordDispatchGrid

If nullptr, the output record doesn't contain SV_DispatchGrid. Else, points to a description of how SV_DispatchGrid appears in the output record. See D3D12DDI_RECORD_DISPATCH_GRID_0108.

pMaxRecords

Maximum number of output records that a thread group will output to this output node/array. If the output record budget for this output is shared with another output, pMaxRecords is nullptr and pMaxRecordsSharedWithOutputIndex is specified instead. If the shader declared [MaxRecordsSharedWith()], it's valid to override it with pMaxRecords, which makes the output budget no longer shared.

pMaxRecordsSharedWithOutputIndex

If this output shares its output record budget with another output, pMaxRecordsSharedWithOutputIndex points to the 0-based index of that output based on the order they are declared, and how they appear in the pOutputs arrays in D3D12DDI_BROADCASTING_LAUNCH_NODE_PROPERTIES_0108, D3D12DDI_COALESCING_LAUNCH_NODE_PROPERTIES_0108, and D3D12DDI_THREAD_LAUNCH_NODE_PROPERTIES_0108. The output that is pointed to has pMaxRecords specified. If the current output doesn't share its output record budget, pMaxRecordsSharedWithIndex is nullptr. If the shader declared [MaxRecords()], it is valid to override it with pMaxRecordsSharedWithIndex, which makes the output budget now shared with another output.

ArraySize

The number of nodes in the array of nodes being output to. If this is 1, the output is a single node. If this is greater than 1, the output is an array of nodes. The nodes are contiguous in the array, and the first node is the one specified by FinalName. A value of 0xffffffff means unbounded node array size, which is only permitted when bAllowSparseNodes is true.

pOutputs

List (D3D12DDI_NODE_LIST_ENTRY) of nodes (D3D12DDI_NODE_0108) that this node outputs to. If pOutputs is nullptr this node doesn't output to other nodes. If bAllowSparseNodes is true, this list isn't necessarily as long as ArraySize. Regardless of bAllowSparseNodes state, drivers shouldn't assume the list entries is in array index order. The array index of a given output can be found in its node ID. When AddToStateObject() adds outputs, additions will appear at the start of the list, which is another reason not to assume they are array index order.

Remarks

For more information, see Work graphs.

Requirements

See also

D3D12DDI_BROADCASTING_LAUNCH_NODE_PROPERTIES_0108

D3D12DDI_COALESCING_LAUNCH_NODE_PROPERTIES_0108

D3D12DDI_THREAD_LAUNCH_NODE_PROPERTIES_0108