Enum CompareFunction

Namespace

Stride.Graphics

Assembly

Stride.dll

Comparison options.

[DataContract]
public enum CompareFunction

Fields

Always = 8

Always pass the comparison.

Equal = 3

If the source data is equal to the destination data, the comparison passes.

Greater = 5

If the source data is greater than the destination data, the comparison passes.

GreaterEqual = 7

If the source data is greater than or equal to the destination data, the comparison passes.

Less = 2

If the source data is less than the destination data, the comparison passes.

LessEqual = 4

If the source data is less than or equal to the destination data, the comparison passes.

Never = 1

Never pass the comparison.

NotEqual = 6

If the source data is not equal to the destination data, the comparison passes.

Remarks

A comparison option determines whether how the runtime compares source (new) data against destination (existing) data before storing the new data. The comparison option is declared in a description before an object is created. The API allows you to set a comparison option for a depth-stencil buffer (see IDepthStencilState), depth-stencil operations, or sampler state (see SamplerState).