Struct StencilBehaviorDescription

Describes how stencil tests are performed in a Pipeline's depth-stencil state.

Implements

System.IEquatable<StencilBehaviorDescription>

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 StencilBehaviorDescription : IEquatable<StencilBehaviorDescription>

Constructors

StencilBehaviorDescription(StencilOperation, StencilOperation, StencilOperation, ComparisonKind)

Constructs a new StencilBehaviorDescription.

Declaration

public StencilBehaviorDescription(StencilOperation fail, StencilOperation pass, StencilOperation depthFail, ComparisonKind comparison)

Parameters

Type	Name	Description
StencilOperation	fail	The operation performed on samples that fail the stencil test.
StencilOperation	pass	The operation performed on samples that pass the stencil test.
StencilOperation	depthFail	The operation performed on samples that pass the stencil test but fail the depth test.
ComparisonKind	comparison	The comparison operator used in the stencil test.

Fields

Comparison

The comparison operator used in the stencil test.

Declaration

public ComparisonKind Comparison

Field Value

Type	Description
ComparisonKind

DepthFail

The operation performed on samples that pass the stencil test but fail the depth test.

Declaration

public StencilOperation DepthFail

Field Value

Type	Description
StencilOperation

Fail

The operation performed on samples that fail the stencil test.

Declaration

public StencilOperation Fail

Field Value

Type	Description
StencilOperation

Pass

The operation performed on samples that pass the stencil test.

Declaration

public StencilOperation Pass

Field Value

Type	Description
StencilOperation

Methods

Equals(StencilBehaviorDescription)

Element-wise equality.

Declaration

public bool Equals(StencilBehaviorDescription other)

Parameters

Type	Name	Description
StencilBehaviorDescription	other	The instance to compare to.

Returns

Type	Description
System.Boolean	True if all 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>