Struct DepthStencilStateDescription

Namespace

Stride.Graphics

Assembly

Stride.Graphics.dll

Describes a depth stencil state.

[DataContract]
public struct DepthStencilStateDescription : IEquatable<DepthStencilStateDescription>

Implements

IEquatable<DepthStencilStateDescription>

Inherited Members

ValueType.ToString()

Constructors

DepthStencilStateDescription(bool, bool)

Initializes a new instance of the DepthStencilStateDescription class.

public DepthStencilStateDescription(bool depthEnable, bool depthWriteEnable)

Parameters

depthEnable bool

depthWriteEnable bool

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

DepthStencilStencilOpDescription

DepthBufferEnable

Enables or disables depth buffering. The default is true.

public bool DepthBufferEnable

Field Value

bool

DepthBufferFunction

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

public CompareFunction DepthBufferFunction

Field Value

CompareFunction

DepthBufferWriteEnable

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

public bool DepthBufferWriteEnable

Field Value

bool

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

DepthStencilStencilOpDescription

StencilEnable

Gets or sets stencil enabling. The default is false.

public bool StencilEnable

Field Value

bool

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

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

byte

Properties

Default

Gets default values for this instance.

public static DepthStencilStateDescription Default { get; }

Property Value

DepthStencilStateDescription

Methods

Clone()

public DepthStencilStateDescription Clone()

Returns

DepthStencilStateDescription

Equals(DepthStencilStateDescription)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(DepthStencilStateDescription other)

Parameters

other DepthStencilStateDescription

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

SetDefault()

Sets default values for this instance.

public DepthStencilStateDescription SetDefault()

Returns

DepthStencilStateDescription

Operators

operator ==(DepthStencilStateDescription, DepthStencilStateDescription)

public static bool operator ==(DepthStencilStateDescription left, DepthStencilStateDescription right)

Parameters

left DepthStencilStateDescription

right DepthStencilStateDescription

Returns

bool

operator !=(DepthStencilStateDescription, DepthStencilStateDescription)

public static bool operator !=(DepthStencilStateDescription left, DepthStencilStateDescription right)

Parameters

left DepthStencilStateDescription

right DepthStencilStateDescription

Returns

bool