StencilFlags Structure |
Specifies state information used to configure rendering operations.
Namespace: Internal.SharpBgfx
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2024.1.1.0 (2024.1.1.0)
SyntaxC#
public struct StencilFlags : IEquatable<StencilFlags>
The StencilFlags type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StencilFlags |
Initializes a new instance of the StencilFlags struct.
|
Methods| Name | Description | |
|---|---|---|
| Equals(Object) |
Determines whether the specified Object is equal to this instance.
(Overrides ValueTypeEquals(Object).) |
| Equals(StencilFlags) |
Determines whether the specific value is equal to this instance.
|
| GetHashCode |
Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | ReadMask |
Encodes a read mask in a stencil state.
|
| ReferenceValue |
Encodes a reference value in a stencil state.
|
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
Operators| Name | Description | |
|---|---|---|
 | BitwiseAnd |
Implements the bitwise-and operator.
|
| BitwiseOr |
Implements the bitwise-or operator.
|
| Equality |
Implements the equality operator.
|
| (StencilFlags to UInt32) |
Performs an explicit conversion to uint.
|
| (UInt32 to StencilFlags) |
Performs an implicit conversion from uint.
|
| Inequality |
Implements the inequality operator.
|
| LeftShift |
Implements the left shift operator.
|
| OnesComplement |
Implements the bitwise-complement operator.
|
| RightShift |
Implements the right shift operator.
|
Fields| Name | Description | |
|---|---|---|
 | FailSDecrement |
On failing the stencil test, decrement the stencil value.
|
| FailSDecrementSaturate |
On failing the stencil test, decrement the stencil value (with saturation).
|
| FailSIncrement |
On failing the stencil test, increment the stencil value.
|
| FailSIncrementSaturate |
On failing the stencil test, increment the stencil value (with saturation).
|
| FailSInvert |
On failing the stencil test, invert the stencil value.
|
| FailSKeep |
On failing the stencil test, keep the old stencil value.
|
| FailSReplace |
On failing the stencil test, replace the stencil value.
|
| FailSZero |
On failing the stencil test, zero out the stencil value.
|
| FailZDecrement |
On failing the stencil test, decrement the depth value.
|
| FailZDecrementSaturate |
On failing the stencil test, decrement the depth value (with saturation).
|
| FailZIncrement |
On failing the stencil test, increment the depth value.
|
| FailZIncrementSaturate |
On failing the stencil test, increment the depth value (with saturation).
|
| FailZInvert |
On failing the stencil test, invert the depth value.
|
| FailZKeep |
On failing the stencil test, keep the depth value.
|
| FailZReplace |
On failing the stencil test, replace the depth value.
|
| FailZZero |
On failing the stencil test, zero out the depth value.
|
| None |
No state bits set.
|
| PassZDecrement |
On passing the stencil test, decrement the depth value.
|
| PassZDecrementSaturate |
On passing the stencil test, decrement the depth value (with saturation).
|
| PassZIncrement |
On passing the stencil test, increment the depth value.
|
| PassZIncrementSaturate |
On passing the stencil test, increment the depth value (with saturation).
|
| PassZInvert |
On passing the stencil test, invert the depth value.
|
| PassZKeep |
On passing the stencil test, keep the old depth value.
|
| PassZReplace |
On passing the stencil test, replace the depth value.
|
| PassZZero |
On passing the stencil test, zero out the depth value.
|
| TestAlways |
Always pass the stencil test.
|
| TestEqual |
Perform an equality stencil test.
|
| TestGreater |
Perform a "greater than" stencil test.
|
| TestGreaterEqual |
Perform a "greater than or equal" stencil test.
|
| TestLess |
Perform a "less than" stencil test.
|
| TestLessEqual |
Perform a "less than or equal" stencil test.
|
| TestNever |
Never pass the stencil test.
|
| TestNotEqual |
Perform an inequality stencil test.
|
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx.) |
| PropertyGet(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertyGetT(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx.) |
See Also