DepthStencilStateDescription Struct

    Namespace: Stride.Graphics
    Assembly: Stride.Graphics.dll

    Describes a depth stencil state.

    [DataContract]
public struct DepthStencilStateDescription : IEquatable<DepthStencilStateDescription>
    Name Description
    Constructors
    DepthStencilStateDescription(Boolean, Boolean)

    Initializes a new instance of the DepthStencilStateDescription class.
    Fields
    BackFace

    Identify how to use the results of the depth test and the stencil test for pixels whose surface normal is facing away the camera.
    DepthBufferEnable

    Enables or disables depth buffering. The default is true.
    DepthBufferFunction

    Gets or sets the comparison function for the depth-buffer test. The default is CompareFunction.LessEqual
    DepthBufferWriteEnable

    Enables or disables writing to the depth buffer. The default is true.
    FrontFace

    Identify how to use the results of the depth test and the stencil test for pixels whose surface normal is facing towards the camera.
    StencilEnable

    Gets or sets stencil enabling. The default is false.
    StencilMask

    Gets or sets the mask applied to the reference value and each stencil buffer entry to determine the significant bits for the stencil test. The default mask is byte.MaxValue.
    StencilWriteMask

    Gets or sets the write mask applied to values written into the stencil buffer. The default mask is byte.MaxValue.
    Properties
    Default

    Gets default values for this instance.
    Methods
    Clone()
    Equals(DepthStencilStateDescription)
    Equals(Object)
    GetHashCode()
    SetDefault()

    Sets default values for this instance.
    Operators
    Equality(DepthStencilStateDescription, DepthStencilStateDescription)
    Inequality(DepthStencilStateDescription, DepthStencilStateDescription)
    | Improve this Doc View Source

    Constructors

    DepthStencilStateDescription(Boolean, Boolean)

    Initializes a new instance of the DepthStencilStateDescription class.

    public DepthStencilStateDescription(bool depthEnable, bool depthWriteEnable)
    Parameters
    Type Name Description
    System.Boolean depthEnable
    System.Boolean depthWriteEnable
    | Improve this Doc View Source

    Fields

    BackFace

    Identify how to use the results of the depth test and the stencil test for pixels whose surface normal is facing away the camera.

    public DepthStencilStencilOpDescription BackFace
    Field Value
    Type Description
    DepthStencilStencilOpDescription

    DepthBufferEnable

    Enables or disables depth buffering. The default is true.

    public bool DepthBufferEnable
    Field Value
    Type Description
    System.Boolean

    DepthBufferFunction

    Gets or sets the comparison function for the depth-buffer test. The default is CompareFunction.LessEqual

    public CompareFunction DepthBufferFunction
    Field Value
    Type Description
    CompareFunction

    DepthBufferWriteEnable

    Enables or disables writing to the depth buffer. The default is true.

    public bool DepthBufferWriteEnable
    Field Value
    Type Description
    System.Boolean

    FrontFace

    Identify how to use the results of the depth test and the stencil test for pixels whose surface normal is facing towards the camera.

    public DepthStencilStencilOpDescription FrontFace
    Field Value
    Type Description
    DepthStencilStencilOpDescription

    StencilEnable

    Gets or sets stencil enabling. The default is false.

    public bool StencilEnable
    Field Value
    Type Description
    System.Boolean

    StencilMask

    Gets or sets the mask applied to the reference value and each stencil buffer entry to determine the significant bits for the stencil test. The default mask is byte.MaxValue.

    public byte StencilMask
    Field Value
    Type Description
    System.Byte

    StencilWriteMask

    Gets or sets the write mask applied to values written into the stencil buffer. The default mask is byte.MaxValue.

    public byte StencilWriteMask
    Field Value
    Type Description
    System.Byte
    | Improve this Doc View Source

    Properties

    Default

    Gets default values for this instance.

    public static readonly DepthStencilStateDescription Default { get; }
    Property Value
    Type Description
    DepthStencilStateDescription
    | Improve this Doc View Source

    Methods

    Clone()

    public DepthStencilStateDescription Clone()
    Returns
    Type Description
    DepthStencilStateDescription

    Equals(DepthStencilStateDescription)

    public bool Equals(DepthStencilStateDescription other)
    Parameters
    Type Name Description
    DepthStencilStateDescription other
    Returns
    Type Description
    System.Boolean

    Equals(Object)

    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    GetHashCode()

    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    SetDefault()

    Sets default values for this instance.

    public DepthStencilStateDescription SetDefault()
    Returns
    Type Description
    DepthStencilStateDescription
    | Improve this Doc View Source

    Operators

    Equality(DepthStencilStateDescription, DepthStencilStateDescription)

    public static bool operator ==(DepthStencilStateDescription left, DepthStencilStateDescription right)
    Parameters
    Type Name Description
    DepthStencilStateDescription left
    DepthStencilStateDescription right
    Returns
    Type Description
    System.Boolean

    Inequality(DepthStencilStateDescription, DepthStencilStateDescription)

    public static bool operator !=(DepthStencilStateDescription left, DepthStencilStateDescription right)
    Parameters
    Type Name Description
    DepthStencilStateDescription left
    DepthStencilStateDescription right
    Returns
    Type Description
    System.Boolean

    Inherited Members

    System.ValueType.ToString()

    Extension Methods