Struct DepthStencilStateDescription

Describes depth-stencil state.

Implements

IEquatable<DepthStencilStateDescription>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Evergine.Common.Graphics

Assembly: Evergine.Common.dll

Syntax

public struct DepthStencilStateDescription : IEquatable<DepthStencilStateDescription>

Fields

BackFace

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

Declaration

public DepthStencilOperationDescription BackFace

Field Value

Type	Description
DepthStencilOperationDescription

DepthEnable

Enable depth testing.

Declaration

public bool DepthEnable

Field Value

Type	Description
bool

DepthFunction

A function that compares depth data against existing depth data.

Declaration

public ComparisonFunction DepthFunction

Field Value

Type	Description
ComparisonFunction

DepthWriteMask

Identify a portion of the depth-stencil buffer that can be modified by depth data.

Declaration

public bool DepthWriteMask

Field Value

Type	Description
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.

Declaration

public DepthStencilOperationDescription FrontFace

Field Value

Type	Description
DepthStencilOperationDescription

StencilEnable

Enable stencil testing.

Declaration

public bool StencilEnable

Field Value

Type	Description
bool

StencilReadMask

Identify a portion of the depth-stencil buffer for reading stencil data.

Declaration

public byte StencilReadMask

Field Value

Type	Description
byte

StencilWriteMask

Identify a portion of the depth-stencil buffer for writing stencil data.

Declaration

public byte StencilWriteMask

Field Value

Type	Description
byte

Properties

Default

Gets default values for DephtStencilStateDescription.

Declaration

public static DepthStencilStateDescription Default { get; }

Property Value

Type	Description
DepthStencilStateDescription

Methods

Equals(DepthStencilStateDescription)

Returns a hash code for this instance.

Declaration

public bool Equals(DepthStencilStateDescription other)

Parameters

Type	Name	Description
DepthStencilStateDescription	other	Other used to compare.

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	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

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 like a hash table.

Overrides

ValueType.GetHashCode()

SetDefault()

Default DephtStencilStateDescription values.

Declaration

public void SetDefault()

Operators

operator ==(DepthStencilStateDescription, DepthStencilStateDescription)

Implements the operator ==.

Declaration

public static bool operator ==(DepthStencilStateDescription value1, DepthStencilStateDescription value2)

Parameters

Type	Name	Description
DepthStencilStateDescription	value1	The value1.
DepthStencilStateDescription	value2	The value2.

Returns

Type	Description
bool	The result of the operator.

operator !=(DepthStencilStateDescription, DepthStencilStateDescription)

Implements the operator ==.

Declaration

public static bool operator !=(DepthStencilStateDescription value1, DepthStencilStateDescription value2)

Parameters

Type	Name	Description
DepthStencilStateDescription	value1	The value1.
DepthStencilStateDescription	value2	The value2.

Returns

Type	Description
bool	The result of the operator.

Implements

IEquatable<T>

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)