DepthStencilState object that controls the depth-stencil buffer.
Declaration Syntax| C# |
public class DepthStencilState : RenderState
Members| All Members | Constructors | Methods | Properties | ||
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
DepthStencilState()()()() |
Creates a new instance of DepthStencilState with default values.
|
|
|
DepthStencilState(IRenderSystemProvider) |
Creates a new instance of DepthStencilState with default values.
|
|
|
BindRenderState()()()() |
Binds the render state to the graphics pipeline. This is automatically called the first time the
renderstate is applied or manually called to create the underlying implementation early.
(Overrides RenderState.BindRenderState()()()().) |
|
CounterClockwiseStencilDepthFail |
Gets or sets the stencil operation done when the stencil test passes, but the depth test fails
for a counterclockwise triangle. The default value is Keep.
|
|
|
CounterClockwiseStencilFail |
Gets or sets the stencil operation done when the stencil test fails for
a counterclockwise triangle. The default value is Keep.
|
|
|
CounterClockwiseStencilFunction |
Gets or sets the comparison function used for testing a counterclockwise triangle. The
default value is Always.
|
|
|
CounterClockwiseStencilPass |
Gets or sets the stencil operation done when the stencil test passes for
a counterclockwise triangle. The default value is Keep.
|
|
Default |
Gets a built-in state object where the depth buffer is enabld and writing to it is enabled.
This is the default state.
|
|
|
DepthEnable |
Gets or sets if the depth buffer should be enabled. The default value is true.
|
|
|
DepthFunction |
Gets or sets the depth comparison function for the depth test. The default value
is LessEqual.
|
|
|
DepthWriteEnable |
Gets or sets if the depth buffer should be writable. The default value is true.
|
|
|
DepthWriteOff |
Gets a built-in state object where the depth buffer is enabled and writing to the depth buffer is disabled.
|
|
|
Dispose()()()() |
Dispose the resource.
(Inherited from GraphicsResource.) |
|
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources
(Inherited from GraphicsResource.) |
|
|
Equals(Object) |
(Inherited from Object.) |
|
|
Finalize()()()() |
Releases unmanaged resources and performs other cleanup operations before the
DepthStencilState is reclaimed by garbage collection.
(Overrides GraphicsResource.Finalize()()()().) |
|
|
GetHashCode()()()() |
Returns a hash code for this instance.
(Overrides Object.GetHashCode()()()().) |
|
|
GetType()()()() |
Gets the Type of the current instance. (Inherited from Object.) |
|
|
Implementation |
Gets the API-specific implementation of this resource.
(Overrides GraphicsResource.Implementation.) |
|
|
IsBound |
Get if this render state has been bound to the pipeline.
(Overrides RenderState.IsBound.) |
|
|
IsDisposed |
Gets if the resource's implementation has been disposed.
(Inherited from GraphicsResource.) |
|
|
MemberwiseClone()()()() |
Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
Name |
Get or sets the name of this resource.
(Inherited from GraphicsResource.) |
|
|
None |
Gets a built-in state object where the depth buffer is disabled and writing is disabled.
|
|
|
Read(ISavableReader) |
Deserializes the object and populates it from the input.
(Overrides RenderState.Read(ISavableReader).) |
|
|
ReferenceStencil |
Gets or sets the reference stencil value used for stencil testing. The default valut
is zero.
|
|
|
RenderStateKey |
Gets the RenderStateKey that is used to compare this state
to another state.
(Overrides RenderState.RenderStateKey.) |
|
|
RenderSystem |
Gets or protected sets the render system that created this resource.
(Inherited from GraphicsResource.) |
|
|
ResourceID |
Gets or sets the ResourceID of this resource. Can only be set once, usually by the renderer.
(Inherited from GraphicsResource.) |
|
|
StateType |
Get the enumeration describing this render state.
(Overrides RenderState.StateType.) |
|
|
StencilDepthFail |
Gets or sets the stencil operation done when the stencil test passes but
the depth test fails for a clockwise triangle. The default value is Keep.
|
|
|
StencilEnable |
Gets or sets if the stencil buffer should be enabled. The default value is false.
|
|
|
StencilFail |
Gets or sets the stencil operation done when the stencil test fails
for a clockwise triangle. The default value is Keep.
|
|
|
StencilFunction |
Gets or sets the comparison function used for testing a clockwise triangle. The
default value is Always.
|
|
|
StencilPass |
Gets or sets the stencil operation done when the stencil test passes
for a clockwise triangle. The default value is Keep.
|
|
|
StencilReadMask |
Gets or sets the value that identifies a portion of the depth-stencil buffer for reading stencil data.
The default value is MaxValue.
|
|
|
StencilWriteMask |
Gets or sets the value that identifies a portion of the depth-stencil buffer for writing stencil data.
The default value is MaxValue.
|
|
|
ToString()()()() |
(Inherited from Object.) |
|
|
TwoSidedStencilEnable |
Gets or sets if two sided stenciling should be enabled, that is if counterclockwise
stencil testing/operations should be conducted. The default value is false.
|
|
|
Write(ISavableWriter) |
Serializes the object and writes it to the output.
(Overrides RenderState.Write(ISavableWriter).) |
Inheritance Hierarchy| Object | |||
|
GraphicsResource | ||
|
|
RenderState | ||
|
|
DepthStencilState | ||
Assembly: Tesla (Module: Tesla) Version: 0.5.0.0 (0.5.0.0)