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 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
// 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.
//! Description of the steps of the rendering process, and the images used as input or output.
//!
//! # Render passes and framebuffers
//!
//! There are two concepts in Vulkan:
//!
//! - A *render pass* describes the overall process of drawing a frame. It is subdivided into one
//! or more subpasses.
//! - A *framebuffer* contains the list of image views that are attached during the drawing of
//! each subpass.
//!
//! Render passes are typically created at initialization only (for example during a loading
//! screen) because they can be costly, while framebuffers can be created and destroyed either at
//! initialization or during the frame.
//!
//! Consequently you can create graphics pipelines from a render pass object alone.
//! A `Framebuffer` object is only needed when you actually add draw commands to a command buffer.
pub use self::{
create::RenderPassCreationError,
framebuffer::{Framebuffer, FramebufferCreateInfo, FramebufferCreationError},
};
use crate::{
device::{Device, DeviceOwned},
format::Format,
image::{ImageAspects, ImageLayout, SampleCount},
macros::{vulkan_bitflags, vulkan_enum},
shader::ShaderInterface,
sync::{AccessFlags, PipelineStages},
Version, VulkanObject,
};
use std::{
cmp::max,
hash::{Hash, Hasher},
mem::MaybeUninit,
ptr,
sync::Arc,
};
#[macro_use]
mod macros;
mod create;
mod framebuffer;
/// An object representing the discrete steps in which rendering is done.
///
/// A render pass in Vulkan is made up of three parts:
/// - A list of attachments, which are image views that are inputs, outputs or intermediate stages
/// in the rendering process.
/// - One or more subpasses, which are the steps in which the rendering process, takes place,
/// and the attachments that are used for each step.
/// - Dependencies, which describe how the input and output data of each subpass is to be passed
/// from one subpass to the next.
///
/// ```
/// use vulkano::render_pass::{RenderPass, RenderPassCreateInfo, SubpassDescription};
///
/// # let device: std::sync::Arc<vulkano::device::Device> = return;
/// let render_pass = RenderPass::new(
/// device.clone(),
/// RenderPassCreateInfo {
/// subpasses: vec![SubpassDescription::default()],
/// ..Default::default()
/// },
/// ).unwrap();
/// ```
///
/// This example creates a render pass with no attachment and one single subpass that doesn't draw
/// on anything. While it's sometimes useful, most of the time it's not what you want.
///
/// The easiest way to create a "real" render pass is to use the `single_pass_renderpass!` macro.
///
/// ```
/// # #[macro_use] extern crate vulkano;
/// # fn main() {
/// # let device: std::sync::Arc<vulkano::device::Device> = return;
/// use vulkano::format::Format;
///
/// let render_pass = single_pass_renderpass!(device.clone(),
/// attachments: {
/// // `foo` is a custom name we give to the first and only attachment.
/// foo: {
/// load: Clear,
/// store: Store,
/// format: Format::R8G8B8A8_UNORM,
/// samples: 1,
/// }
/// },
/// pass: {
/// color: [foo], // Repeat the attachment name here.
/// depth_stencil: {}
/// }
/// ).unwrap();
/// # }
/// ```
///
/// See the documentation of the macro for more details. TODO: put link here
#[derive(Debug)]
pub struct RenderPass {
handle: ash::vk::RenderPass,
device: Arc<Device>,
attachments: Vec<AttachmentDescription>,
subpasses: Vec<SubpassDescription>,
dependencies: Vec<SubpassDependency>,
correlated_view_masks: Vec<u32>,
granularity: [u32; 2],
views_used: u32,
}
impl RenderPass {
/// Creates a new `RenderPass`.
///
/// # Panics
///
/// - Panics if `create_info.subpasses` is empty.
/// - Panics if any element of `create_info.attachments` has a `format` of `None`.
pub fn new(
device: Arc<Device>,
mut create_info: RenderPassCreateInfo,
) -> Result<Arc<RenderPass>, RenderPassCreationError> {
let views_used = Self::validate(&device, &mut create_info)?;
let handle = unsafe {
if device.api_version() >= Version::V1_2
|| device.enabled_extensions().khr_create_renderpass2
{
Self::create_v2(&device, &create_info)?
} else {
Self::create_v1(&device, &create_info)?
}
};
let RenderPassCreateInfo {
attachments,
subpasses,
dependencies,
correlated_view_masks,
_ne: _,
} = create_info;
let granularity = unsafe { Self::get_granularity(&device, handle) };
Ok(Arc::new(RenderPass {
handle,
device,
attachments,
subpasses,
dependencies,
correlated_view_masks,
granularity,
views_used,
}))
}
unsafe fn get_granularity(device: &Arc<Device>, handle: ash::vk::RenderPass) -> [u32; 2] {
let fns = device.fns();
let mut out = MaybeUninit::uninit();
(fns.v1_0.get_render_area_granularity)(device.internal_object(), handle, out.as_mut_ptr());
let out = out.assume_init();
debug_assert_ne!(out.width, 0);
debug_assert_ne!(out.height, 0);
[out.width, out.height]
}
/// Builds a render pass with one subpass and no attachment.
///
/// This method is useful for quick tests.
#[inline]
pub fn empty_single_pass(
device: Arc<Device>,
) -> Result<Arc<RenderPass>, RenderPassCreationError> {
RenderPass::new(
device,
RenderPassCreateInfo {
subpasses: vec![SubpassDescription::default()],
..Default::default()
},
)
}
/// Creates a new `RenderPass` from a raw object handle.
///
/// # Safety
///
/// - `handle` must be a valid Vulkan object handle created from `device`.
/// - `create_info` must match the info used to create the object.
pub unsafe fn from_handle(
device: Arc<Device>,
handle: ash::vk::RenderPass,
create_info: RenderPassCreateInfo,
) -> Result<Arc<RenderPass>, RenderPassCreationError> {
let views_used = create_info
.subpasses
.iter()
.map(|subpass| u32::BITS - subpass.view_mask.leading_zeros())
.max()
.unwrap();
let granularity = Self::get_granularity(&device, handle);
let RenderPassCreateInfo {
attachments,
subpasses,
dependencies,
correlated_view_masks,
_ne: _,
} = create_info;
Ok(Arc::new(RenderPass {
handle,
device,
attachments,
subpasses,
dependencies,
correlated_view_masks,
granularity,
views_used,
}))
}
/// Returns the attachments of the render pass.
#[inline]
pub fn attachments(&self) -> &[AttachmentDescription] {
&self.attachments
}
/// Returns the subpasses of the render pass.
#[inline]
pub fn subpasses(&self) -> &[SubpassDescription] {
&self.subpasses
}
/// Returns the dependencies of the render pass.
#[inline]
pub fn dependencies(&self) -> &[SubpassDependency] {
&self.dependencies
}
/// Returns the correlated view masks of the render pass.
#[inline]
pub fn correlated_view_masks(&self) -> &[u32] {
&self.correlated_view_masks
}
/// If the render pass has multiview enabled, returns the number of views used by the render
/// pass. Returns 0 if multiview is not enabled.
#[inline]
pub fn views_used(&self) -> u32 {
self.views_used
}
/// Returns the granularity of this render pass.
///
/// If the render area of a render pass in a command buffer is a multiple of this granularity,
/// then the performance will be optimal. Performances are always optimal for render areas
/// that cover the whole framebuffer.
#[inline]
pub fn granularity(&self) -> [u32; 2] {
self.granularity
}
/// Returns the first subpass of the render pass.
#[inline]
pub fn first_subpass(self: Arc<Self>) -> Subpass {
Subpass {
render_pass: self,
subpass_id: 0, // Guaranteed to exist
}
}
/// Returns `true` if this render pass is compatible with the other render pass,
/// as defined in the [`Render Pass Compatibility` section of the Vulkan specs](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap8.html#renderpass-compatibility).
pub fn is_compatible_with(&self, other: &RenderPass) -> bool {
if self == other {
return true;
}
let Self {
handle: _,
device: _,
attachments: attachments1,
subpasses: subpasses1,
dependencies: dependencies1,
correlated_view_masks: correlated_view_masks1,
granularity: _,
views_used: _,
} = self;
let Self {
handle: _,
device: _,
attachments: attachments2,
subpasses: subpasses2,
dependencies: dependencies2,
correlated_view_masks: correlated_view_masks2,
granularity: _,
views_used: _,
} = other;
if attachments1.len() != attachments2.len() {
return false;
}
if !attachments1
.iter()
.zip(attachments2)
.all(|(attachment_desc1, attachment_desc2)| {
let AttachmentDescription {
format: format1,
samples: samples1,
load_op: _,
store_op: _,
stencil_load_op: _,
stencil_store_op: _,
initial_layout: _,
final_layout: _,
_ne: _,
} = attachment_desc1;
let AttachmentDescription {
format: format2,
samples: samples2,
load_op: _,
store_op: _,
stencil_load_op: _,
stencil_store_op: _,
initial_layout: _,
final_layout: _,
_ne: _,
} = attachment_desc2;
format1 == format2 && samples1 == samples2
})
{
return false;
}
let are_atch_refs_compatible = |atch_ref1, atch_ref2| match (atch_ref1, atch_ref2) {
(None, None) => true,
(Some(atch_ref1), Some(atch_ref2)) => {
let &AttachmentReference {
attachment: attachment1,
layout: _,
aspects: aspects1,
_ne: _,
} = atch_ref1;
let AttachmentDescription {
format: format1,
samples: samples1,
load_op: _,
store_op: _,
stencil_load_op: _,
stencil_store_op: _,
initial_layout: _,
final_layout: _,
_ne: _,
} = &attachments1[attachment1 as usize];
let &AttachmentReference {
attachment: attachment2,
layout: _,
aspects: aspects2,
_ne: _,
} = atch_ref2;
let AttachmentDescription {
format: format2,
samples: samples2,
load_op: _,
store_op: _,
stencil_load_op: _,
stencil_store_op: _,
initial_layout: _,
final_layout: _,
_ne: _,
} = &attachments2[attachment2 as usize];
format1 == format2 && samples1 == samples2 && aspects1 == aspects2
}
_ => false,
};
if subpasses1.len() != subpasses2.len() {
return false;
}
if !(subpasses1.iter())
.zip(subpasses2.iter())
.all(|(subpass1, subpass2)| {
let &SubpassDescription {
view_mask: view_mask1,
input_attachments: ref input_attachments1,
color_attachments: ref color_attachments1,
resolve_attachments: ref resolve_attachments1,
depth_stencil_attachment: ref depth_stencil_attachment1,
preserve_attachments: _,
_ne: _,
} = subpass1;
let &SubpassDescription {
view_mask: view_mask2,
input_attachments: ref input_attachments2,
color_attachments: ref color_attachments2,
resolve_attachments: ref resolve_attachments2,
depth_stencil_attachment: ref depth_stencil_attachment2,
preserve_attachments: _,
_ne: _,
} = subpass2;
if !(0..max(input_attachments1.len(), input_attachments2.len())).all(|i| {
are_atch_refs_compatible(
input_attachments1.get(i).and_then(|x| x.as_ref()),
input_attachments2.get(i).and_then(|x| x.as_ref()),
)
}) {
return false;
}
if !(0..max(color_attachments1.len(), color_attachments2.len())).all(|i| {
are_atch_refs_compatible(
color_attachments1.get(i).and_then(|x| x.as_ref()),
color_attachments2.get(i).and_then(|x| x.as_ref()),
)
}) {
return false;
}
if subpasses1.len() > 1
&& !(0..max(resolve_attachments1.len(), resolve_attachments2.len())).all(|i| {
are_atch_refs_compatible(
resolve_attachments1.get(i).and_then(|x| x.as_ref()),
resolve_attachments2.get(i).and_then(|x| x.as_ref()),
)
})
{
return false;
}
if !are_atch_refs_compatible(
depth_stencil_attachment1.as_ref(),
depth_stencil_attachment2.as_ref(),
) {
return false;
}
if view_mask1 != view_mask2 {
return false;
}
true
})
{
return false;
}
if dependencies1 != dependencies2 {
return false;
}
if correlated_view_masks1 != correlated_view_masks2 {
return false;
}
true
}
/// Returns `true` if the subpass of this description is compatible with the shader's fragment
/// output definition.
pub fn is_compatible_with_shader(
&self,
subpass: u32,
shader_interface: &ShaderInterface,
) -> bool {
let subpass_descr = match self.subpasses.get(subpass as usize) {
Some(s) => s,
None => return false,
};
for element in shader_interface.elements() {
assert!(!element.ty.is_64bit); // TODO: implement
let location_range = element.location..element.location + element.ty.num_locations();
for location in location_range {
let attachment_id = match subpass_descr.color_attachments.get(location as usize) {
Some(Some(atch_ref)) => atch_ref.attachment,
_ => return false,
};
let _attachment_desc = &self.attachments[attachment_id as usize];
// FIXME: compare formats depending on the number of components and data type
/*if attachment_desc.format != element.format {
return false;
}*/
}
}
true
}
}
impl Drop for RenderPass {
#[inline]
fn drop(&mut self) {
unsafe {
let fns = self.device.fns();
(fns.v1_0.destroy_render_pass)(self.device.internal_object(), self.handle, ptr::null());
}
}
}
unsafe impl VulkanObject for RenderPass {
type Object = ash::vk::RenderPass;
#[inline]
fn internal_object(&self) -> ash::vk::RenderPass {
self.handle
}
}
unsafe impl DeviceOwned for RenderPass {
#[inline]
fn device(&self) -> &Arc<Device> {
&self.device
}
}
impl PartialEq for RenderPass {
#[inline]
fn eq(&self, other: &Self) -> bool {
self.handle == other.handle && self.device() == other.device()
}
}
impl Eq for RenderPass {}
impl Hash for RenderPass {
#[inline]
fn hash<H: Hasher>(&self, state: &mut H) {
self.handle.hash(state);
self.device.hash(state);
}
}
/// Represents a subpass within a `RenderPass` object.
///
/// This struct doesn't correspond to anything in Vulkan. It is simply an equivalent to a
/// tuple of a render pass and subpass index. Contrary to a tuple, however, the existence of the
/// subpass is checked when the object is created. When you have a `Subpass` you are guaranteed
/// that the given subpass does exist.
#[derive(Debug, Clone)]
pub struct Subpass {
render_pass: Arc<RenderPass>,
subpass_id: u32,
}
impl Subpass {
/// Returns a handle that represents a subpass of a render pass.
#[inline]
pub fn from(render_pass: Arc<RenderPass>, id: u32) -> Option<Subpass> {
if (id as usize) < render_pass.subpasses().len() {
Some(Subpass {
render_pass,
subpass_id: id,
})
} else {
None
}
}
/// Returns the render pass of this subpass.
#[inline]
pub fn render_pass(&self) -> &Arc<RenderPass> {
&self.render_pass
}
/// Returns the index of this subpass within the renderpass.
#[inline]
pub fn index(&self) -> u32 {
self.subpass_id
}
/// Returns the subpass description for this subpass.
#[inline]
pub fn subpass_desc(&self) -> &SubpassDescription {
&self.render_pass.subpasses()[self.subpass_id as usize]
}
/// Returns whether this subpass is the last one in the render pass. If `true` is returned,
/// calling `next_subpass` will panic.
#[inline]
pub fn is_last_subpass(&self) -> bool {
self.subpass_id as usize == self.render_pass.subpasses().len() - 1
}
/// Advances to the next subpass after this one.
///
/// # Panics
///
/// - Panics if there are no more render passes.
#[inline]
pub fn next_subpass(&mut self) {
let next_id = self.subpass_id + 1;
assert!((next_id as usize) < self.render_pass.subpasses().len());
self.subpass_id = next_id;
}
#[inline]
fn attachment_desc(&self, atch_num: u32) -> &AttachmentDescription {
&self.render_pass.attachments()[atch_num as usize]
}
/// Returns the number of color attachments in this subpass.
#[inline]
pub fn num_color_attachments(&self) -> u32 {
self.subpass_desc().color_attachments.len() as u32
}
/// Returns true if the subpass has a depth attachment or a depth-stencil attachment.
#[inline]
pub fn has_depth(&self) -> bool {
let subpass_desc = self.subpass_desc();
let atch_num = match &subpass_desc.depth_stencil_attachment {
Some(atch_ref) => atch_ref.attachment,
None => return false,
};
self.attachment_desc(atch_num)
.format
.map_or(false, |f| f.aspects().depth)
}
/// Returns true if the subpass has a depth attachment or a depth-stencil attachment whose
/// layout does not have a read-only depth layout.
#[inline]
pub fn has_writable_depth(&self) -> bool {
let subpass_desc = self.subpass_desc();
let atch_num = match &subpass_desc.depth_stencil_attachment {
Some(atch_ref) => {
if matches!(
atch_ref.layout,
ImageLayout::DepthStencilReadOnlyOptimal
| ImageLayout::DepthReadOnlyStencilAttachmentOptimal
) {
return false;
}
atch_ref.attachment
}
None => return false,
};
self.attachment_desc(atch_num)
.format
.map_or(false, |f| f.aspects().depth)
}
/// Returns true if the subpass has a stencil attachment or a depth-stencil attachment.
#[inline]
pub fn has_stencil(&self) -> bool {
let subpass_desc = self.subpass_desc();
let atch_num = match &subpass_desc.depth_stencil_attachment {
Some(atch_ref) => atch_ref.attachment,
None => return false,
};
self.attachment_desc(atch_num)
.format
.map_or(false, |f| f.aspects().stencil)
}
/// Returns true if the subpass has a stencil attachment or a depth-stencil attachment whose
/// layout does not have a read-only stencil layout.
#[inline]
pub fn has_writable_stencil(&self) -> bool {
let subpass_desc = self.subpass_desc();
let atch_num = match &subpass_desc.depth_stencil_attachment {
Some(atch_ref) => {
if matches!(
atch_ref.layout,
ImageLayout::DepthStencilReadOnlyOptimal
| ImageLayout::DepthAttachmentStencilReadOnlyOptimal
) {
return false;
}
atch_ref.attachment
}
None => return false,
};
self.attachment_desc(atch_num)
.format
.map_or(false, |f| f.aspects().stencil)
}
/// Returns the number of samples in the color and/or depth/stencil attachments. Returns `None`
/// if there is no such attachment in this subpass.
#[inline]
pub fn num_samples(&self) -> Option<SampleCount> {
let subpass_desc = self.subpass_desc();
// TODO: chain input attachments as well?
subpass_desc
.color_attachments
.iter()
.flatten()
.chain(subpass_desc.depth_stencil_attachment.iter())
.filter_map(|atch_ref| {
self.render_pass
.attachments()
.get(atch_ref.attachment as usize)
})
.next()
.map(|atch_desc| atch_desc.samples)
}
/// Returns `true` if this subpass is compatible with the fragment output definition.
// TODO: return proper error
pub fn is_compatible_with(&self, shader_interface: &ShaderInterface) -> bool {
self.render_pass
.is_compatible_with_shader(self.subpass_id, shader_interface)
}
}
impl From<Subpass> for (Arc<RenderPass>, u32) {
#[inline]
fn from(value: Subpass) -> (Arc<RenderPass>, u32) {
(value.render_pass, value.subpass_id)
}
}
/// Parameters to create a new `RenderPass`.
#[derive(Clone, Debug)]
pub struct RenderPassCreateInfo {
/// The attachments available for the render pass.
///
/// The default value is empty.
pub attachments: Vec<AttachmentDescription>,
/// The subpasses that make up this render pass.
///
/// A render pass must contain at least one subpass.
///
/// The default value is empty, which must be overridden.
pub subpasses: Vec<SubpassDescription>,
/// The dependencies between subpasses.
///
/// The default value is empty.
pub dependencies: Vec<SubpassDependency>,
/// If multiview rendering is being used (the subpasses have a nonzero `view_mask`),
/// this specifies sets of views that may be more efficient to render concurrently, for example
/// because they show the same geometry from almost the same perspective. This is an
/// optimization hint to the implementation, and does not affect the final result.
///
/// The value is a bitmask, so that that for example `0b11` means that the first two views are
/// highly correlated, and `0b101` means the first and third view are highly correlated. Each
/// view bit must appear in at most one element of the list.
///
/// If multiview rendering is not being used, the value must be empty.
///
/// The default value is empty.
pub correlated_view_masks: Vec<u32>,
pub _ne: crate::NonExhaustive,
}
impl Default for RenderPassCreateInfo {
#[inline]
fn default() -> Self {
Self {
attachments: Vec::new(),
subpasses: Vec::new(),
dependencies: Vec::new(),
correlated_view_masks: Vec::new(),
_ne: crate::NonExhaustive(()),
}
}
}
/// Describes an attachment that will be used in a render pass.
#[derive(Clone, Copy, Debug)]
pub struct AttachmentDescription {
/// The format of the image that is going to be bound.
///
/// The default value is `None`, which must be overridden.
pub format: Option<Format>,
/// The number of samples of the image that is going to be bound.
///
/// The default value is [`SampleCount::Sample1`].
pub samples: SampleCount,
/// What the implementation should do with the attachment at the start of the subpass that first
/// uses it.
///
/// The default value is [`LoadOp::DontCare`].
pub load_op: LoadOp,
/// What the implementation should do with the attachment at the end of the subpass that last
/// uses it.
///
/// The default value is [`StoreOp::DontCare`].
pub store_op: StoreOp,
/// The equivalent of `load_op` for the stencil component of the attachment, if any. Irrelevant
/// if there is no stencil component.
///
/// The default value is [`LoadOp::DontCare`].
pub stencil_load_op: LoadOp,
/// The equivalent of `store_op` for the stencil component of the attachment, if any. Irrelevant
/// if there is no stencil component.
///
/// The default value is [`StoreOp::DontCare`].
pub stencil_store_op: StoreOp,
/// The layout that the image must in at the start of the render pass.
///
/// The vulkano library will automatically switch to the correct layout if necessary, but it
/// is more efficient to set this to the correct value.
///
/// The default value is [`ImageLayout::Undefined`], which must be overridden.
pub initial_layout: ImageLayout,
/// The layout that the image will be transitioned to at the end of the render pass.
///
/// The default value is [`ImageLayout::Undefined`], which must be overridden.
pub final_layout: ImageLayout,
pub _ne: crate::NonExhaustive,
}
impl Default for AttachmentDescription {
#[inline]
fn default() -> Self {
Self {
format: None,
samples: SampleCount::Sample1,
load_op: LoadOp::DontCare,
store_op: StoreOp::DontCare,
stencil_load_op: LoadOp::DontCare,
stencil_store_op: StoreOp::DontCare,
initial_layout: ImageLayout::Undefined,
final_layout: ImageLayout::Undefined,
_ne: crate::NonExhaustive(()),
}
}
}
/// Describes one of the subpasses of a render pass.
///
/// A subpass can use zero or more attachments of various types. Attachment types of which there can
/// be multiple are listed in a `Vec` in this structure. The index in these `Vec`s corresponds to
/// the index used for that attachment type in the shader.
///
/// If a particular index is not used in the shader, it can be set to `None` in this structure.
/// This is useful if an unused index needs to be skipped but a higher index needs to be specified.
///
/// If an attachment is used more than once, i.e. a given `AttachmentReference::attachment` occurs
/// more than once in the `SubpassDescription`, then their `AttachmentReference::layout` must be
/// the same as well.
#[derive(Debug, Clone)]
pub struct SubpassDescription {
/// If not `0`, enables multiview rendering, and specifies the view indices that are rendered to
/// in this subpass. 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, it must be nonzero for all subpasses in the render pass, and the
/// [`multiview`](crate::device::Features::multiview) feature must be enabled on the device.
///
/// The default value is `0`.
pub view_mask: u32,
/// The attachments of the render pass that are to be used as input attachments in this subpass.
///
/// If an attachment is used here for the first time in this render pass, and it's is not also
/// used as a color or depth/stencil attachment in this subpass, then the attachment's `load_op`
/// must not be [`LoadOp::Clear`].
///
/// The default value is empty.
pub input_attachments: Vec<Option<AttachmentReference>>,
/// The attachments of the render pass that are to be used as color attachments in this subpass.
///
/// The number of color attachments must be less than the
/// [`max_color_attachments`](crate::device::Properties::max_color_attachments) limit of the
/// physical device. All color attachments must have the same `samples` value.
///
/// The default value is empty.
pub color_attachments: Vec<Option<AttachmentReference>>,
/// The attachments of the render pass that are to be used as resolve attachments in this
/// subpass.
///
/// This list must either be empty or have the same length as `color_attachments`. If it's not
/// empty, then each resolve attachment is paired with the color attachment of the same index.
/// The resolve attachments must all have a `samples` value of [`SampleCount::Sample1`], while
/// the color attachments must have a `samples` value other than [`SampleCount::Sample1`].
/// Each resolve attachment must have the same `format` as the corresponding color attachment.
///
/// The default value is empty.
pub resolve_attachments: Vec<Option<AttachmentReference>>,
/// The single attachment of the render pass that is to be used as depth-stencil attachment in
/// this subpass.
///
/// If set to `Some`, the referenced attachment must have the same `samples` value as those in
/// `color_attachments`.
///
/// The default value is `None`.
pub depth_stencil_attachment: Option<AttachmentReference>,
/// The indices of attachments of the render pass that will be preserved during this subpass.
///
/// The referenced attachments must not be used as any other attachment type in the subpass.
///
/// The default value is empty.
pub preserve_attachments: Vec<u32>,
pub _ne: crate::NonExhaustive,
}
impl Default for SubpassDescription {
#[inline]
fn default() -> Self {
Self {
view_mask: 0,
color_attachments: Vec::new(),
depth_stencil_attachment: None,
input_attachments: Vec::new(),
resolve_attachments: Vec::new(),
preserve_attachments: Vec::new(),
_ne: crate::NonExhaustive(()),
}
}
}
/// A reference in a subpass description to a particular attachment of the render pass.
#[derive(Clone, Debug)]
pub struct AttachmentReference {
/// The number of the attachment being referred to.
///
/// The default value is `0`.
pub attachment: u32,
/// The image layout that the attachment should be transitioned to at the start of the subpass.
///
/// The layout is restricted by the type of attachment that an attachment is being used as. A
/// full listing of allowed layouts per type can be found in
/// [the Vulkan specification](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap8.html#attachment-type-imagelayout).
///
/// The default value is [`ImageLayout::Undefined`], which must be overridden.
pub layout: ImageLayout,
/// For references to input attachments, the aspects of the image that should be selected.
/// For attachment types other than input attachments, the value must be empty.
///
/// If empty, all aspects available in the input attachment's `format` will be selected.
/// If any fields are set, they must be aspects that are available in the `format` of the
/// attachment.
///
/// If the value is neither empty nor identical to the aspects of the `format`, the device API
/// version must be at least 1.1, or either the
/// [`khr_create_renderpass2`](crate::device::DeviceExtensions::khr_create_renderpass2) or the
/// [`khr_maintenance2`](crate::device::DeviceExtensions::khr_maintenance2) extensions must be
/// enabled on the device.
///
/// The default value is [`ImageAspects::empty()`].
pub aspects: ImageAspects,
pub _ne: crate::NonExhaustive,
}
impl Default for AttachmentReference {
#[inline]
fn default() -> Self {
Self {
attachment: 0,
layout: ImageLayout::Undefined,
aspects: ImageAspects::empty(),
_ne: crate::NonExhaustive(()),
}
}
}
/// A dependency between two subpasses of a render pass.
///
/// The implementation is allowed to change the order of the subpasses within a render pass, unless
/// you specify that there exists a dependency between two subpasses (ie. the result of one will be
/// used as the input of another one). Subpass dependencies work similar to pipeline barriers,
/// except that they operate on whole subpasses instead of individual images.
///
/// If `source_subpass` and `destination_subpass` are equal, then this specifies a
/// [subpass self-dependency](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-pipeline-barriers-subpass-self-dependencies).
/// The `source_stages` must all be
/// [logically earlier in the pipeline](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-pipeline-stages-order)
/// than the `destination_stages`, and if they both contain a
/// [framebuffer-space stage](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/chap7.html#synchronization-framebuffer-regions),
/// then `by_region` must be activated.
///
/// If `source_subpass` or `destination_subpass` are set to `None`, this specifies an external
/// dependency. An external dependency specifies a dependency on commands that were submitted before
/// the render pass instance began (for `source_subpass`), or on commands that will be submitted
/// after the render pass instance ends (for `destination_subpass`). The values must not both be
/// `None`.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct SubpassDependency {
/// The index of the subpass that writes the data that `destination_subpass` is going to use.
///
/// `None` specifies an external dependency.
///
/// The default value is `None`.
pub source_subpass: Option<u32>,
/// The index of the subpass that reads the data that `source_subpass` wrote.
///
/// `None` specifies an external dependency.
///
/// The default value is `None`.
pub destination_subpass: Option<u32>,
/// The pipeline stages that must be finished on `source_subpass` before the
/// `destination_stages` of `destination_subpass` can start.
///
/// The default value is [`PipelineStages::empty()`].
pub source_stages: PipelineStages,
/// The pipeline stages of `destination_subpass` that must wait for the `source_stages` of
/// `source_subpass` to be finished. Stages that are earlier than the stages specified here can
/// start before the `source_stages` are finished.
///
/// The default value is [`PipelineStages::empty()`].
pub destination_stages: PipelineStages,
/// The way `source_subpass` accesses the attachments on which we depend.
///
/// The default value is [`AccessFlags::empty()`].
pub source_access: AccessFlags,
/// The way `destination_subpass` accesses the attachments on which we depend.
///
/// The default value is [`AccessFlags::empty()`].
pub destination_access: AccessFlags,
/// If false, then the source operations must be fully finished for the destination operations
/// to start. If true, then the implementation can start the destination operation for some
/// given pixels as long as the source operation is finished for these given pixels.
///
/// In other words, if the previous subpass has some side effects on other parts of an
/// attachment, then you should set it to false.
///
/// Passing `false` is always safer than passing `true`, but in practice you rarely need to
/// pass `false`.
///
/// The default value is `false`.
pub by_region: bool,
/// If multiview rendering is being used (the subpasses have a nonzero `view_mask`), then
/// setting this to `Some` creates a view-local dependency, between views in `source_subpass`
/// and views in `destination_subpass`.
///
/// The inner value specifies an offset relative to the view index of `destination_subpass`:
/// each view `d` in `destination_subpass` depends on view `d + view_offset` in
/// `source_subpass`. If the source view index does not exist, the dependency is ignored for
/// that view.
///
/// If multiview rendering is not being used, the value must be `None`. If `source_subpass`
/// and `destination_subpass` are the same, only `Some(0)` and `None` are allowed as values, and
/// if that subpass also has multiple bits set in its `view_mask`, the value must be `Some(0)`.
///
/// The default value is `None`.
pub view_local: Option<i32>,
pub _ne: crate::NonExhaustive,
}
impl Default for SubpassDependency {
#[inline]
fn default() -> Self {
Self {
source_subpass: None,
destination_subpass: None,
source_stages: PipelineStages::empty(),
destination_stages: PipelineStages::empty(),
source_access: AccessFlags::empty(),
destination_access: AccessFlags::empty(),
by_region: false,
view_local: None,
_ne: crate::NonExhaustive(()),
}
}
}
vulkan_enum! {
/// Describes what the implementation should do with an attachment at the start of the subpass.
#[non_exhaustive]
LoadOp = AttachmentLoadOp(i32);
/// The content of the attachment will be loaded from memory. This is what you want if you want
/// to draw over something existing.
///
/// While this is the most intuitive option, it is also the slowest because it uses a lot of
/// memory bandwidth.
Load = LOAD,
/// The content of the attachment will be filled by the implementation with a uniform value
/// that you must provide when you start drawing.
///
/// This is what you usually use at the start of a frame, in order to reset the content of
/// the color, depth and/or stencil buffers.
Clear = CLEAR,
/// The attachment will have undefined content.
///
/// This is what you should use for attachments that you intend to entirely cover with draw
/// commands.
/// If you are going to fill the attachment with a uniform value, it is better to use `Clear`
/// instead.
DontCare = DONT_CARE,
/*
// TODO: document
None = NONE_EXT {
device_extensions: [ext_load_store_op_none],
},
*/
}
vulkan_enum! {
/// Describes what the implementation should do with an attachment after all the subpasses have
/// completed.
#[non_exhaustive]
StoreOp = AttachmentStoreOp(i32);
/// The attachment will be stored. This is what you usually want.
///
/// While this is the most intuitive option, it is also slower than `DontCare` because it can
/// take time to write the data back to memory.
Store = STORE,
/// What happens is implementation-specific.
///
/// This is purely an optimization compared to `Store`. The implementation doesn't need to copy
/// from the internal cache to the memory, which saves memory bandwidth.
///
/// This doesn't mean that the data won't be copied, as an implementation is also free to not
/// use a cache and write the output directly in memory. In other words, the content of the
/// image will be undefined.
DontCare = DONT_CARE,
/*
// TODO: document
None = NONE {
api_version: V1_3,
device_extensions: [ext_load_store_op_none],
},
*/
}
vulkan_enum! {
/// Possible resolve modes for attachments.
#[non_exhaustive]
ResolveMode = ResolveModeFlags(u32);
/// The resolved sample is taken from sample number zero, the other samples are ignored.
///
/// This mode is supported for depth and stencil formats, and for color images with an integer
/// format.
SampleZero = SAMPLE_ZERO,
/// The resolved sample is calculated from the average of the samples.
///
/// This mode is supported for depth formats, and for color images with a non-integer format.
Average = AVERAGE,
/// The resolved sample is calculated from the minimum of the samples.
///
/// This mode is supported for depth and stencil formats only.
Min = MIN,
/// The resolved sample is calculated from the maximum of the samples.
///
/// This mode is supported for depth and stencil formats only.
Max = MAX,
}
vulkan_bitflags! {
// TODO: document
#[non_exhaustive]
ResolveModes = ResolveModeFlags(u32);
// TODO: document
sample_zero = SAMPLE_ZERO,
// TODO: document
average = AVERAGE,
// TODO: document
min = MIN,
// TODO: document
max = MAX,
}
impl ResolveModes {
/// Returns whether `self` contains the given `mode`.
#[inline]
pub fn contains_mode(&self, mode: ResolveMode) -> bool {
match mode {
ResolveMode::SampleZero => self.sample_zero,
ResolveMode::Average => self.average,
ResolveMode::Min => self.min,
ResolveMode::Max => self.max,
}
}
}
#[cfg(test)]
mod tests {
use crate::{
format::Format,
render_pass::{RenderPass, RenderPassCreationError},
};
#[test]
fn empty() {
let (device, _) = gfx_dev_and_queue!();
let _ = RenderPass::empty_single_pass(device).unwrap();
}
#[test]
fn too_many_color_atch() {
let (device, _) = gfx_dev_and_queue!();
if device.physical_device().properties().max_color_attachments >= 10 {
return; // test ignored
}
let rp = single_pass_renderpass! {
device,
attachments: {
a1: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a2: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a3: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a4: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a5: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a6: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a7: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a8: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a9: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, },
a10: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, }
},
pass: {
color: [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10],
depth_stencil: {}
}
};
match rp {
Err(RenderPassCreationError::SubpassMaxColorAttachmentsExceeded { .. }) => (),
_ => panic!(),
}
}
#[test]
fn non_zero_granularity() {
let (device, _) = gfx_dev_and_queue!();
let rp = single_pass_renderpass! {
device,
attachments: {
a: { load: Clear, store: DontCare, format: Format::R8G8B8A8_UNORM, samples: 1, }
},
pass: {
color: [a],
depth_stencil: {}
}
}
.unwrap();
let granularity = rp.granularity();
assert_ne!(granularity[0], 0);
assert_ne!(granularity[1], 0);
}
}