RDPipelineDepthStencilState — C# API

class RDPipelineDepthStencilStateReckfellSharpInherits RefCounted

Pipeline depth/stencil state (used by RenderingDevice).

RDPipelineDepthStencilState controls the way depth and stencil comparisons are performed when sampling those values using RenderingDevice.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

RDPipelineDepthStencilStateConstructor

# RDPipelineDepthStencilState

C#
public RDPipelineDepthStencilState();

Properties21

BackOpCompareProperty

# BackOpCompare

C#
public RenderingDevice.CompareOperator BackOpCompare { get; set; }

The method used for comparing the previous back stencil value and RDPipelineDepthStencilState.BackOpReference.

BackOpCompareMaskProperty

# BackOpCompareMask

C#
public uint BackOpCompareMask { get; set; }

Selects which bits from the back stencil value will be compared.

BackOpDepthFailProperty

# BackOpDepthFail

C#
public RenderingDevice.StencilOperation BackOpDepthFail { get; set; }

The operation to perform on the stencil buffer for back pixels that pass the stencil test but fail the depth test.

BackOpFailProperty

# BackOpFail

C#
public RenderingDevice.StencilOperation BackOpFail { get; set; }

The operation to perform on the stencil buffer for back pixels that fail the stencil test.

BackOpPassProperty

# BackOpPass

C#
public RenderingDevice.StencilOperation BackOpPass { get; set; }

The operation to perform on the stencil buffer for back pixels that pass the stencil test.

BackOpReferenceProperty

# BackOpReference

C#
public uint BackOpReference { get; set; }

The value the previous back stencil value will be compared to.

BackOpWriteMaskProperty

# BackOpWriteMask

C#
public uint BackOpWriteMask { get; set; }

Selects which bits from the back stencil value will be changed.

DepthCompareOperatorProperty

# DepthCompareOperator

C#
public RenderingDevice.CompareOperator DepthCompareOperator { get; set; }

The method used for comparing the previous and current depth values.

DepthRangeMaxProperty

# DepthRangeMax

C#
public float DepthRangeMax { get; set; }

The maximum depth that returns true for RDPipelineDepthStencilState.EnableDepthRange.

DepthRangeMinProperty

# DepthRangeMin

C#
public float DepthRangeMin { get; set; }

The minimum depth that returns true for RDPipelineDepthStencilState.EnableDepthRange.

EnableDepthRangeProperty

# EnableDepthRange

C#
public bool EnableDepthRange { get; set; }

If true, each depth value will be tested to see if it is between RDPipelineDepthStencilState.DepthRangeMin and RDPipelineDepthStencilState.DepthRangeMax. If it is outside of these values, it is discarded.

EnableDepthTestProperty

# EnableDepthTest

C#
public bool EnableDepthTest { get; set; }

