Module vulkano::pipeline::graphics::depth_stencil

Configures the operation of the depth, stencil and depth bounds tests.

The depth test passes of fails depending on how the depth value of each fragment compares to the existing depth value in the depth buffer at that fragment’s location. Depth values are always between 0.0 and 1.0.

The depth bounds test allows you to ask the GPU to exclude fragments that are outside of a certain range. This is done in addition to the regular depth test.

The stencil test passes or fails depending on how a reference value compares to the existing value in the stencil buffer at each fragment’s location. Depending on the outcome of the depth and stencil tests, the value of the stencil buffer at that location can be updated.

Structs

• DepthState
  The state in a graphics pipeline describing how the depth test should behave when enabled.
• DepthStencilState
  The state in a graphics pipeline describing how the depth, depth bounds and stencil tests should behave.
• DepthStencilStateFlags
  Flags specifying additional properties of the depth/stencil state.
• DynamicStencilValue
  Specifies a dynamic state value for the front and back faces.
• StencilOpState
  Stencil test operations for a single face.
• StencilOps
• StencilState
  The state in a graphics pipeline describing how the stencil test should behave when enabled.

Enums

• CompareOp
  Specifies how two values should be compared to decide whether a test passes or fails.
• StencilFaces
  Specifies a face for stencil operations.
• StencilOp
  Operation to perform after the depth and stencil tests.