Edit

Share via

CD3DX12_PIPELINE_STATE_STREAM1 structure

  • Article

A helper structure for creating and working with graphics and compute pipeline states through a combined interface. See D3D12_GRAPHICS_PIPELINE_STATE_DESC and D3D12_COMPUTE_PIPELINE_STATE_DESC.

CD3DX12_PIPELINE_STATE_STREAM1 supports the Windows 10 Fall Creators Update with new features such as view instancing.

See CD3DX12_PIPELINE_STATE_STREAM2 for support for OS Build 19041+ (where there is a mesh shader pipeline).

Syntax

struct CD3DX12_PIPELINE_STATE_STREAM1 {
  CD3DX12_PIPELINE_STATE_STREAM1                      CD3DX12_PIPELINE_STATE_STREAM1();
  CD3DX12_PIPELINE_STATE_STREAM1                      CD3DX12_PIPELINE_STATE_STREAM1(const D3D12_GRAPHICS_PIPELINE_STATE_DESC& Desc);
  CD3DX12_PIPELINE_STATE_STREAM1                      CD3DX12_PIPELINE_STATE_STREAM1(const D3D12_COMPUTE_PIPELINE_STATE_DESC& Desc);
  D3D12_GRAPHICS_PIPELINE_STATE_DESC                  GraphicsDescV0();
  D3D12_COMPUTE_PIPELINE_STATE_DESC                   ComputeDescV0();
  CD3DX12_PIPELINE_STATE_STREAM_FLAGS                 Flags;
  CD3DX12_PIPELINE_STATE_STREAM_NODE_MASK             NodeMask;
  CD3DX12_PIPELINE_STATE_STREAM_ROOT_SIGNATURE        pRootSignature;
  CD3DX12_PIPELINE_STATE_STREAM_INPUT_LAYOUT          InputLayout;
  CD3DX12_PIPELINE_STATE_STREAM_IB_STRIP_CUT_VALUE    IBStripCutValue;
  CD3DX12_PIPELINE_STATE_STREAM_PRIMITIVE_TOPOLOGY    PrimitiveTopologyType;
  CD3DX12_PIPELINE_STATE_STREAM_VS                    VS;
  CD3DX12_PIPELINE_STATE_STREAM_GS                    GS;
  CD3DX12_PIPELINE_STATE_STREAM_STREAM_OUTPUT         StreamOutput;
  CD3DX12_PIPELINE_STATE_STREAM_HS                    HS;
  CD3DX12_PIPELINE_STATE_STREAM_DS                    DS;
  CD3DX12_PIPELINE_STATE_STREAM_PS                    PS;
  CD3DX12_PIPELINE_STATE_STREAM_CS                    CS;
  CD3DX12_PIPELINE_STATE_STREAM_BLEND_DESC            BlendState;
  CD3DX12_PIPELINE_STATE_STREAM_DEPTH_STENCIL1        DepthStencilState;
  CD3DX12_PIPELINE_STATE_STREAM_DEPTH_STENCIL_FORMAT  DSVFormat;
  CD3DX12_PIPELINE_STATE_STREAM_RASTERIZER            RasterizerState;
  CD3DX12_PIPELINE_STATE_STREAM_RENDER_TARGET_FORMATS RTVFormats;
  CD3DX12_PIPELINE_STATE_STREAM_SAMPLE_DESC           SampleDesc;
  CD3DX12_PIPELINE_STATE_STREAM_SAMPLE_MASK           SampleMask;
  CD3DX12_PIPELINE_STATE_STREAM_CACHED_PSO            CachedPSO;
};

Members

CD3DX12_PIPELINE_STATE_STREAM1()

Creates a new, uninitialized, instance of a CD3DX12_PIPELINE_STATE_STREAM1.

CD3DX12_PIPELINE_STATE_STREAM1(const D3D12_GRAPHICS_PIPELINE_STATE_DESC& Desc)

Creates a new instance of a CD3DX12_PIPELINE_STATE_STREAM1, initialized with values copied from a CD3DX12_PIPELINE_STATE_STREAM1 structure.

CD3DX12_PIPELINE_STATE_STREAM1(const D3D12_COMPUTE_PIPELINE_STATE_DESC& Desc)

Creates a new instance of a CD3DX12_PIPELINE_STATE_STREAM1, initialized with values copied from a CD3DX12_PIPELINE_STATE_STREAM1 structure.

GraphicsDescV0()

returns the contents of the CD3DX12_PIPELINE_STATE_STREAM1 object as a D3D12_GRAPHICS_PIPELINE_STATE_DESC structure by value. Note that D3D12_GRAPHICS_PIPELINE_STATE_DESC does not include the CS member, so this value is lost in the conversion.

ComputeDescV0()

returns the contents of the CD3DX12_PIPELINE_STATE_STREAM1 object as a D3D12_COMPUTE_PIPELINE_STATE_DESC structure by value. Note that D3D12_COMPUTE_PIPELINE_STATE_DESC does not include the InputLayout, IBStripCutValue, PrimitiveTopologyType, VS, GS, StreamOutput, HS, DS, PS, BlendState, DepthStencilState, DSVFormat, RasterizerState, NumRootSignature, RTVFormats, SampleDesc, or SampleMask members, so these values are lost in the conversion.

Flags

Describes the pipeline state flags, which control features such as "tool debug".

NodeMask

Describes the pipeline state node mask, which is used to identify the nodes (physical adapters of the device) that the PSO applies to in Multi-Adapter scenarios; each bit in the mask corresponds to a single node. For single-adapter scenarios, set this value to 0.

pRootSignature

Describes the root signature.

InputLayout

Describes the input-buffer format for the input-assembler stage

IBStripCutValue

Describes the special index value of the input buffer that indicates a cut (discontinuity) when using triangle-strip topology.

PrimitiveTopologyType

Describes the primitive topology and its order.

VS

Describes the vertex shader.

GS

Describes the geometry shader.

StreamOutput

Describes the streaming output-buffer.

HS

Describes the hull shader.

DS

Describes the domain shader.

PS

Describes the pixel shader.

CS

Describes the compute shader.

BlendState

Describes the blend state.

DepthStencilState

Describes the depth-stencil state.

DSVFormat

Describes the depth-stencil format.

RasterizerState

Describes the rasterizer state.

RTVFormats

Describes the render target formats.

SampleDesc

Describes the sample count and quality.

SampleMask

Describes the sample mask used with the blend state.

CachedPSO

Describes a cached PSO.

Remarks

CD3DX12_PIPELINE_STATE_STREAM supports the Windows 10 Fall Creators Update, but doesn't support subobject types added in Windows 10 Fall Creators update, such as for view instancing. To support the new subobject types, use CD3DX12_PIPELINE_STATE_STREAM1 instead.

The accessible member variables of this structure are all typedefs of the CD3DX12_PIPELINE_STATE_STREAM_SUBOBJECT template, which combines the subobject type-marker and subobject data into a single object suitable for a stream description.

Requirements

Requirement Value
Header D3dx12.h

See also