Struct StencilBehaviorDescription

Namespace

NeoVeldrid

Assembly

NeoVeldrid.dll

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

public struct StencilBehaviorDescription : IEquatable<StencilBehaviorDescription>

Implements

IEquatable<StencilBehaviorDescription>

Inherited Members

ValueType.Equals(object)

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

StencilBehaviorDescription(StencilOperation, StencilOperation, StencilOperation, ComparisonKind)

Constructs a new StencilBehaviorDescription.

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

Parameters

fail StencilOperation

The operation performed on samples that fail the stencil test.

pass StencilOperation

The operation performed on samples that pass the stencil test.

depthFail StencilOperation

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

comparison ComparisonKind

The comparison operator used in the stencil test.

Fields

Comparison

The comparison operator used in the stencil test.

public ComparisonKind Comparison

Field Value

ComparisonKind

DepthFail

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

public StencilOperation DepthFail

Field Value

StencilOperation

Fail

The operation performed on samples that fail the stencil test.

public StencilOperation Fail

Field Value

StencilOperation

Pass

The operation performed on samples that pass the stencil test.

public StencilOperation Pass

Field Value

StencilOperation

Methods

Equals(StencilBehaviorDescription)

Element-wise equality.

public bool Equals(StencilBehaviorDescription other)

Parameters

other StencilBehaviorDescription

The instance to compare to.

Returns

bool

True if all 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.