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 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
//! Graphics pipeline types
use {
super::{
device::Device,
image::SampleCount,
merge_push_constant_ranges,
shader::{DescriptorBindingMap, PipelineDescriptorInfo, Shader, SpecializationInfo},
DriverError,
},
ash::vk,
derive_builder::{Builder, UninitializedFieldError},
log::{trace, warn},
ordered_float::OrderedFloat,
std::{collections::HashSet, ffi::CString, sync::Arc, thread::panicking},
};
const RGBA_COLOR_COMPONENTS: vk::ColorComponentFlags = vk::ColorComponentFlags::from_raw(
vk::ColorComponentFlags::R.as_raw()
| vk::ColorComponentFlags::G.as_raw()
| vk::ColorComponentFlags::B.as_raw()
| vk::ColorComponentFlags::A.as_raw(),
);
/// Specifies color blend state used when rasterization is enabled for any color attachments
/// accessed during rendering.
///
/// See
/// [VkPipelineColorBlendAttachmentState](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkPipelineColorBlendAttachmentState.html).
#[derive(Builder, Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[builder(
build_fn(private, name = "fallible_build", error = "BlendModeBuilderError"),
derive(Clone, Copy, Debug),
pattern = "owned"
)]
pub struct BlendMode {
/// Controls whether blending is enabled for the corresponding color attachment.
///
/// If blending is not enabled, the source fragment’s color for that attachment is passed
/// through unmodified.
#[builder(default = "false")]
pub blend_enable: bool,
/// Selects which blend factor is used to determine the source factors.
#[builder(default = "vk::BlendFactor::SRC_COLOR")]
pub src_color_blend_factor: vk::BlendFactor,
/// Selects which blend factor is used to determine the destination factors.
#[builder(default = "vk::BlendFactor::ONE_MINUS_DST_COLOR")]
pub dst_color_blend_factor: vk::BlendFactor,
/// Selects which blend operation is used to calculate the RGB values to write to the color
/// attachment.
#[builder(default = "vk::BlendOp::ADD")]
pub color_blend_op: vk::BlendOp,
/// Selects which blend factor is used to determine the source factor.
#[builder(default = "vk::BlendFactor::ZERO")]
pub src_alpha_blend_factor: vk::BlendFactor,
/// Selects which blend factor is used to determine the destination factor.
#[builder(default = "vk::BlendFactor::ZERO")]
pub dst_alpha_blend_factor: vk::BlendFactor,
/// Selects which blend operation is used to calculate the alpha values to write to the color
/// attachment.
#[builder(default = "vk::BlendOp::ADD")]
pub alpha_blend_op: vk::BlendOp,
/// A bitmask of specifying which of the R, G, B, and/or A components are enabled for writing,
/// as described for the
/// [Color Write Mask](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#framebuffer-color-write-mask).
#[builder(default = "RGBA_COLOR_COMPONENTS")]
pub color_write_mask: vk::ColorComponentFlags,
}
impl BlendMode {
/// A commonly used blend mode for replacing color attachment values with new ones.
pub const REPLACE: Self = Self {
blend_enable: false,
src_color_blend_factor: vk::BlendFactor::SRC_COLOR,
dst_color_blend_factor: vk::BlendFactor::ONE_MINUS_DST_COLOR,
color_blend_op: vk::BlendOp::ADD,
src_alpha_blend_factor: vk::BlendFactor::ZERO,
dst_alpha_blend_factor: vk::BlendFactor::ZERO,
alpha_blend_op: vk::BlendOp::ADD,
color_write_mask: RGBA_COLOR_COMPONENTS,
};
/// A commonly used blend mode for blending color attachment values based on the alpha channel.
pub const ALPHA: Self = Self {
blend_enable: true,
src_color_blend_factor: vk::BlendFactor::SRC_ALPHA,
dst_color_blend_factor: vk::BlendFactor::ONE_MINUS_SRC_ALPHA,
color_blend_op: vk::BlendOp::ADD,
src_alpha_blend_factor: vk::BlendFactor::SRC_ALPHA,
dst_alpha_blend_factor: vk::BlendFactor::ONE_MINUS_SRC_ALPHA,
alpha_blend_op: vk::BlendOp::ADD,
color_write_mask: RGBA_COLOR_COMPONENTS,
};
/// A commonly used blend mode for blending color attachment values based on the alpha channel,
/// where the color components have been pre-multiplied with the alpha component value.
pub const PRE_MULTIPLIED_ALPHA: Self = Self {
blend_enable: true,
src_color_blend_factor: vk::BlendFactor::SRC_ALPHA,
dst_color_blend_factor: vk::BlendFactor::ONE_MINUS_SRC_ALPHA,
color_blend_op: vk::BlendOp::ADD,
src_alpha_blend_factor: vk::BlendFactor::ONE,
dst_alpha_blend_factor: vk::BlendFactor::ONE,
alpha_blend_op: vk::BlendOp::ADD,
color_write_mask: RGBA_COLOR_COMPONENTS,
};
/// Specifies a default blend mode which is not enabled.
#[allow(clippy::new_ret_no_self)]
pub fn new() -> BlendModeBuilder {
BlendModeBuilder::default()
}
pub(super) fn into_vk(self) -> vk::PipelineColorBlendAttachmentState {
vk::PipelineColorBlendAttachmentState {
blend_enable: if self.blend_enable {
vk::TRUE
} else {
vk::FALSE
},
src_color_blend_factor: self.src_color_blend_factor,
dst_color_blend_factor: self.dst_color_blend_factor,
color_blend_op: self.color_blend_op,
src_alpha_blend_factor: self.src_alpha_blend_factor,
dst_alpha_blend_factor: self.dst_alpha_blend_factor,
alpha_blend_op: self.alpha_blend_op,
color_write_mask: self.color_write_mask,
}
}
}
// the Builder derive Macro wants Default to be implemented for BlendMode
impl Default for BlendMode {
fn default() -> Self {
Self::REPLACE
}
}
// HACK: https://github.com/colin-kiegel/rust-derive-builder/issues/56
impl BlendModeBuilder {
/// Builds a new `BlendMode`.
pub fn build(self) -> BlendMode {
self.fallible_build().unwrap()
}
}
#[derive(Debug)]
struct BlendModeBuilderError;
impl From<UninitializedFieldError> for BlendModeBuilderError {
fn from(_: UninitializedFieldError) -> Self {
Self
}
}
/// Specifies the [depth bounds tests], [stencil test], and [depth test] pipeline state.
///
/// [depth bounds tests]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-dbt
/// [stencil test]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-stencil
/// [depth test]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-depth
#[derive(Builder, Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[builder(
build_fn(
private,
name = "fallible_build",
error = "DepthStencilModeBuilderError"
),
derive(Clone, Copy, Debug),
pattern = "owned"
)]
pub struct DepthStencilMode {
/// Control parameters of the stencil test.
pub back: StencilMode,
/// Controls whether [depth bounds testing] is enabled.
///
/// [depth bounds testing]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-dbt
pub bounds_test: bool,
/// A value specifying the comparison operator to use in the [depth comparison] step of the
/// [depth test].
///
/// [depth comparison]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-depth-comparison
/// [depth test]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-depth
pub compare_op: vk::CompareOp,
/// Controls whether [depth testing] is enabled.
///
/// [depth testing]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-depth
pub depth_test: bool,
/// Controls whether [depth writes] are enabled when `depth_test` is `true`.
///
/// Depth writes are always disabled when `depth_test` is `false`.
///
/// [depth writes]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-depth-write
pub depth_write: bool,
/// Control parameters of the stencil test.
pub front: StencilMode,
// Note: Using setter(into) so caller does not need our version of OrderedFloat
/// Minimum depth bound used in the [depth bounds test].
///
/// [depth bounds test]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-dbt
#[builder(setter(into))]
pub min: OrderedFloat<f32>,
// Note: Using setter(into) so caller does not need our version of OrderedFloat
/// Maximum depth bound used in the [depth bounds test].
///
/// [depth bounds test]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-dbt
#[builder(setter(into))]
pub max: OrderedFloat<f32>,
/// Controls whether [stencil testing] is enabled.
///
/// [stencil testing]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-stencil
pub stencil_test: bool,
}
impl DepthStencilMode {
/// A commonly used depth/stencil mode
pub const DEPTH_READ: Self = Self {
back: StencilMode::IGNORE,
bounds_test: true,
compare_op: vk::CompareOp::LESS,
depth_test: true,
depth_write: false,
front: StencilMode::IGNORE,
min: OrderedFloat(0.0),
max: OrderedFloat(1.0),
stencil_test: false,
};
/// A commonly used depth/stencil mode
pub const DEPTH_WRITE: Self = Self {
back: StencilMode::IGNORE,
bounds_test: true,
compare_op: vk::CompareOp::LESS,
depth_test: true,
depth_write: true,
front: StencilMode::IGNORE,
min: OrderedFloat(0.0),
max: OrderedFloat(1.0),
stencil_test: false,
};
/// Specifies a no-depth/no-stencil mode.
pub const IGNORE: Self = Self {
back: StencilMode::IGNORE,
bounds_test: false,
compare_op: vk::CompareOp::NEVER,
depth_test: false,
depth_write: false,
front: StencilMode::IGNORE,
min: OrderedFloat(0.0),
max: OrderedFloat(0.0),
stencil_test: false,
};
/// Specifies a default depth/stencil mode which is equal to [`DepthStencilMode::IGNORE`].
#[allow(clippy::new_ret_no_self)]
pub fn new() -> DepthStencilModeBuilder {
DepthStencilModeBuilder::default()
}
pub(super) fn into_vk(self) -> vk::PipelineDepthStencilStateCreateInfo {
vk::PipelineDepthStencilStateCreateInfo {
back: self.back.into_vk(),
depth_bounds_test_enable: self.bounds_test as _,
depth_compare_op: self.compare_op,
depth_test_enable: self.depth_test as _,
depth_write_enable: self.depth_write as _,
front: self.front.into_vk(),
max_depth_bounds: *self.max,
min_depth_bounds: *self.min,
stencil_test_enable: self.stencil_test as _,
..Default::default()
}
}
}
// HACK: https://github.com/colin-kiegel/rust-derive-builder/issues/56
impl DepthStencilModeBuilder {
/// Builds a new `DepthStencilMode`.
pub fn build(mut self) -> DepthStencilMode {
if self.back.is_none() {
self.back = Some(Default::default());
}
if self.bounds_test.is_none() {
self.bounds_test = Some(Default::default());
}
if self.compare_op.is_none() {
self.compare_op = Some(Default::default());
}
if self.depth_test.is_none() {
self.depth_test = Some(Default::default());
}
if self.depth_write.is_none() {
self.depth_write = Some(Default::default());
}
if self.front.is_none() {
self.front = Some(Default::default());
}
if self.min.is_none() {
self.min = Some(Default::default());
}
if self.max.is_none() {
self.max = Some(Default::default());
}
if self.stencil_test.is_none() {
self.stencil_test = Some(Default::default());
}
self.fallible_build()
.expect("All required fields set at initialization")
}
}
#[derive(Debug)]
struct DepthStencilModeBuilderError;
impl From<UninitializedFieldError> for DepthStencilModeBuilderError {
fn from(_: UninitializedFieldError) -> Self {
Self
}
}
/// Opaque representation of a [pipeline] object.
///
/// Also contains information about the object.
///
/// [pipeline]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkPipeline.html
#[derive(Debug)]
pub struct GraphicPipeline {
pub(crate) descriptor_bindings: DescriptorBindingMap,
pub(crate) descriptor_info: PipelineDescriptorInfo,
device: Arc<Device>,
/// Information used to create this object.
pub info: GraphicPipelineInfo,
pub(crate) input_attachments: Box<[u32]>,
pub(crate) layout: vk::PipelineLayout,
/// A descriptive name used in debugging messages.
pub name: Option<String>,
pub(crate) push_constants: Vec<vk::PushConstantRange>,
pub(crate) shader_modules: Vec<vk::ShaderModule>,
pub(super) state: GraphicPipelineState,
}
impl GraphicPipeline {
/// Creates a new graphic pipeline on the given device.
///
/// The correct pipeline stages will be enabled based on the provided shaders. See [Shader] for
/// details on all available stages.
///
/// # Panics
///
/// If shader code is not a multiple of four bytes.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # use std::sync::Arc;
/// # use ash::vk;
/// # use screen_13::driver::DriverError;
/// # use screen_13::driver::device::{Device, DeviceInfo};
/// # use screen_13::driver::graphic::{GraphicPipeline, GraphicPipelineInfo};
/// # use screen_13::driver::shader::Shader;
/// # fn main() -> Result<(), DriverError> {
/// # let device = Arc::new(Device::create_headless(DeviceInfo::new())?);
/// # let my_frag_code = [0u8; 1];
/// # let my_vert_code = [0u8; 1];
/// // shader code is raw SPIR-V code as bytes
/// let vert = Shader::new_vertex(my_vert_code.as_slice());
/// let frag = Shader::new_fragment(my_frag_code.as_slice());
/// let info = GraphicPipelineInfo::default();
/// let pipeline = GraphicPipeline::create(&device, info, [vert, frag])?;
///
/// assert_eq!(pipeline.info.front_face, vk::FrontFace::COUNTER_CLOCKWISE);
/// # Ok(()) }
/// ```
#[profiling::function]
pub fn create<S>(
device: &Arc<Device>,
info: impl Into<GraphicPipelineInfo>,
shaders: impl IntoIterator<Item = S>,
) -> Result<Self, DriverError>
where
S: Into<Shader>,
{
trace!("create");
let device = Arc::clone(device);
let info = info.into();
let shaders = shaders
.into_iter()
.map(|shader| shader.into())
.collect::<Vec<Shader>>();
let vertex_input = shaders
.iter()
.find(|shader| shader.stage == vk::ShaderStageFlags::VERTEX)
.expect("vertex shader not found")
.vertex_input();
// Check for proper stages because vulkan may not complain but this is bad
let has_fragment_stage = shaders
.iter()
.any(|shader| shader.stage.contains(vk::ShaderStageFlags::FRAGMENT));
let has_tesselation_stage = shaders.iter().any(|shader| {
shader
.stage
.contains(vk::ShaderStageFlags::TESSELLATION_CONTROL)
}) && shaders.iter().any(|shader| {
shader
.stage
.contains(vk::ShaderStageFlags::TESSELLATION_EVALUATION)
});
let has_geometry_stage = shaders
.iter()
.any(|shader| shader.stage.contains(vk::ShaderStageFlags::GEOMETRY));
debug_assert!(
has_fragment_stage || has_tesselation_stage || has_geometry_stage,
"invalid shader stage combination"
);
let mut descriptor_bindings = Shader::merge_descriptor_bindings(
shaders
.iter()
.map(|shader| shader.descriptor_bindings(&device))
.collect::<Result<Vec<_>, _>>()?,
);
for (descriptor_info, _) in descriptor_bindings.values_mut() {
if descriptor_info.binding_count() == 0 {
descriptor_info.set_binding_count(info.bindless_descriptor_count);
}
}
let descriptor_info = PipelineDescriptorInfo::create(&device, &descriptor_bindings)?;
let descriptor_sets_layouts = descriptor_info
.layouts
.values()
.map(|descriptor_set_layout| **descriptor_set_layout)
.collect::<Box<[_]>>();
let push_constants = shaders
.iter()
.map(|shader| shader.push_constant_range())
.filter_map(|mut push_const| push_const.take())
.collect::<Vec<_>>();
let input_attachments = {
let (input, write) = shaders
.iter()
.find(|shader| shader.stage == vk::ShaderStageFlags::FRAGMENT)
.expect("fragment shader not found")
.attachments();
let (input, write) = (
input
.collect::<HashSet<_>>()
.into_iter()
.collect::<Box<_>>(),
write.collect::<HashSet<_>>(),
);
for input in input.iter() {
trace!("detected input attachment {input}");
}
for write in &write {
trace!("detected write attachment {write}");
}
input
};
unsafe {
let layout = device
.create_pipeline_layout(
&vk::PipelineLayoutCreateInfo::builder()
.set_layouts(&descriptor_sets_layouts)
.push_constant_ranges(&push_constants),
None,
)
.map_err(|err| {
warn!("{err}");
DriverError::Unsupported
})?;
let shader_info = shaders
.into_iter()
.map(|shader| {
let shader_module_create_info = vk::ShaderModuleCreateInfo {
code_size: shader.spirv.len(),
p_code: shader.spirv.as_ptr() as *const u32,
..Default::default()
};
let shader_module = device
.create_shader_module(&shader_module_create_info, None)
.map_err(|err| {
warn!("{err}");
DriverError::Unsupported
})?;
let shader_stage = Stage {
flags: shader.stage,
module: shader_module,
name: CString::new(shader.entry_name.as_str()).unwrap(),
specialization_info: shader.specialization_info,
};
Result::<_, DriverError>::Ok((shader_module, shader_stage))
})
.collect::<Result<Vec<_>, _>>()?;
let mut shader_modules = vec![];
let mut stages = vec![];
shader_info
.into_iter()
.for_each(|(shader_module, shader_stage)| {
shader_modules.push(shader_module);
stages.push(shader_stage);
});
let multisample = MultisampleState {
rasterization_samples: info.samples,
..Default::default()
};
let push_constants = merge_push_constant_ranges(&push_constants);
Ok(Self {
descriptor_bindings,
descriptor_info,
device,
info,
input_attachments,
layout,
name: None,
push_constants,
shader_modules,
state: GraphicPipelineState {
layout,
multisample,
stages,
vertex_input,
},
})
}
}
/// Sets the debugging name assigned to this pipeline.
pub fn with_name(mut this: Self, name: impl Into<String>) -> Self {
this.name = Some(name.into());
this
}
}
impl Drop for GraphicPipeline {
#[profiling::function]
fn drop(&mut self) {
if panicking() {
return;
}
unsafe {
self.device.destroy_pipeline_layout(self.layout, None);
}
for shader_module in self.shader_modules.drain(..) {
unsafe {
self.device.destroy_shader_module(shader_module, None);
}
}
}
}
/// Information used to create a [`GraphicPipeline`] instance.
#[derive(Builder, Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[builder(
build_fn(
private,
name = "fallible_build",
error = "GraphicPipelineInfoBuilderError"
),
derive(Clone, Copy, Debug),
pattern = "owned"
)]
#[non_exhaustive]
pub struct GraphicPipelineInfo {
/// The number of descriptors to allocate for a given binding when using bindless (unbounded)
/// syntax.
///
/// The default is `8192`.
///
/// # Examples
///
/// Basic usage (GLSL):
///
/// ```
/// # inline_spirv::inline_spirv!(r#"
/// #version 460 core
/// #extension GL_EXT_nonuniform_qualifier : require
///
/// layout(set = 0, binding = 0) uniform sampler2D my_binding[];
///
/// void main()
/// {
/// // my_binding will have space for 8,192 images by default
/// }
/// # "#, frag);
/// ```
#[builder(default = "8192")]
pub bindless_descriptor_count: u32,
/// Specifies color blend state used when rasterization is enabled for any color attachments
/// accessed during rendering.
///
/// The default value is [`BlendMode::REPLACE`].
#[builder(default)]
pub blend: BlendMode,
/// Bitmask controlling triangle culling.
///
/// The default value is `vk::CullModeFlags::BACK`.
#[builder(default = "vk::CullModeFlags::BACK")]
pub cull_mode: vk::CullModeFlags,
/// Interpret polygon front-facing orientation.
///
/// The default value is `vk::FrontFace::COUNTER_CLOCKWISE`.
#[builder(default = "vk::FrontFace::COUNTER_CLOCKWISE")]
pub front_face: vk::FrontFace,
/// Control polygon rasterization mode.
///
/// The default value is `vk::PolygonMode::FILL`.
#[builder(default = "vk::PolygonMode::FILL")]
pub polygon_mode: vk::PolygonMode,
/// Input primitive topology.
///
/// The default value is `vk::PrimitiveTopology::TRIANGLE_LIST`.
#[builder(default = "vk::PrimitiveTopology::TRIANGLE_LIST")]
pub topology: vk::PrimitiveTopology,
/// Multisampling antialias mode.
///
/// The default value is `SampleCount::Type1`.
///
/// See [multisampling](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#primsrast-multisampling).
#[builder(default = "SampleCount::Type1")]
pub samples: SampleCount,
}
impl GraphicPipelineInfo {
/// Creates a default `GraphicPipelineInfoBuilder`.
#[allow(clippy::new_ret_no_self)]
#[deprecated = "Use GraphicPipelineInfo::default()"]
#[doc(hidden)]
pub fn new() -> GraphicPipelineInfoBuilder {
Default::default()
}
/// Converts a `GraphicPipelineInfo` into a `GraphicPipelineInfoBuilder`.
#[inline(always)]
pub fn to_builder(self) -> GraphicPipelineInfoBuilder {
GraphicPipelineInfoBuilder {
bindless_descriptor_count: Some(self.bindless_descriptor_count),
blend: Some(self.blend),
cull_mode: Some(self.cull_mode),
front_face: Some(self.front_face),
polygon_mode: Some(self.polygon_mode),
topology: Some(self.topology),
samples: Some(self.samples),
}
}
}
impl Default for GraphicPipelineInfo {
fn default() -> Self {
Self {
bindless_descriptor_count: 8192,
blend: BlendMode::REPLACE,
cull_mode: vk::CullModeFlags::BACK,
front_face: vk::FrontFace::COUNTER_CLOCKWISE,
polygon_mode: vk::PolygonMode::FILL,
topology: vk::PrimitiveTopology::TRIANGLE_LIST,
samples: SampleCount::Type1,
}
}
}
impl From<GraphicPipelineInfoBuilder> for GraphicPipelineInfo {
fn from(info: GraphicPipelineInfoBuilder) -> Self {
info.build()
}
}
impl GraphicPipelineInfoBuilder {
/// Builds a new `GraphicPipelineInfo`.
#[inline(always)]
pub fn build(self) -> GraphicPipelineInfo {
let res = self.fallible_build();
#[cfg(test)]
let res = res.unwrap();
#[cfg(not(test))]
let res = unsafe { res.unwrap_unchecked() };
res
}
}
#[derive(Debug)]
struct GraphicPipelineInfoBuilderError;
impl From<UninitializedFieldError> for GraphicPipelineInfoBuilderError {
fn from(_: UninitializedFieldError) -> Self {
Self
}
}
#[derive(Debug)]
pub(super) struct GraphicPipelineState {
pub layout: vk::PipelineLayout,
pub multisample: MultisampleState,
pub stages: Vec<Stage>,
pub vertex_input: VertexInputState,
}
#[derive(Debug, Default)]
pub(super) struct MultisampleState {
pub alpha_to_coverage_enable: bool,
pub alpha_to_one_enable: bool,
pub flags: vk::PipelineMultisampleStateCreateFlags,
pub min_sample_shading: f32,
pub rasterization_samples: SampleCount,
pub sample_mask: Vec<u32>,
pub sample_shading_enable: bool,
}
#[derive(Debug)]
pub(super) struct Stage {
pub flags: vk::ShaderStageFlags,
pub module: vk::ShaderModule,
pub name: CString,
pub specialization_info: Option<SpecializationInfo>,
}
/// Specifies stencil mode during rasterization.
///
/// See
/// [stencil test](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-stencil).
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct StencilMode {
/// The action performed on samples that fail the stencil test.
pub fail_op: vk::StencilOp,
/// The action performed on samples that pass both the depth and stencil tests.
pub pass_op: vk::StencilOp,
/// The action performed on samples that pass the stencil test and fail the depth test.
pub depth_fail_op: vk::StencilOp,
/// The comparison operator used in the stencil test.
pub compare_op: vk::CompareOp,
/// The bits of the unsigned integer stencil values participating in the stencil test.
pub compare_mask: u32,
/// The bits of the unsigned integer stencil values updated by the stencil test in the stencil
/// framebuffer attachment.
pub write_mask: u32,
/// An unsigned integer stencil reference value that is used in the unsigned stencil comparison.
pub reference: u32,
}
impl StencilMode {
/// Specifes a stencil mode which is has no effect.
pub const IGNORE: Self = Self {
fail_op: vk::StencilOp::KEEP,
pass_op: vk::StencilOp::KEEP,
depth_fail_op: vk::StencilOp::KEEP,
compare_op: vk::CompareOp::NEVER,
compare_mask: 0,
write_mask: 0,
reference: 0,
};
fn into_vk(self) -> vk::StencilOpState {
vk::StencilOpState {
fail_op: self.fail_op,
pass_op: self.pass_op,
depth_fail_op: self.depth_fail_op,
compare_op: self.compare_op,
compare_mask: self.compare_mask,
write_mask: self.write_mask,
reference: self.reference,
}
}
}
impl Default for StencilMode {
fn default() -> Self {
Self::IGNORE
}
}
#[derive(Clone, Debug, Default)]
pub(super) struct VertexInputState {
pub vertex_binding_descriptions: Vec<vk::VertexInputBindingDescription>,
pub vertex_attribute_descriptions: Vec<vk::VertexInputAttributeDescription>,
}
#[cfg(test)]
mod tests {
use super::*;
type Info = GraphicPipelineInfo;
type Builder = GraphicPipelineInfoBuilder;
#[test]
pub fn graphic_pipeline_info() {
let info = Info::default();
let builder = info.to_builder().build();
assert_eq!(info, builder);
}
#[test]
pub fn graphic_pipeline_info_builder() {
let info = Info::default();
let builder = Builder::default().build();
assert_eq!(info, builder);
}
}