Show / Hide Table of Contents

Struct BlendAttachmentDescription

A Pipeline component describing the blend behavior for an individual color attachment.

Implements
System.IEquatable<BlendAttachmentDescription>
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 BlendAttachmentDescription : IEquatable<BlendAttachmentDescription>

Constructors

BlendAttachmentDescription(Boolean, BlendFactor, BlendFactor, BlendFunction, BlendFactor, BlendFactor, BlendFunction)

Constructs a new BlendAttachmentDescription.

Declaration
public BlendAttachmentDescription(bool blendEnabled, BlendFactor sourceColorFactor, BlendFactor destinationColorFactor, BlendFunction colorFunction, BlendFactor sourceAlphaFactor, BlendFactor destinationAlphaFactor, BlendFunction alphaFunction)
Parameters
Type Name Description
System.Boolean blendEnabled

Controls whether blending is enabled for the color attachment.

BlendFactor sourceColorFactor

Controls the source color's influence on the blend result.

BlendFactor destinationColorFactor

Controls the destination color's influence on the blend result.

BlendFunction colorFunction

Controls the function used to combine the source and destination color factors.

BlendFactor sourceAlphaFactor

Controls the source alpha's influence on the blend result.

BlendFactor destinationAlphaFactor

Controls the destination alpha's influence on the blend result.

BlendFunction alphaFunction

Controls the function used to combine the source and destination alpha factors.

Fields

AdditiveBlend

Describes a blend attachment state in which the source is added to the destination based on its alpha channel. Settings: BlendEnabled = true SourceColorFactor = BlendFactor.SourceAlpha DestinationColorFactor = BlendFactor.One ColorFunction = BlendFunction.Add SourceAlphaFactor = BlendFactor.SourceAlpha DestinationAlphaFactor = BlendFactor.One AlphaFunction = BlendFunction.Add

Declaration
public static readonly BlendAttachmentDescription AdditiveBlend
Field Value
Type Description
BlendAttachmentDescription

AlphaBlend

Describes a blend attachment state in which the source and destination are blended in an inverse relationship. Settings: BlendEnabled = true SourceColorFactor = BlendFactor.SourceAlpha DestinationColorFactor = BlendFactor.InverseSourceAlpha ColorFunction = BlendFunction.Add SourceAlphaFactor = BlendFactor.SourceAlpha DestinationAlphaFactor = BlendFactor.InverseSourceAlpha AlphaFunction = BlendFunction.Add

Declaration
public static readonly BlendAttachmentDescription AlphaBlend
Field Value
Type Description
BlendAttachmentDescription

AlphaFunction

Controls the function used to combine the source and destination alpha factors.

Declaration
public BlendFunction AlphaFunction
Field Value
Type Description
BlendFunction

BlendEnabled

Controls whether blending is enabled for the color attachment.

Declaration
public bool BlendEnabled
Field Value
Type Description
System.Boolean

ColorFunction

Controls the function used to combine the source and destination color factors.

Declaration
public BlendFunction ColorFunction
Field Value
Type Description
BlendFunction

DestinationAlphaFactor

Controls the destination alpha's influence on the blend result.

Declaration
public BlendFactor DestinationAlphaFactor
Field Value
Type Description
BlendFactor

DestinationColorFactor

Controls the destination color's influence on the blend result.

Declaration
public BlendFactor DestinationColorFactor
Field Value
Type Description
BlendFactor

Disabled

Describes a blend attachment state in which blending is disabled. Settings: BlendEnabled = false SourceColorFactor = BlendFactor.One DestinationColorFactor = BlendFactor.Zero ColorFunction = BlendFunction.Add SourceAlphaFactor = BlendFactor.One DestinationAlphaFactor = BlendFactor.Zero AlphaFunction = BlendFunction.Add

Declaration
public static readonly BlendAttachmentDescription Disabled
Field Value
Type Description
BlendAttachmentDescription

OverrideBlend

Describes a blend attachment state in which the source completely overrides the destination. Settings: BlendEnabled = true SourceColorFactor = BlendFactor.One DestinationColorFactor = BlendFactor.Zero ColorFunction = BlendFunction.Add SourceAlphaFactor = BlendFactor.One DestinationAlphaFactor = BlendFactor.Zero AlphaFunction = BlendFunction.Add

Declaration
public static readonly BlendAttachmentDescription OverrideBlend
Field Value
Type Description
BlendAttachmentDescription

SourceAlphaFactor

Controls the source alpha's influence on the blend result.

Declaration
public BlendFactor SourceAlphaFactor
Field Value
Type Description
BlendFactor

SourceColorFactor

Controls the source color's influence on the blend result.

Declaration
public BlendFactor SourceColorFactor
Field Value
Type Description
BlendFactor

Methods

Equals(BlendAttachmentDescription)

Element-wise equality.

Declaration
public bool Equals(BlendAttachmentDescription other)
Parameters
Type Name Description
BlendAttachmentDescription 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