1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
// Copyright (c) 2016 The vulkano developers
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>,
// at your option. All files in the project carrying such
// notice may not be copied, modified, or distributed except
// according to those terms.
//! 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.
use crate::{
device::Device,
macros::{vulkan_bitflags, vulkan_enum},
Requires, RequiresAllOf, RequiresOneOf, ValidationError,
};
use std::ops::RangeInclusive;
/// The state in a graphics pipeline describing how the depth, depth bounds and stencil tests
/// should behave.
#[derive(Clone, Debug)]
pub struct DepthStencilState {
/// Additional properties of the depth/stencil state.
///
/// The default value is empty.
pub flags: DepthStencilStateFlags,
/// The state of the depth test.
///
/// If set to `None`, the depth test is disabled, all fragments will pass and no depth writes
/// are performed.
///
/// The default value is `None`.
pub depth: Option<DepthState>,
/// The minimum and maximum depth values to use for the depth bounds test.
/// Fragments with values outside this range are discarded.
///
/// If set to `None`, the depth bounds test is disabled, all fragments will pass.
///
/// The default value is `None`.
pub depth_bounds: Option<RangeInclusive<f32>>,
/// The state of the stencil test.
///
/// If set to `None`, the stencil test is disabled, all fragments will pass and no stencil
/// writes are performed.
///
/// The default value is `None`.
pub stencil: Option<StencilState>,
pub _ne: crate::NonExhaustive,
}
impl Default for DepthStencilState {
#[inline]
fn default() -> Self {
Self {
flags: DepthStencilStateFlags::empty(),
depth: Default::default(),
depth_bounds: Default::default(),
stencil: Default::default(),
_ne: crate::NonExhaustive(()),
}
}
}
impl DepthStencilState {
/// Creates a `DepthStencilState` where all tests are disabled and have no effect.
#[inline]
#[deprecated(since = "0.34.0", note = "use `DepthStencilState::default` instead")]
pub fn disabled() -> Self {
Self::default()
}
/// Creates a `DepthStencilState` with a `Less` depth test, `depth_write` set to true, and other
/// tests disabled.
#[inline]
#[deprecated(since = "0.34.0", note = "use `DepthState::simple` instead")]
pub fn simple_depth_test() -> Self {
Self {
flags: DepthStencilStateFlags::empty(),
depth: Some(DepthState::simple()),
depth_bounds: Default::default(),
stencil: Default::default(),
_ne: crate::NonExhaustive(()),
}
}
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
flags,
ref depth,
ref depth_bounds,
ref stencil,
_ne: _,
} = self;
flags.validate_device(device).map_err(|err| {
err.add_context("flags")
.set_vuids(&["VUID-VkPipelineDepthStencilStateCreateInfo-flags-parameter"])
})?;
if let Some(depth_state) = depth {
depth_state
.validate(device)
.map_err(|err| err.add_context("depth"))?;
}
if let Some(depth_bounds) = depth_bounds {
if !device.enabled_features().depth_bounds {
return Err(Box::new(ValidationError {
context: "depth_bounds".into(),
problem: "is `Some`".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"depth_bounds",
)])]),
vuids: &[
"VUID-VkPipelineDepthStencilStateCreateInfo-depthBoundsTestEnable-00598",
],
}));
}
if !device.enabled_extensions().ext_depth_range_unrestricted {
if !(0.0..1.0).contains(depth_bounds.start()) {
return Err(Box::new(ValidationError {
context: "depth_bounds.start".into(),
problem: "is not between 0.0 and 1.0 inclusive".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[
Requires::DeviceExtension("ext_depth_range_unrestricted"),
])]),
vuids: &["VUID-VkGraphicsPipelineCreateInfo-pDynamicStates-02510"],
}));
}
if !(0.0..1.0).contains(depth_bounds.end()) {
return Err(Box::new(ValidationError {
context: "depth_bounds.end".into(),
problem: "is not between 0.0 and 1.0 inclusive".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[
Requires::DeviceExtension("ext_depth_range_unrestricted"),
])]),
vuids: &["VUID-VkGraphicsPipelineCreateInfo-pDynamicStates-02510"],
}));
}
}
}
if let Some(stencil_state) = stencil {
stencil_state
.validate(device)
.map_err(|err| err.add_context("stencil"))?;
}
Ok(())
}
}
vulkan_bitflags! {
#[non_exhaustive]
/// Flags specifying additional properties of the depth/stencil state.
DepthStencilStateFlags = PipelineDepthStencilStateCreateFlags(u32);
/* TODO: enable
// TODO: document
RASTERIZATION_ORDER_ATTACHMENT_DEPTH_ACCESS = RASTERIZATION_ORDER_ATTACHMENT_DEPTH_ACCESS_EXT
RequiresOneOf([
RequiresAllOf([DeviceExtension(ext_rasterization_order_attachment_access)]),
RequiresAllOf([DeviceExtension(arm_rasterization_order_attachment_access)]),
]), */
/* TODO: enable
// TODO: document
RASTERIZATION_ORDER_ATTACHMENT_STENCIL_ACCESS = RASTERIZATION_ORDER_ATTACHMENT_STENCIL_ACCESS_EXT
RequiresOneOf([
RequiresAllOf([DeviceExtension(ext_rasterization_order_attachment_access)]),
RequiresAllOf([DeviceExtension(arm_rasterization_order_attachment_access)]),
]), */
}
/// The state in a graphics pipeline describing how the depth test should behave when enabled.
#[derive(Clone, Copy, Debug)]
pub struct DepthState {
/// Sets whether the value in the depth buffer will be updated when the depth test succeeds.
///
/// The default value is `false`.
pub write_enable: bool,
/// Comparison operation to use between the depth value of each incoming fragment and the depth
/// value currently in the depth buffer.
///
/// The default value is [`CompareOp::Always`].
pub compare_op: CompareOp,
}
impl Default for DepthState {
#[inline]
fn default() -> Self {
Self {
write_enable: false,
compare_op: CompareOp::Always,
}
}
}
impl DepthState {
/// Returns a `DepthState` with a `Less` depth test and depth writes enabled.
#[inline]
pub fn simple() -> Self {
Self {
compare_op: CompareOp::Less,
write_enable: true,
}
}
pub(crate) fn validate(self, device: &Device) -> Result<(), Box<ValidationError>> {
let Self {
write_enable: _,
compare_op,
} = self;
compare_op.validate_device(device).map_err(|err| {
err.add_context("compare_op")
.set_vuids(&["VUID-VkPipelineDepthStencilStateCreateInfo-depthCompareOp-parameter"])
})?;
Ok(())
}
}
/// The state in a graphics pipeline describing how the stencil test should behave when enabled.
#[derive(Clone, Debug)]
pub struct StencilState {
/// The stencil operation state to use for points and lines, and for triangles whose front is
/// facing the user.
///
/// The default value is `StencilOpState::default()`.
pub front: StencilOpState,
/// The stencil operation state to use for triangles whose back is facing the user.
///
/// The default value is `StencilOpState::default()`.
pub back: StencilOpState,
}
impl Default for StencilState {
#[inline]
fn default() -> Self {
Self {
front: Default::default(),
back: Default::default(),
}
}
}
impl StencilState {
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &StencilState {
ref front,
ref back,
} = self;
front
.ops
.validate(device)
.map_err(|err| err.add_context("front.ops"))?;
back.ops
.validate(device)
.map_err(|err| err.add_context("back.ops"))?;
Ok(())
}
}
/// Stencil test operations for a single face.
#[derive(Clone, Copy, Debug)]
pub struct StencilOpState {
/// The stencil operations to perform.
///
/// The default value is `StencilOps::default()`.
pub ops: StencilOps,
/// A bitmask that selects the bits of the unsigned integer stencil values participating in the
/// stencil test. Ignored if `compare_op` is `Never` or `Always`.
///
/// The default value is [`u32::MAX`].
pub compare_mask: u32,
/// A bitmask that selects the bits of the unsigned integer stencil values updated by the
/// stencil test in the stencil framebuffer attachment. Ignored if the relevant operation is
/// `Keep`.
///
/// The default value is [`u32::MAX`].
pub write_mask: u32,
/// Reference value that is used in the unsigned stencil comparison. The stencil test is
/// considered to pass if the `compare_op` between the stencil buffer value and this reference
/// value yields true.
///
/// On [portability subset](crate::instance#portability-subset-devices-and-the-enumerate_portability-flag)
/// devices, if culling is disabled, and the `reference` values of the front and back face
/// are not equal, then the
/// [`separate_stencil_mask_ref`](crate::device::Features::separate_stencil_mask_ref)
/// feature must be enabled on the device.
///
/// The default value is [`u32::MAX`].
pub reference: u32,
}
impl Default for StencilOpState {
#[inline]
fn default() -> StencilOpState {
StencilOpState {
ops: Default::default(),
compare_mask: u32::MAX,
write_mask: u32::MAX,
reference: u32::MAX,
}
}
}
#[derive(Clone, Copy, Debug)]
pub struct StencilOps {
/// The operation to perform when the stencil test failed.
///
/// The default value is [`StencilOp::Keep`].
pub fail_op: StencilOp,
/// The operation to perform when both the depth test and the stencil test passed.
///
/// The default value is [`StencilOp::Keep`].
pub pass_op: StencilOp,
/// The operation to perform when the stencil test passed but the depth test failed.
///
/// The default value is [`StencilOp::Keep`].
pub depth_fail_op: StencilOp,
/// The comparison to perform between the existing stencil value in the stencil buffer, and
/// the reference value (given by `reference`).
///
/// The default value is [`CompareOp::Never`].
pub compare_op: CompareOp,
}
impl Default for StencilOps {
#[inline]
fn default() -> Self {
Self {
pass_op: StencilOp::Keep,
fail_op: StencilOp::Keep,
depth_fail_op: StencilOp::Keep,
compare_op: CompareOp::Never,
}
}
}
impl StencilOps {
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
fail_op,
pass_op,
depth_fail_op,
compare_op,
} = self;
fail_op.validate_device(device).map_err(|err| {
err.add_context("fail_op")
.set_vuids(&["VUID-VkStencilOpState-failOp-parameter"])
})?;
pass_op.validate_device(device).map_err(|err| {
err.add_context("pass_op")
.set_vuids(&["VUID-VkStencilOpState-passOp-parameter"])
})?;
depth_fail_op.validate_device(device).map_err(|err| {
err.add_context("depth_fail_op")
.set_vuids(&["VUID-VkStencilOpState-depthFailOp-parameter"])
})?;
compare_op.validate_device(device).map_err(|err| {
err.add_context("compare_op")
.set_vuids(&["VUID-VkStencilOpState-compareOp-parameter"])
})?;
Ok(())
}
}
vulkan_enum! {
#[non_exhaustive]
/// Operation to perform after the depth and stencil tests.
StencilOp = StencilOp(i32);
// TODO: document
Keep = KEEP,
// TODO: document
Zero = ZERO,
// TODO: document
Replace = REPLACE,
// TODO: document
IncrementAndClamp = INCREMENT_AND_CLAMP,
// TODO: document
DecrementAndClamp = DECREMENT_AND_CLAMP,
// TODO: document
Invert = INVERT,
// TODO: document
IncrementAndWrap = INCREMENT_AND_WRAP,
// TODO: document
DecrementAndWrap = DECREMENT_AND_WRAP,
}
vulkan_enum! {
#[non_exhaustive]
/// Specifies a face for stencil operations.
StencilFaces = StencilFaceFlags(u32);
// TODO: document
Front = FRONT,
// TODO: document
Back = BACK,
// TODO: document
FrontAndBack = FRONT_AND_BACK,
}
/// Specifies a dynamic state value for the front and back faces.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct DynamicStencilValue {
pub front: u32,
pub back: u32,
}
vulkan_enum! {
#[non_exhaustive]
/// Specifies how two values should be compared to decide whether a test passes or fails.
///
/// Used for both depth testing and stencil testing.
CompareOp = CompareOp(i32);
/// The test never passes.
Never = NEVER,
/// The test passes if `value < reference_value`.
Less = LESS,
/// The test passes if `value == reference_value`.
Equal = EQUAL,
/// The test passes if `value <= reference_value`.
LessOrEqual = LESS_OR_EQUAL,
/// The test passes if `value > reference_value`.
Greater = GREATER,
/// The test passes if `value != reference_value`.
NotEqual = NOT_EQUAL,
/// The test passes if `value >= reference_value`.
GreaterOrEqual = GREATER_OR_EQUAL,
/// The test always passes.
Always = ALWAYS,
}