Show / Hide Table of Contents

Struct GraphicsPipelineDescription

Describes a graphics Pipeline, for creation using a ResourceFactory.

Implements
System.IEquatable<GraphicsPipelineDescription>
Inherited Members
System.ValueType.Equals(System.Object)
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
Namespace: Veldrid
Assembly: cs.temp.dll.dll
Syntax
public struct GraphicsPipelineDescription : IEquatable<GraphicsPipelineDescription>

Constructors

GraphicsPipelineDescription(BlendStateDescription, DepthStencilStateDescription, RasterizerStateDescription, PrimitiveTopology, ShaderSetDescription, ResourceLayout, OutputDescription)

Constructs a new GraphicsPipelineDescription.

Declaration
public GraphicsPipelineDescription(BlendStateDescription blendState, DepthStencilStateDescription depthStencilStateDescription, RasterizerStateDescription rasterizerState, PrimitiveTopology primitiveTopology, ShaderSetDescription shaderSet, ResourceLayout resourceLayout, OutputDescription outputs)
Parameters
Type Name Description
BlendStateDescription blendState

A description of the blend state, which controls how color values are blended into each color target.

DepthStencilStateDescription depthStencilStateDescription

A description of the depth stencil state, which controls depth tests, writing, and comparisons.

RasterizerStateDescription rasterizerState

A description of the rasterizer state, which controls culling, clipping, scissor, and polygon-fill behavior.

PrimitiveTopology primitiveTopology

The PrimitiveTopology to use, which controls how a series of input vertices is interpreted by the Pipeline.

ShaderSetDescription shaderSet

A description of the shader set to be used.

ResourceLayout resourceLayout

A ResourceLayout, which controls the layout of shader resoruces in the Pipeline.

OutputDescription outputs

A description of the output attachments used by the Pipeline.

GraphicsPipelineDescription(BlendStateDescription, DepthStencilStateDescription, RasterizerStateDescription, PrimitiveTopology, ShaderSetDescription, ResourceLayout[], OutputDescription)

Constructs a new GraphicsPipelineDescription.

Declaration
public GraphicsPipelineDescription(BlendStateDescription blendState, DepthStencilStateDescription depthStencilStateDescription, RasterizerStateDescription rasterizerState, PrimitiveTopology primitiveTopology, ShaderSetDescription shaderSet, ResourceLayout[] resourceLayouts, OutputDescription outputs)
Parameters
Type Name Description
BlendStateDescription blendState

A description of the blend state, which controls how color values are blended into each color target.

DepthStencilStateDescription depthStencilStateDescription

A description of the depth stencil state, which controls depth tests, writing, and comparisons.

RasterizerStateDescription rasterizerState

A description of the rasterizer state, which controls culling, clipping, scissor, and polygon-fill behavior.

PrimitiveTopology primitiveTopology

The PrimitiveTopology to use, which controls how a series of input vertices is interpreted by the Pipeline.

ShaderSetDescription shaderSet

A description of the shader set to be used.

ResourceLayout[] resourceLayouts

An array of ResourceLayout, which controls the layout of shader resoruces in the Pipeline.

OutputDescription outputs

A description of the output attachments used by the Pipeline.

GraphicsPipelineDescription(BlendStateDescription, DepthStencilStateDescription, RasterizerStateDescription, PrimitiveTopology, ShaderSetDescription, ResourceLayout[], OutputDescription, ResourceBindingModel)

Constructs a new GraphicsPipelineDescription.

Declaration
public GraphicsPipelineDescription(BlendStateDescription blendState, DepthStencilStateDescription depthStencilStateDescription, RasterizerStateDescription rasterizerState, PrimitiveTopology primitiveTopology, ShaderSetDescription shaderSet, ResourceLayout[] resourceLayouts, OutputDescription outputs, ResourceBindingModel resourceBindingModel)
Parameters
Type Name Description
BlendStateDescription blendState

A description of the blend state, which controls how color values are blended into each color target.

DepthStencilStateDescription depthStencilStateDescription

A description of the depth stencil state, which controls depth tests, writing, and comparisons.

RasterizerStateDescription rasterizerState

A description of the rasterizer state, which controls culling, clipping, scissor, and polygon-fill behavior.

PrimitiveTopology primitiveTopology

The PrimitiveTopology to use, which controls how a series of input vertices is interpreted by the Pipeline.

ShaderSetDescription shaderSet

A description of the shader set to be used.

ResourceLayout[] resourceLayouts

An array of ResourceLayout, which controls the layout of shader resoruces in the Pipeline.

OutputDescription outputs

A description of the output attachments used by the Pipeline.

ResourceBindingModel resourceBindingModel

The ResourceBindingModel to use for this pipeline. Overrides the value specified in GraphicsDeviceOptions.

Fields

BlendState

A description of the blend state, which controls how color values are blended into each color target.

Declaration
public BlendStateDescription BlendState
Field Value
Type Description
BlendStateDescription

DepthStencilState

A description of the depth stencil state, which controls depth tests, writing, and comparisons.

Declaration
public DepthStencilStateDescription DepthStencilState
Field Value
Type Description
DepthStencilStateDescription

Outputs

A description of the output attachments used by the Pipeline.

Declaration
public OutputDescription Outputs
Field Value
Type Description
OutputDescription

PrimitiveTopology

The PrimitiveTopology to use, which controls how a series of input vertices is interpreted by the Pipeline.

Declaration
public PrimitiveTopology PrimitiveTopology
Field Value
Type Description
PrimitiveTopology

RasterizerState

A description of the rasterizer state, which controls culling, clipping, scissor, and polygon-fill behavior.

Declaration
public RasterizerStateDescription RasterizerState
Field Value
Type Description
RasterizerStateDescription

ResourceBindingModel

Specifies which model the rendering backend should use for binding resources. If

null
, the pipeline will use the value specified in GraphicsDeviceOptions.

Declaration
public ResourceBindingModel? ResourceBindingModel
Field Value
Type Description
System.Nullable<ResourceBindingModel>

ResourceLayouts

An array of ResourceLayout, which controls the layout of shader resources in the Pipeline.

Declaration
public ResourceLayout[] ResourceLayouts
Field Value
Type Description
ResourceLayout[]

ShaderSet

A description of the shader set to be used.

Declaration
public ShaderSetDescription ShaderSet
Field Value
Type Description
ShaderSetDescription

Methods

Equals(GraphicsPipelineDescription)

Element-wise equality.

Declaration
public bool Equals(GraphicsPipelineDescription other)
Parameters
Type Name Description
GraphicsPipelineDescription other

The instance to compare to.

Returns
Type Description
System.Boolean

True if all elements and all array elements are equal; false otherswise.

GetHashCode()

Returns the hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

A 32-bit signed integer that is the hash code for this instance.

Overrides
System.ValueType.GetHashCode()

Implements

System.IEquatable<T>
Back to top