If true, enables depth testing which allows objects to be automatically occluded by other objects based on their depth. This also allows objects to be partially occluded by other objects. If false, objects will appear in the order they were drawn (like in Reckfell's 2D renderer).

EnableDepthWriteProperty

# EnableDepthWrite

C#
public bool EnableDepthWrite { get; set; }

If true, writes to the depth buffer whenever the depth test returns true. Only works when enable_depth_test is also true.

EnableStencilProperty

# EnableStencil

C#
public bool EnableStencil { get; set; }

If true, enables stencil testing. There are separate stencil buffers for front-facing triangles and back-facing triangles. See properties that begin with "front_op" and properties with "back_op" for each.

FrontOpCompareProperty

# FrontOpCompare

C#
public RenderingDevice.CompareOperator FrontOpCompare { get; set; }

The method used for comparing the previous front stencil value and RDPipelineDepthStencilState.FrontOpReference.

FrontOpCompareMaskProperty

# FrontOpCompareMask

C#
public uint FrontOpCompareMask { get; set; }

Selects which bits from the front stencil value will be compared.

FrontOpDepthFailProperty

# FrontOpDepthFail

C#
public RenderingDevice.StencilOperation FrontOpDepthFail { get; set; }

The operation to perform on the stencil buffer for front pixels that pass the stencil test but fail the depth test.

FrontOpFailProperty

# FrontOpFail

C#
public RenderingDevice.StencilOperation FrontOpFail { get; set; }

The operation to perform on the stencil buffer for front pixels that fail the stencil test.

FrontOpPassProperty

# FrontOpPass

C#
public RenderingDevice.StencilOperation FrontOpPass { get; set; }

The operation to perform on the stencil buffer for front pixels that pass the stencil test.

FrontOpReferenceProperty

# FrontOpReference

C#
public uint FrontOpReference { get; set; }

The value the previous front stencil value will be compared to.

FrontOpWriteMaskProperty

# FrontOpWriteMask

C#
public uint FrontOpWriteMask { get; set; }

Selects which bits from the front stencil value will be changed.

Methods42

GetBackOpCompareRenderingDevice.CompareOperator

# GetBackOpCompare

C#
public RenderingDevice.CompareOperator GetBackOpCompare();

Returns RenderingDevice.CompareOperator

GetBackOpCompareMaskuint

# GetBackOpCompareMask

C#
public uint GetBackOpCompareMask();

Returns uint

GetBackOpDepthFailRenderingDevice.StencilOperation

# GetBackOpDepthFail

C#
public RenderingDevice.StencilOperation GetBackOpDepthFail();

Returns RenderingDevice.StencilOperation

GetBackOpFailRenderingDevice.StencilOperation

# GetBackOpFail

C#
public RenderingDevice.StencilOperation GetBackOpFail();

Returns RenderingDevice.StencilOperation

GetBackOpPassRenderingDevice.StencilOperation

# GetBackOpPass

C#
public RenderingDevice.StencilOperation GetBackOpPass();

Returns RenderingDevice.StencilOperation

GetBackOpReferenceuint

# GetBackOpReference

C#
public uint GetBackOpReference();

Returns uint

GetBackOpWriteMaskuint

# GetBackOpWriteMask

C#
public uint GetBackOpWriteMask();

Returns uint

GetDepthCompareOperatorRenderingDevice.CompareOperator

# GetDepthCompareOperator

C#
public RenderingDevice.CompareOperator GetDepthCompareOperator();

Returns RenderingDevice.CompareOperator

GetDepthRangeMaxfloat

# GetDepthRangeMax

C#
public float GetDepthRangeMax();

Returns float

GetDepthRangeMinfloat

# GetDepthRangeMin

C#
public float GetDepthRangeMin();

Returns float

GetEnableDepthRangebool

# GetEnableDepthRange

C#
public bool GetEnableDepthRange();

Returns bool

GetEnableDepthTestbool

# GetEnableDepthTest

C#
public bool GetEnableDepthTest();

Returns bool

GetEnableDepthWritebool

# GetEnableDepthWrite

C#
public bool GetEnableDepthWrite();

Returns bool

GetEnableStencilbool

# GetEnableStencil

C#
public bool GetEnableStencil();

Returns bool

GetFrontOpCompareRenderingDevice.CompareOperator

# GetFrontOpCompare

C#
public RenderingDevice.CompareOperator GetFrontOpCompare();

Returns RenderingDevice.CompareOperator

GetFrontOpCompareMaskuint

# GetFrontOpCompareMask

C#
public uint GetFrontOpCompareMask();

Returns uint

GetFrontOpDepthFailRenderingDevice.StencilOperation

# GetFrontOpDepthFail

C#
public RenderingDevice.StencilOperation GetFrontOpDepthFail();

Returns RenderingDevice.StencilOperation

GetFrontOpFailRenderingDevice.StencilOperation

# GetFrontOpFail

C#
public RenderingDevice.StencilOperation GetFrontOpFail();

Returns RenderingDevice.StencilOperation

GetFrontOpPassRenderingDevice.StencilOperation

# GetFrontOpPass

C#
public RenderingDevice.StencilOperation GetFrontOpPass();

Returns RenderingDevice.StencilOperation

GetFrontOpReferenceuint

# GetFrontOpReference

C#
public uint GetFrontOpReference();

Returns uint

GetFrontOpWriteMaskuint

# GetFrontOpWriteMask

C#
public uint GetFrontOpWriteMask();

Returns uint

SetBackOpComparevoid

# SetBackOpCompare

C#
public void SetBackOpCompare(RenderingDevice.CompareOperator pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.CompareOperator`	—

SetBackOpCompareMaskvoid

# SetBackOpCompareMask

C#
public void SetBackOpCompareMask(uint pMember);

Parameters
Name	Type	Default
`pMember`	`uint`	—

SetBackOpDepthFailvoid

# SetBackOpDepthFail

C#
public void SetBackOpDepthFail(RenderingDevice.StencilOperation pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.StencilOperation`	—

SetBackOpFailvoid

# SetBackOpFail

C#
public void SetBackOpFail(RenderingDevice.StencilOperation pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.StencilOperation`	—

SetBackOpPassvoid

# SetBackOpPass

C#
public void SetBackOpPass(RenderingDevice.StencilOperation pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.StencilOperation`	—

SetBackOpReferencevoid

# SetBackOpReference

C#
public void SetBackOpReference(uint pMember);

Parameters
Name	Type	Default
`pMember`	`uint`	—

SetBackOpWriteMaskvoid

# SetBackOpWriteMask

C#
public void SetBackOpWriteMask(uint pMember);

Parameters
Name	Type	Default
`pMember`	`uint`	—

SetDepthCompareOperatorvoid

# SetDepthCompareOperator

C#
public void SetDepthCompareOperator(RenderingDevice.CompareOperator pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.CompareOperator`	—

SetDepthRangeMaxvoid

# SetDepthRangeMax

C#
public void SetDepthRangeMax(float pMember);

Parameters
Name	Type	Default
`pMember`	`float`	—

SetDepthRangeMinvoid

# SetDepthRangeMin

C#
public void SetDepthRangeMin(float pMember);

Parameters
Name	Type	Default
`pMember`	`float`	—

SetEnableDepthRangevoid

# SetEnableDepthRange

C#
public void SetEnableDepthRange(bool pMember);

Parameters
Name	Type	Default
`pMember`	`bool`	—

SetEnableDepthTestvoid

# SetEnableDepthTest

C#
public void SetEnableDepthTest(bool pMember);

Parameters
Name	Type	Default
`pMember`	`bool`	—

SetEnableDepthWritevoid

# SetEnableDepthWrite

C#
public void SetEnableDepthWrite(bool pMember);

Parameters
Name	Type	Default
`pMember`	`bool`	—

SetEnableStencilvoid

# SetEnableStencil

C#
public void SetEnableStencil(bool pMember);

Parameters
Name	Type	Default
`pMember`	`bool`	—

SetFrontOpComparevoid

# SetFrontOpCompare

C#
public void SetFrontOpCompare(RenderingDevice.CompareOperator pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.CompareOperator`	—

SetFrontOpCompareMaskvoid

# SetFrontOpCompareMask

C#
public void SetFrontOpCompareMask(uint pMember);

Parameters
Name	Type	Default
`pMember`	`uint`	—

SetFrontOpDepthFailvoid

# SetFrontOpDepthFail

C#
public void SetFrontOpDepthFail(RenderingDevice.StencilOperation pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.StencilOperation`	—

SetFrontOpFailvoid

# SetFrontOpFail

C#
public void SetFrontOpFail(RenderingDevice.StencilOperation pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.StencilOperation`	—

SetFrontOpPassvoid

# SetFrontOpPass

C#
public void SetFrontOpPass(RenderingDevice.StencilOperation pMember);

Parameters
Name	Type	Default
`pMember`	`RenderingDevice.StencilOperation`	—

SetFrontOpReferencevoid

# SetFrontOpReference

C#
public void SetFrontOpReference(uint pMember);

Parameters
Name	Type	Default
`pMember`	`uint`	—

SetFrontOpWriteMaskvoid

# SetFrontOpWriteMask

C#
public void SetFrontOpWriteMask(uint pMember);

Parameters
Name	Type	Default
`pMember`	`uint`	—