Struct GraphicsPipelineDescription

Namespace

NeoVeldrid

Assembly

NeoVeldrid.dll

Describes a graphics Pipeline, for creation using a ResourceFactory.

public struct GraphicsPipelineDescription : IEquatable<GraphicsPipelineDescription>

Implements

IEquatable<GraphicsPipelineDescription>

Inherited Members

ValueType.Equals(object)

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

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

Constructs a new GraphicsPipelineDescription.

public GraphicsPipelineDescription(BlendStateDescription blendState, DepthStencilStateDescription depthStencilStateDescription, RasterizerStateDescription rasterizerState, PrimitiveTopology primitiveTopology, ShaderSetDescription shaderSet, ResourceLayout resourceLayout, OutputDescription outputs)

Parameters

blendState BlendStateDescription

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.

rasterizerState RasterizerStateDescription

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.

shaderSet ShaderSetDescription

A description of the shader set to be used.

resourceLayout ResourceLayout

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

outputs OutputDescription

A description of the output attachments used by the Pipeline.

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

Constructs a new GraphicsPipelineDescription.

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

Parameters

blendState BlendStateDescription

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.

rasterizerState RasterizerStateDescription

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.

shaderSet ShaderSetDescription

A description of the shader set to be used.

resourceLayouts ResourceLayout[]

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

outputs OutputDescription

A description of the output attachments used by the Pipeline.

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

Constructs a new GraphicsPipelineDescription.

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

Parameters

blendState BlendStateDescription

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.

rasterizerState RasterizerStateDescription

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.

shaderSet ShaderSetDescription

A description of the shader set to be used.

resourceLayouts ResourceLayout[]

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

outputs OutputDescription

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.

public BlendStateDescription BlendState

Field Value

BlendStateDescription

DepthStencilState

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

public DepthStencilStateDescription DepthStencilState

Field Value

DepthStencilStateDescription

Outputs

A description of the output attachments used by the Pipeline.

public OutputDescription Outputs

Field Value

OutputDescription

PrimitiveTopology

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

public PrimitiveTopology PrimitiveTopology

Field Value

PrimitiveTopology

RasterizerState

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

public RasterizerStateDescription RasterizerState

Field Value

RasterizerStateDescription

ResourceBindingModel

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

null

, the pipeline will use the value specified in GraphicsDeviceOptions.

public ResourceBindingModel? ResourceBindingModel

Field Value

ResourceBindingModel?

ResourceLayouts

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

public ResourceLayout[] ResourceLayouts

Field Value

ResourceLayout[]

ShaderSet

A description of the shader set to be used.

public ShaderSetDescription ShaderSet

Field Value

ShaderSetDescription

Methods

Equals(GraphicsPipelineDescription)

Element-wise equality.

public bool Equals(GraphicsPipelineDescription other)

Parameters

other GraphicsPipelineDescription

The instance to compare to.

Returns

bool

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

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

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