Class GorgonStencilOperation
Information used to create the stencil portion of a GorgonDepthStencilState.
Implements
Inherited Members
Namespace: Gorgon.Graphics.Core
Assembly: Gorgon.Graphics.Core.dll
Syntax
public class GorgonStencilOperation : IEquatable<GorgonStencilOperation>Properties
| Edit this page View SourceComparison
Property to set or return the comparison function to use for stencil operations.
Declaration
public Comparison Comparison { get; }Property Value
| Type | Description |
|---|---|
| Comparison |
Remarks
This specifies the function to evaluate with stencil data being read/written and existing stencil data.
The default value is Always.
DepthFailOperation
Property to set or return the operation to perform when the depth testing function fails, but stencil testing passes.
Declaration
public StencilOperation DepthFailOperation { get; }Property Value
| Type | Description |
|---|---|
| StencilOperation |
Remarks
The default value is Keep.
FailOperation
Property to set or return the operation to perform when the stencil testing fails.
Declaration
public StencilOperation FailOperation { get; }Property Value
| Type | Description |
|---|---|
| StencilOperation |
Remarks
The default value is Keep.
PassOperation
Property to set or return the operation to perform when the stencil testing passes.
Declaration
public StencilOperation PassOperation { get; }Property Value
| Type | Description |
|---|---|
| StencilOperation |
Remarks
The default value is Keep.
Methods
| Edit this page View SourceEquals(GorgonStencilOperation)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(GorgonStencilOperation other)Parameters
| Type | Name | Description |
|---|---|---|
| GorgonStencilOperation | other | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the |
Equals(object)
Indicates whether the current object is equal to another object of the same type.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| object | obj | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the |
Overrides
| Edit this page View SourceGetHashCode()
Returns a hash code for this instance.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| int | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. |