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 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
// 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.
//! Recording commands to execute on the device.
//!
//! With Vulkan, to get the device to perform work, even relatively simple tasks, you must create a
//! command buffer. A command buffer is a list of commands that will executed by the device.
//! You must first record commands to a command buffer builder, then build it into an actual
//! command buffer, and then it can be used. Depending on how a command buffer is created, it can
//! be used only once, or reused many times.
//!
//! # Command pools and allocators
//!
//! Command buffers are allocated from *command pools*. A command pool holds memory that is used to
//! record the sequence of commands in a command buffer. Command pools are not thread-safe, and
//! therefore commands cannot be recorded to a single command buffer from multiple threads at a
//! time.
//!
//! Raw command pools are unsafe to use, so Vulkano uses [command buffer allocators] to manage
//! command buffers and pools, to ensure their memory is used efficiently, and to protect against
//! invalid usage. Vulkano provides the [`StandardCommandBufferAllocator`] for this purpose, but
//! you can also create your own by implementing the [`CommandBufferAllocator`] trait.
//!
//! # Primary and secondary command buffers
//!
//! There are two levels of command buffers:
//!
//! - [`PrimaryCommandBufferAbstract`] can be executed on a queue, and is the main command buffer
//! type. It cannot be executed within another command buffer.
//! - [`SecondaryCommandBufferAbstract`] can only be executed within a primary command buffer,
//! not directly on a queue.
//!
//! Using secondary command buffers, there is slightly more overhead than using primary command
//! buffers alone, but there are also advantages. A single command buffer cannot be recorded
//! from multiple threads at a time, so if you want to divide the recording work among several
//! threads, each thread must record its own command buffer. While it is possible for these to be
//! all primary command buffers, there are limitations: a render pass or query cannot span multiple
//! primary command buffers, while secondary command buffers can [inherit] this state from their
//! parent primary command buffer. Therefore, to have a single render pass or query that is shared
//! across all the command buffers, you must record secondary command buffers.
//!
//! # Recording a command buffer
//!
//! To record a new command buffer, the most direct way is to create a new
//! [`AutoCommandBufferBuilder`]. You can then call methods on this object to record new commands to
//! the command buffer. When you are done recording, you call [`build`] to finalise the command
//! buffer and turn it into either a [`PrimaryCommandBufferAbstract`] or a
//! [`SecondaryCommandBufferAbstract`].
//!
// //! Using the standard `CommandBufferBuilder`, you must enter synchronization commands such as
// //! [pipeline barriers], to ensure that there are no races and memory access hazards. This can be
// //! difficult to do manually, so Vulkano also provides an alternative builder,
// //! [`AutoCommandBufferBuilder`]. Using this builder, you do not have to worry about managing
// //! synchronization, but the end result may not be quite as efficient.
//!
//! # Submitting a primary command buffer
//!
//! Once primary a command buffer is recorded and built, you can use the
//! [`PrimaryCommandBufferAbstract`] trait to submit the command buffer to a queue. Submitting a
//! command buffer returns an object that implements the [`GpuFuture`] trait and that represents
//! the moment when the execution will end on the GPU.
//!
//! ```
//! use vulkano::command_buffer::AutoCommandBufferBuilder;
//! use vulkano::command_buffer::CommandBufferUsage;
//! use vulkano::command_buffer::PrimaryCommandBufferAbstract;
//! use vulkano::command_buffer::SubpassContents;
//!
//! # use vulkano::{buffer::BufferContents, pipeline::graphics::vertex_input::Vertex};
//!
//! # #[derive(BufferContents, Vertex)]
//! # #[repr(C)]
//! # struct PosVertex {
//! # #[format(R32G32B32_SFLOAT)]
//! # position: [f32; 3]
//! # };
//! # let device: std::sync::Arc<vulkano::device::Device> = return;
//! # let queue: std::sync::Arc<vulkano::device::Queue> = return;
//! # let vertex_buffer: vulkano::buffer::Subbuffer<[PosVertex]> = return;
//! # let render_pass_begin_info: vulkano::command_buffer::RenderPassBeginInfo = return;
//! # let graphics_pipeline: std::sync::Arc<vulkano::pipeline::graphics::GraphicsPipeline> = return;
//! # let command_buffer_allocator: vulkano::command_buffer::allocator::StandardCommandBufferAllocator = return;
//! let cb = AutoCommandBufferBuilder::primary(
//! &command_buffer_allocator,
//! queue.queue_family_index(),
//! CommandBufferUsage::MultipleSubmit
//! ).unwrap()
//! .begin_render_pass(render_pass_begin_info, Default::default()).unwrap()
//! .bind_pipeline_graphics(graphics_pipeline.clone()).unwrap()
//! .bind_vertex_buffers(0, vertex_buffer.clone()).unwrap()
//! .draw(vertex_buffer.len() as u32, 1, 0, 0).unwrap()
//! .end_render_pass(Default::default()).unwrap()
//! .build().unwrap();
//!
//! let _future = cb.execute(queue.clone());
//! ```
//!
//! [`StandardCommandBufferAllocator`]: self::allocator::StandardCommandBufferAllocator
//! [`CommandBufferAllocator`]: self::allocator::CommandBufferAllocator
//! [inherit]: CommandBufferInheritanceInfo
//! [`build`]: CommandBufferBuilder::build
//! [pipeline barriers]: CommandBufferBuilder::pipeline_barrier
//! [`GpuFuture`]: crate::sync::GpuFuture
pub use self::{
auto::{AutoCommandBufferBuilder, PrimaryAutoCommandBuffer, SecondaryAutoCommandBuffer},
commands::{
acceleration_structure::*, clear::*, copy::*, debug::*, dynamic_state::*, pipeline::*,
query::*, render_pass::*, secondary::*, sync::*,
},
traits::{
CommandBufferExecError, CommandBufferExecFuture, PrimaryCommandBufferAbstract,
SecondaryCommandBufferAbstract,
},
};
use crate::{
buffer::{Buffer, Subbuffer},
device::{Device, DeviceOwned},
format::{Format, FormatFeatures},
image::{Image, ImageAspects, ImageLayout, ImageSubresourceRange, SampleCount},
macros::vulkan_enum,
query::{QueryControlFlags, QueryPipelineStatisticFlags},
range_map::RangeMap,
render_pass::{Framebuffer, Subpass},
sync::{semaphore::Semaphore, PipelineStageAccessFlags, PipelineStages},
DeviceSize, Requires, RequiresAllOf, RequiresOneOf, ValidationError,
};
use ahash::HashMap;
use bytemuck::{Pod, Zeroable};
use std::{ops::Range, sync::Arc};
pub mod allocator;
pub mod auto;
mod commands;
pub mod pool;
pub mod sys;
mod traits;
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, Zeroable, Pod, PartialEq, Eq)]
pub struct DrawIndirectCommand {
pub vertex_count: u32,
pub instance_count: u32,
pub first_vertex: u32,
pub first_instance: u32,
}
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, Zeroable, Pod, PartialEq, Eq)]
pub struct DrawIndexedIndirectCommand {
pub index_count: u32,
pub instance_count: u32,
pub first_index: u32,
pub vertex_offset: u32,
pub first_instance: u32,
}
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, Zeroable, Pod, PartialEq, Eq)]
pub struct DispatchIndirectCommand {
pub x: u32,
pub y: u32,
pub z: u32,
}
vulkan_enum! {
#[non_exhaustive]
/// Describes what a subpass in a command buffer will contain.
SubpassContents = SubpassContents(i32);
/// The subpass will only directly contain commands.
Inline = INLINE,
/// The subpass will only contain secondary command buffers invocations.
SecondaryCommandBuffers = SECONDARY_COMMAND_BUFFERS,
}
impl From<SubpassContents> for ash::vk::RenderingFlags {
#[inline]
fn from(val: SubpassContents) -> Self {
match val {
SubpassContents::Inline => Self::empty(),
SubpassContents::SecondaryCommandBuffers => Self::CONTENTS_SECONDARY_COMMAND_BUFFERS,
}
}
}
vulkan_enum! {
/// Determines the kind of command buffer to create.
CommandBufferLevel = CommandBufferLevel(i32);
/// Primary command buffers can be executed on a queue, and can call secondary command buffers.
/// Render passes must begin and end within the same primary command buffer.
Primary = PRIMARY,
/// Secondary command buffers cannot be executed on a queue, but can be executed by a primary
/// command buffer. If created for a render pass, they must fit within a single render subpass.
Secondary = SECONDARY,
}
/// The context that a secondary command buffer can inherit from the primary command
/// buffer it's executed in.
#[derive(Clone, Debug)]
pub struct CommandBufferInheritanceInfo {
/// If `Some`, the secondary command buffer is required to be executed within a render pass
/// instance, and can only call draw operations.
/// If `None`, it must be executed outside a render pass instance, and can execute dispatch and
/// transfer operations, but not drawing operations.
///
/// The default value is `None`.
pub render_pass: Option<CommandBufferInheritanceRenderPassType>,
/// If `Some`, the secondary command buffer is allowed to be executed within a primary that has
/// an occlusion query active. The inner `QueryControlFlags` specifies which flags the
/// active occlusion is allowed to have enabled.
/// If `None`, the primary command buffer cannot have an occlusion query active when this
/// secondary command buffer is executed.
///
/// The `inherited_queries` feature must be enabled if this is `Some`.
///
/// The default value is `None`.
pub occlusion_query: Option<QueryControlFlags>,
/// Which pipeline statistics queries are allowed to be active on the primary command buffer
/// when this secondary command buffer is executed.
///
/// If this value is not empty, the [`pipeline_statistics_query`] feature must be enabled on
/// the device.
///
/// The default value is [`QueryPipelineStatisticFlags::empty()`].
///
/// [`pipeline_statistics_query`]: crate::device::Features::pipeline_statistics_query
pub query_statistics_flags: QueryPipelineStatisticFlags,
pub _ne: crate::NonExhaustive,
}
impl Default for CommandBufferInheritanceInfo {
#[inline]
fn default() -> Self {
Self {
render_pass: None,
occlusion_query: None,
query_statistics_flags: QueryPipelineStatisticFlags::empty(),
_ne: crate::NonExhaustive(()),
}
}
}
impl CommandBufferInheritanceInfo {
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
ref render_pass,
occlusion_query,
query_statistics_flags,
_ne: _,
} = self;
if let Some(render_pass) = render_pass {
// VUID-VkCommandBufferBeginInfo-flags-06000
// VUID-VkCommandBufferBeginInfo-flags-06002
// Ensured by the definition of the `CommandBufferInheritanceRenderPassType` enum.
match render_pass {
CommandBufferInheritanceRenderPassType::BeginRenderPass(render_pass_info) => {
render_pass_info
.validate(device)
.map_err(|err| err.add_context("render_pass"))?;
}
CommandBufferInheritanceRenderPassType::BeginRendering(rendering_info) => {
rendering_info
.validate(device)
.map_err(|err| err.add_context("render_pass"))?;
}
}
}
if let Some(control_flags) = occlusion_query {
control_flags.validate_device(device).map_err(|err| {
err.add_context("occlusion_query")
.set_vuids(&["VUID-VkCommandBufferInheritanceInfo-queryFlags-00057"])
})?;
if !device.enabled_features().inherited_queries {
return Err(Box::new(ValidationError {
context: "occlusion_query".into(),
problem: "is `Some`".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"inherited_queries",
)])]),
vuids: &["VUID-VkCommandBufferInheritanceInfo-occlusionQueryEnable-00056"],
}));
}
if control_flags.intersects(QueryControlFlags::PRECISE)
&& !device.enabled_features().occlusion_query_precise
{
return Err(Box::new(ValidationError {
context: "occlusion_query".into(),
problem: "contains `QueryControlFlags::PRECISE`".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"occlusion_query_precise",
)])]),
vuids: &["VUID-vkBeginCommandBuffer-commandBuffer-00052"],
}));
}
}
query_statistics_flags
.validate_device(device)
.map_err(|err| {
err.add_context("query_statistics_flags")
.set_vuids(&["VUID-VkCommandBufferInheritanceInfo-pipelineStatistics-02789"])
})?;
if query_statistics_flags.count() > 0
&& !device.enabled_features().pipeline_statistics_query
{
return Err(Box::new(ValidationError {
context: "query_statistics_flags".into(),
problem: "is not empty".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"pipeline_statistics_query",
)])]),
vuids: &["VUID-VkCommandBufferInheritanceInfo-pipelineStatistics-00058"],
}));
}
Ok(())
}
}
/// Selects the type of render pass for command buffer inheritance.
#[derive(Clone, Debug)]
pub enum CommandBufferInheritanceRenderPassType {
/// The secondary command buffer will be executed within a render pass begun with
/// `begin_render_pass`, using a `RenderPass` object and `Framebuffer`.
BeginRenderPass(CommandBufferInheritanceRenderPassInfo),
/// The secondary command buffer will be executed within a render pass begun with
/// `begin_rendering`, using dynamic rendering.
BeginRendering(CommandBufferInheritanceRenderingInfo),
}
impl From<Subpass> for CommandBufferInheritanceRenderPassType {
#[inline]
fn from(val: Subpass) -> Self {
Self::BeginRenderPass(val.into())
}
}
impl From<CommandBufferInheritanceRenderPassInfo> for CommandBufferInheritanceRenderPassType {
#[inline]
fn from(val: CommandBufferInheritanceRenderPassInfo) -> Self {
Self::BeginRenderPass(val)
}
}
impl From<CommandBufferInheritanceRenderingInfo> for CommandBufferInheritanceRenderPassType {
#[inline]
fn from(val: CommandBufferInheritanceRenderingInfo) -> Self {
Self::BeginRendering(val)
}
}
/// The render pass context that a secondary command buffer is created for.
#[derive(Clone, Debug)]
pub struct CommandBufferInheritanceRenderPassInfo {
/// The render subpass that this secondary command buffer must be executed within.
///
/// There is no default value.
pub subpass: Subpass,
/// The framebuffer object that will be used when calling the command buffer.
/// This parameter is optional and is an optimization hint for the implementation.
///
/// The default value is `None`.
pub framebuffer: Option<Arc<Framebuffer>>,
}
impl CommandBufferInheritanceRenderPassInfo {
/// Returns a `CommandBufferInheritanceRenderPassInfo` with the specified `subpass`.
#[inline]
pub fn subpass(subpass: Subpass) -> Self {
Self {
subpass,
framebuffer: None,
}
}
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
ref subpass,
ref framebuffer,
} = self;
// VUID-VkCommandBufferInheritanceInfo-commonparent
assert_eq!(device, subpass.render_pass().device().as_ref());
// VUID-VkCommandBufferBeginInfo-flags-06001
// Ensured by how the `Subpass` type is constructed.
if let Some(framebuffer) = framebuffer {
// VUID-VkCommandBufferInheritanceInfo-commonparent
assert_eq!(device, framebuffer.device().as_ref());
if !framebuffer
.render_pass()
.is_compatible_with(subpass.render_pass())
{
return Err(Box::new(ValidationError {
problem: "`framebuffer` is not compatible with `subpass.render_pass()`".into(),
vuids: &["VUID-VkCommandBufferBeginInfo-flags-00055"],
..Default::default()
}));
}
}
Ok(())
}
}
impl From<Subpass> for CommandBufferInheritanceRenderPassInfo {
#[inline]
fn from(subpass: Subpass) -> Self {
Self {
subpass,
framebuffer: None,
}
}
}
/// The dynamic rendering context that a secondary command buffer is created for.
#[derive(Clone, Debug)]
pub struct CommandBufferInheritanceRenderingInfo {
/// If not `0`, indicates that multiview rendering will be enabled, and specifies the view
/// indices that are rendered to. The value is a bitmask, so that that for example `0b11` will
/// draw to the first two views and `0b101` will draw to the first and third view.
///
/// If set to a nonzero value, then the [`multiview`] feature must be enabled on the device.
///
/// The default value is `0`.
///
/// [`multiview`]: crate::device::Features::multiview
pub view_mask: u32,
/// The formats of the color attachments that will be used during rendering.
///
/// If an element is `None`, it indicates that the attachment will not be used.
///
/// The default value is empty.
pub color_attachment_formats: Vec<Option<Format>>,
/// The format of the depth attachment that will be used during rendering.
///
/// If set to `None`, it indicates that no depth attachment will be used.
///
/// The default value is `None`.
pub depth_attachment_format: Option<Format>,
/// The format of the stencil attachment that will be used during rendering.
///
/// If set to `None`, it indicates that no stencil attachment will be used.
///
/// The default value is `None`.
pub stencil_attachment_format: Option<Format>,
/// The number of samples that the color, depth and stencil attachments will have.
///
/// The default value is [`SampleCount::Sample1`]
pub rasterization_samples: SampleCount,
}
impl Default for CommandBufferInheritanceRenderingInfo {
#[inline]
fn default() -> Self {
Self {
view_mask: 0,
color_attachment_formats: Vec::new(),
depth_attachment_format: None,
stencil_attachment_format: None,
rasterization_samples: SampleCount::Sample1,
}
}
}
impl CommandBufferInheritanceRenderingInfo {
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
view_mask,
ref color_attachment_formats,
depth_attachment_format,
stencil_attachment_format,
rasterization_samples,
} = self;
let properties = device.physical_device().properties();
if view_mask != 0 && !device.enabled_features().multiview {
return Err(Box::new(ValidationError {
context: "view_mask".into(),
problem: "is not zero".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature("multiview")])]),
vuids: &["VUID-VkCommandBufferInheritanceRenderingInfo-multiview-06008"],
}));
}
let view_count = u32::BITS - view_mask.leading_zeros();
if view_count > properties.max_multiview_view_count.unwrap_or(0) {
return Err(Box::new(ValidationError {
context: "view_mask".into(),
problem: "the number of views exceeds the \
`max_multiview_view_count` limit"
.into(),
vuids: &["VUID-VkCommandBufferInheritanceRenderingInfo-viewMask-06009"],
..Default::default()
}));
}
for (index, format) in color_attachment_formats
.iter()
.enumerate()
.flat_map(|(i, f)| f.map(|f| (i, f)))
{
format.validate_device(device).map_err(|err| {
err.add_context(format!("color_attachment_formats[{}]", index)).set_vuids(
&["VUID-VkCommandBufferInheritanceRenderingInfo-pColorAttachmentFormats-parameter"],
)
})?;
if format == Format::UNDEFINED {
return Err(Box::new(ValidationError {
context: format!("color_attachment_formats[{}]", index).into(),
problem: "is `Format::UNDEFINED`".into(),
..Default::default()
}));
}
let potential_format_features = unsafe {
device
.physical_device()
.format_properties_unchecked(format)
.potential_format_features()
};
if !potential_format_features.intersects(FormatFeatures::COLOR_ATTACHMENT) {
return Err(Box::new(ValidationError {
context: format!("color_attachment_formats[{}]", index).into(),
problem: "the potential format features do not contain \
`FormatFeatures::COLOR_ATTACHMENT`".into(),
vuids: &["VUID-VkCommandBufferInheritanceRenderingInfo-pColorAttachmentFormats-06006"],
..Default::default()
}));
}
}
if let Some(format) = depth_attachment_format {
format.validate_device(device).map_err(|err| {
err.add_context("depth_attachment_format").set_vuids(&[
"VUID-VkCommandBufferInheritanceRenderingInfo-depthAttachmentFormat-parameter",
])
})?;
if format == Format::UNDEFINED {
return Err(Box::new(ValidationError {
context: "depth_attachment_format".into(),
problem: "is `Format::UNDEFINED`".into(),
..Default::default()
}));
}
if !format.aspects().intersects(ImageAspects::DEPTH) {
return Err(Box::new(ValidationError {
context: "depth_attachment_format".into(),
problem: "does not have a depth aspect".into(),
vuids: &[
"VUID-VkCommandBufferInheritanceRenderingInfo-depthAttachmentFormat-06540",
],
..Default::default()
}));
}
let potential_format_features = unsafe {
device
.physical_device()
.format_properties_unchecked(format)
.potential_format_features()
};
if !potential_format_features.intersects(FormatFeatures::DEPTH_STENCIL_ATTACHMENT) {
return Err(Box::new(ValidationError {
context: "depth_attachment_format".into(),
problem: "the potential format features do not contain \
`FormatFeatures::DEPTH_STENCIL_ATTACHMENT`"
.into(),
vuids: &[
"VUID-VkCommandBufferInheritanceRenderingInfo-depthAttachmentFormat-06007",
],
..Default::default()
}));
}
}
if let Some(format) = stencil_attachment_format {
format.validate_device(device).map_err(|err| {
err.add_context("stencil_attachment_format").set_vuids(&["VUID-VkCommandBufferInheritanceRenderingInfo-stencilAttachmentFormat-parameter"])
})?;
if format == Format::UNDEFINED {
return Err(Box::new(ValidationError {
context: "stencil_attachment_format".into(),
problem: "is `Format::UNDEFINED`".into(),
..Default::default()
}));
}
if !format.aspects().intersects(ImageAspects::STENCIL) {
return Err(Box::new(ValidationError {
context: "stencil_attachment_format".into(),
problem: "does not have a stencil aspect".into(),
vuids: &[
"VUID-VkCommandBufferInheritanceRenderingInfo-stencilAttachmentFormat-06541",
],
..Default::default()
}));
}
let potential_format_features = unsafe {
device
.physical_device()
.format_properties_unchecked(format)
.potential_format_features()
};
if !potential_format_features.intersects(FormatFeatures::DEPTH_STENCIL_ATTACHMENT) {
return Err(Box::new(ValidationError {
context: "stencil_attachment_format".into(),
problem: "the potential format features do not contain \
`FormatFeatures::DEPTH_STENCIL_ATTACHMENT`"
.into(),
vuids: &[
"VUID-VkCommandBufferInheritanceRenderingInfo-stencilAttachmentFormat-06199",
],
..Default::default()
}));
}
}
if let (Some(depth_format), Some(stencil_format)) =
(depth_attachment_format, stencil_attachment_format)
{
if depth_format != stencil_format {
return Err(Box::new(ValidationError {
problem: "`depth_attachment_format` and `stencil_attachment_format` are both \
`Some`, but are not equal"
.into(),
vuids: &[
"VUID-VkCommandBufferInheritanceRenderingInfo-depthAttachmentFormat-06200",
],
..Default::default()
}));
}
}
rasterization_samples
.validate_device(device)
.map_err(|err| {
err.add_context("rasterization_samples").set_vuids(&[
"VUID-VkCommandBufferInheritanceRenderingInfo-rasterizationSamples-parameter",
])
})?;
Ok(())
}
}
/// Usage flags to pass when creating a command buffer.
///
/// The safest option is `SimultaneousUse`, but it may be slower than the other two.
// NOTE: The ordering is important: the variants are listed from least to most permissive!
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
#[repr(u32)]
pub enum CommandBufferUsage {
/// The command buffer can only be submitted once before being destroyed. Any further submit is
/// forbidden. This makes it possible for the implementation to perform additional
/// optimizations.
OneTimeSubmit = ash::vk::CommandBufferUsageFlags::ONE_TIME_SUBMIT.as_raw(),
/// The command buffer can be used multiple times, but must not execute or record more than once
/// simultaneously. In other words, it is as if executing the command buffer borrows it mutably.
MultipleSubmit = 0,
/// The command buffer can be executed multiple times in parallel on different queues.
/// If it's a secondary command buffer, it can be recorded to multiple primary command buffers
/// at once.
SimultaneousUse = ash::vk::CommandBufferUsageFlags::SIMULTANEOUS_USE.as_raw(),
}
impl From<CommandBufferUsage> for ash::vk::CommandBufferUsageFlags {
#[inline]
fn from(val: CommandBufferUsage) -> Self {
Self::from_raw(val as u32)
}
}
/// Parameters to submit command buffers to a queue.
#[derive(Clone, Debug)]
pub struct SubmitInfo {
/// The semaphores to wait for before beginning the execution of this batch of
/// command buffer operations.
///
/// The default value is empty.
pub wait_semaphores: Vec<SemaphoreSubmitInfo>,
/// The command buffers to execute.
///
/// The default value is empty.
pub command_buffers: Vec<Arc<dyn PrimaryCommandBufferAbstract>>,
/// The semaphores to signal after the execution of this batch of command buffer operations
/// has completed.
///
/// The default value is empty.
pub signal_semaphores: Vec<SemaphoreSubmitInfo>,
pub _ne: crate::NonExhaustive,
}
impl Default for SubmitInfo {
#[inline]
fn default() -> Self {
Self {
wait_semaphores: Vec::new(),
command_buffers: Vec::new(),
signal_semaphores: Vec::new(),
_ne: crate::NonExhaustive(()),
}
}
}
/// Parameters for a semaphore signal or wait operation in a command buffer submission.
#[derive(Clone, Debug)]
pub struct SemaphoreSubmitInfo {
/// The semaphore to signal or wait for.
pub semaphore: Arc<Semaphore>,
/// For a semaphore wait operation, specifies the pipeline stages in the second synchronization
/// scope: stages of queue operations following the wait operation that can start executing
/// after the semaphore is signalled.
///
/// For a semaphore signal operation, specifies the pipeline stages in the first synchronization
/// scope: stages of queue operations preceding the signal operation that must complete before
/// the semaphore is signalled.
/// If this value does not equal [`ALL_COMMANDS`], then the [`synchronization2`] feature must
/// be enabled on the device.
///
/// The default value is [`ALL_COMMANDS`].
///
/// [`ALL_COMMANDS`]: PipelineStages::ALL_COMMANDS
/// [`synchronization2`]: crate::device::Features::synchronization2
pub stages: PipelineStages,
pub _ne: crate::NonExhaustive,
}
impl SemaphoreSubmitInfo {
/// Returns a `SemaphoreSubmitInfo` with the specified `semaphore`.
#[inline]
pub fn semaphore(semaphore: Arc<Semaphore>) -> Self {
Self {
semaphore,
stages: PipelineStages::ALL_COMMANDS,
_ne: crate::NonExhaustive(()),
}
}
}
#[derive(Debug, Default)]
pub struct CommandBufferState {
has_been_submitted: bool,
pending_submits: u32,
}
impl CommandBufferState {
pub(crate) fn has_been_submitted(&self) -> bool {
self.has_been_submitted
}
pub(crate) fn is_submit_pending(&self) -> bool {
self.pending_submits != 0
}
pub(crate) unsafe fn add_queue_submit(&mut self) {
self.has_been_submitted = true;
self.pending_submits += 1;
}
pub(crate) unsafe fn set_submit_finished(&mut self) {
self.pending_submits -= 1;
}
}
#[doc(hidden)]
#[derive(Debug)]
pub struct CommandBufferResourcesUsage {
pub(crate) buffers: Vec<CommandBufferBufferUsage>,
pub(crate) images: Vec<CommandBufferImageUsage>,
pub(crate) buffer_indices: HashMap<Arc<Buffer>, usize>,
pub(crate) image_indices: HashMap<Arc<Image>, usize>,
}
#[derive(Debug)]
pub(crate) struct CommandBufferBufferUsage {
pub(crate) buffer: Arc<Buffer>,
pub(crate) ranges: RangeMap<DeviceSize, CommandBufferBufferRangeUsage>,
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct CommandBufferBufferRangeUsage {
pub(crate) first_use: Option<ResourceUseRef>,
pub(crate) mutable: bool,
}
#[derive(Debug)]
pub(crate) struct CommandBufferImageUsage {
pub(crate) image: Arc<Image>,
pub(crate) ranges: RangeMap<DeviceSize, CommandBufferImageRangeUsage>,
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct CommandBufferImageRangeUsage {
pub(crate) first_use: Option<ResourceUseRef>,
pub(crate) mutable: bool,
pub(crate) expected_layout: ImageLayout,
pub(crate) final_layout: ImageLayout,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct ResourceUseRef {
pub command_index: usize,
pub command_name: &'static str,
pub resource_in_command: ResourceInCommand,
pub secondary_use_ref: Option<SecondaryResourceUseRef>,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct SecondaryResourceUseRef {
pub command_index: usize,
pub command_name: &'static str,
pub resource_in_command: ResourceInCommand,
}
impl From<ResourceUseRef> for SecondaryResourceUseRef {
#[inline]
fn from(val: ResourceUseRef) -> Self {
let ResourceUseRef {
command_index,
command_name,
resource_in_command,
secondary_use_ref,
} = val;
debug_assert!(secondary_use_ref.is_none());
SecondaryResourceUseRef {
command_index,
command_name,
resource_in_command,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum ResourceInCommand {
AccelerationStructure { index: u32 },
ColorAttachment { index: u32 },
ColorResolveAttachment { index: u32 },
DepthStencilAttachment,
DepthStencilResolveAttachment,
DescriptorSet { set: u32, binding: u32, index: u32 },
Destination,
FramebufferAttachment { index: u32 },
GeometryAabbsData { index: u32 },
GeometryInstancesData,
GeometryTrianglesTransformData { index: u32 },
GeometryTrianglesIndexData { index: u32 },
GeometryTrianglesVertexData { index: u32 },
ImageMemoryBarrier { index: u32 },
IndexBuffer,
IndirectBuffer,
ScratchData,
SecondaryCommandBuffer { index: u32 },
Source,
VertexBuffer { binding: u32 },
}
#[doc(hidden)]
#[derive(Debug, Default)]
pub struct SecondaryCommandBufferResourcesUsage {
pub(crate) buffers: Vec<SecondaryCommandBufferBufferUsage>,
pub(crate) images: Vec<SecondaryCommandBufferImageUsage>,
}
#[derive(Debug)]
pub(crate) struct SecondaryCommandBufferBufferUsage {
pub(crate) use_ref: ResourceUseRef,
pub(crate) buffer: Subbuffer<[u8]>,
pub(crate) range: Range<DeviceSize>,
pub(crate) memory_access: PipelineStageAccessFlags,
}
#[derive(Debug)]
pub(crate) struct SecondaryCommandBufferImageUsage {
pub(crate) use_ref: ResourceUseRef,
pub(crate) image: Arc<Image>,
pub(crate) subresource_range: ImageSubresourceRange,
pub(crate) memory_access: PipelineStageAccessFlags,
pub(crate) start_layout: ImageLayout,
pub(crate) end_layout: ImageLayout,
}