Struct GLDepthStencilStateDescription
This struct represents all parameters supported in OpenGL for DepthStencilStateDescription.
Namespace: Evergine.OpenGL
Assembly: Evergine.OpenGL.dll
Syntax
public struct GLDepthStencilStateDescription
Constructors
GLDepthStencilStateDescription(ref DepthStencilStateDescription)
Initializes a new instance of the GLDepthStencilStateDescription struct.
Declaration
public GLDepthStencilStateDescription(ref DepthStencilStateDescription description)
Parameters
Type | Name | Description |
---|---|---|
DepthStencilStateDescription | description | Evergine RasterizerStateDescription instance. |
Fields
BackStencilDepthFailOperation
The stencil operation to perform when the stencil test passes and the depth test fails.
Declaration
public StencilOp BackStencilDepthFailOperation
Field Value
Type | Description |
---|---|
StencilOp |
BackStencilFailOperation
The stencil operation to perform when stencil testing fails.
Declaration
public StencilOp BackStencilFailOperation
Field Value
Type | Description |
---|---|
StencilOp |
BackStencilFunction
A function that compares stencil data with existing stencil data.
Declaration
public StencilFunction BackStencilFunction
Field Value
Type | Description |
---|---|
StencilFunction |
BackStencilPassOperation
The stencil operation to perform when both stencil testing and depth testing pass.
Declaration
public StencilOp BackStencilPassOperation
Field Value
Type | Description |
---|---|
StencilOp |
DepthEnable
Enables depth testing.
Declaration
public bool DepthEnable
Field Value
Type | Description |
---|---|
bool |
DepthFunction
A function that compares current depth data with existing depth data.
Declaration
public DepthFunction DepthFunction
Field Value
Type | Description |
---|---|
DepthFunction |
DepthWriteMask
Identifies a portion of the depth-stencil buffer that can be modified by depth data.
Declaration
public bool DepthWriteMask
Field Value
Type | Description |
---|---|
bool |
FrontStencilDepthFailOperation
The stencil operation to perform when stencil testing passes and depth testing fails.
Declaration
public StencilOp FrontStencilDepthFailOperation
Field Value
Type | Description |
---|---|
StencilOp |
FrontStencilFailOperation
Specifies the stencil operation to perform when stencil testing fails.
Declaration
public StencilOp FrontStencilFailOperation
Field Value
Type | Description |
---|---|
StencilOp |
FrontStencilFunction
A function that compares current stencil data with existing stencil data.
Declaration
public StencilFunction FrontStencilFunction
Field Value
Type | Description |
---|---|
StencilFunction |
FrontStencilPassOperation
The stencil operation to perform when both stencil testing and depth testing pass.
Declaration
public StencilOp FrontStencilPassOperation
Field Value
Type | Description |
---|---|
StencilOp |
StencilEnable
Enables stencil testing.
Declaration
public bool StencilEnable
Field Value
Type | Description |
---|---|
bool |
StencilReadMask
Identifies a portion of the depth-stencil buffer for reading stencil data.
Declaration
public byte StencilReadMask
Field Value
Type | Description |
---|---|
byte |
StencilWriteMask
Identifies a portion of the depth-stencil buffer for writing stencil data.
Declaration
public byte StencilWriteMask
Field Value
Type | Description |
---|---|
byte |
Methods
Equals(GLDepthStencilStateDescription)
Returns a hash code for this instance.
Declaration
public bool Equals(GLDepthStencilStateDescription other)
Parameters
Type | Name | Description |
---|---|---|
GLDepthStencilStateDescription | other | The object used for comparison. |
Returns
Type | Description |
---|---|
bool | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. |
Equals(object)
Determines whether the specified object is equal to this instance.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | The object to compare with this instance. |
Returns
Type | Description |
---|---|
bool |
|
Overrides
GetHashCode()
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 such as a hash table. |
Overrides
Operators
operator ==(GLDepthStencilStateDescription, GLDepthStencilStateDescription)
Implements the == operator.
Declaration
public static bool operator ==(GLDepthStencilStateDescription value1, GLDepthStencilStateDescription value2)
Parameters
Type | Name | Description |
---|---|---|
GLDepthStencilStateDescription | value1 | The first value. |
GLDepthStencilStateDescription | value2 | The second value. |
Returns
Type | Description |
---|---|
bool | The result of the operation. |
operator !=(GLDepthStencilStateDescription, GLDepthStencilStateDescription)
Implements the operator ==.
Declaration
public static bool operator !=(GLDepthStencilStateDescription value1, GLDepthStencilStateDescription value2)
Parameters
Type | Name | Description |
---|---|---|
GLDepthStencilStateDescription | value1 | The first value. |
GLDepthStencilStateDescription | value2 | The second value. |
Returns
Type | Description |
---|---|
bool | The result of the operation. |