Struct DepthStencilStateDescription

Namespace

Pie

Assembly

Pie.dll

Describes how a DepthStencilState should behave.

public struct DepthStencilStateDescription : IEquatable<DepthStencilStateDescription>

Implements

IEquatable<DepthStencilStateDescription>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DepthStencilStateDescription(bool, bool, ComparisonFunc)

Create a new DepthStencilStateDescription, with depth-only parameters.

public DepthStencilStateDescription(bool depthEnabled, bool depthMask, ComparisonFunc depthComparison)

Parameters

depthEnabled bool

Enable/disable depth testing.

depthMask bool

Enable/disable writing to the depth buffer.

depthComparison ComparisonFunc

The depth comparison to use for this depth state.

DepthStencilStateDescription(bool, bool, ComparisonFunc, bool, byte, byte, StencilFace, StencilFace)

Create a new DepthStencilStateDescription.

public DepthStencilStateDescription(bool depthEnabled, bool depthMask, ComparisonFunc depthComparison, bool stencilEnabled, byte stencilReadMask, byte stencilWriteMask, StencilFace stencilFrontFace, StencilFace stencilBackFace)

Parameters

depthEnabled bool

Enable/disable depth testing.

depthMask bool

Enable/disable writing to the depth buffer.

depthComparison ComparisonFunc

The depth comparison to use for this depth state.

stencilEnabled bool

Enable/disable stencil testing.

stencilReadMask byte

The stencil read mask.

stencilWriteMask byte

The stencil write mask.

stencilFrontFace StencilFace

The stencil operations to perform for a front-facing pixel.

stencilBackFace StencilFace

The stencil operations to perform for a back-facing pixel.

DepthStencilStateDescription(bool, byte, byte, StencilFace, StencilFace)

Create a new DepthStencilStateDescription, with stencil-only parameters.

public DepthStencilStateDescription(bool stencilEnabled, byte stencilReadMask, byte stencilWriteMask, StencilFace stencilFrontFace, StencilFace stencilBackFace)

Parameters

stencilEnabled bool

Enable/disable stencil testing.

stencilReadMask byte

The stencil read mask.

stencilWriteMask byte

The stencil write mask.

stencilFrontFace StencilFace

The stencil operations to perform for a front-facing pixel.

stencilBackFace StencilFace

The stencil operations to perform for a back-facing pixel.

Fields

DepthComparison

The depth comparison to use for this depth state.

public ComparisonFunc DepthComparison

Field Value

ComparisonFunc

Describes how a should behave.

DepthEnabled

Enable/disable depth testing.

public bool DepthEnabled

Field Value

bool

Describes how a should behave.

DepthMask

Enable/disable writing to the depth buffer.

public bool DepthMask

Field Value

bool

Describes how a should behave.

Disabled

Disable depth testing.

public static readonly DepthStencilStateDescription Disabled

Field Value

DepthStencilStateDescription

Describes how a should behave.

LessEqual

The depth test passes when the incoming depth value is less than or equal to the stored depth value.

public static readonly DepthStencilStateDescription LessEqual

Field Value

DepthStencilStateDescription

Describes how a should behave.

StencilBackFace

The stencil operations to perform for a back-facing pixel.

public StencilFace StencilBackFace

Field Value

StencilFace

Describes how a should behave.

StencilEnabled

Enable/disable stencil testing.

public bool StencilEnabled

Field Value

bool

Describes how a should behave.

StencilFrontFace

The stencil operations to perform for a front-facing pixel.

public StencilFace StencilFrontFace

Field Value

StencilFace

Describes how a should behave.

StencilReadMask

The stencil read mask.

public byte StencilReadMask

Field Value

byte

Describes how a should behave.

StencilWriteMask

The stencil write mask.

public byte StencilWriteMask

Field Value

byte

Describes how a should behave.

Methods

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.

Operators

operator ==(DepthStencilStateDescription, DepthStencilStateDescription)

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

Parameters

left DepthStencilStateDescription

Describes how a should behave.

right DepthStencilStateDescription

Describes how a should behave.

Returns

bool

Describes how a should behave.

operator !=(DepthStencilStateDescription, DepthStencilStateDescription)

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

Parameters

left DepthStencilStateDescription

Describes how a should behave.

right DepthStencilStateDescription

Describes how a should behave.

Returns

bool

Describes how a should behave.