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 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
// 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.
//! The layout of descriptor sets and push constants used by a pipeline.
//!
//! # Overview
//!
//! The layout itself only *describes* the descriptors and push constants, and does not contain
//! their content itself. Instead, you can think of it as a `struct` definition that states which
//! members there are, what types they have, and in what order.
//! One could imagine a Rust definition somewhat like this:
//!
//! ```text
//! #[repr(C)]
//! struct MyPipelineLayout {
//! push_constants: Pc,
//! descriptor_set0: Ds0,
//! descriptor_set1: Ds1,
//! descriptor_set2: Ds2,
//! descriptor_set3: Ds3,
//! }
//! ```
//!
//! Of course, a pipeline layout is created at runtime, unlike a Rust type.
//!
//! # Layout compatibility
//!
//! When binding descriptor sets or setting push constants, you must provide a pipeline layout.
//! This layout is used to decide where in memory Vulkan should write the new data. The
//! descriptor sets and push constants can later be read by dispatch or draw calls, but only if
//! the bound pipeline being used for the command has a layout that is *compatible* with the layout
//! that was used to bind the resources.
//!
//! *Compatible* means that the pipeline layout must be the same object, or a different layout in
//! which the push constant ranges and descriptor set layouts were be identically defined.
//! However, Vulkan allows for partial compatibility as well. In the `struct` analogy used above,
//! one could imagine that using a different definition would leave some members with the same
//! offset and size within the struct as in the old definition, while others are no longer
//! positioned correctly. For example, if a new, incompatible type were used for `Ds1`, then the
//! `descriptor_set1`, `descriptor_set2` and `descriptor_set3` members would no longer be correct,
//! but `descriptor_set0` and `push_constants` would remain accessible in the new layout.
//! Because of this behaviour, the following rules apply to compatibility between the layouts used
//! in subsequent descriptor set binding calls:
//!
//! - An incompatible definition of `Pc` invalidates all bound descriptor sets.
//! - An incompatible definition of `DsN` invalidates all bound descriptor sets *N* and higher.
//! - If *N* is the highest set being assigned in a bind command, and it and all lower sets
//! have compatible definitions, including the push constants, then descriptor sets above *N*
//! remain valid.
//!
//! [`AutoCommandBufferBuilder`](crate::command_buffer::auto::AutoCommandBufferBuilder) keeps
//! track of this state and will automatically remove descriptor sets that have been invalidated
//! by incompatible layouts in subsequent binding commands.
//!
//! # Creating pipeline layouts
//!
//! A pipeline layout is a Vulkan object type, represented in Vulkano with the `PipelineLayout`
//! type. Each pipeline that you create holds a pipeline layout object.
use super::PipelineShaderStageCreateInfo;
use crate::{
descriptor_set::layout::{
DescriptorSetLayout, DescriptorSetLayoutBinding, DescriptorSetLayoutCreateFlags,
DescriptorSetLayoutCreateInfo, DescriptorType,
},
device::{Device, DeviceOwned, DeviceOwnedDebugWrapper, Properties},
instance::InstanceOwnedDebugWrapper,
macros::{impl_id_counter, vulkan_bitflags},
shader::{DescriptorBindingRequirements, ShaderStage, ShaderStages},
Validated, ValidationError, VulkanError, VulkanObject,
};
use ahash::HashMap;
use smallvec::SmallVec;
use std::{
array,
cmp::max,
collections::hash_map::Entry,
error::Error,
fmt::{Display, Formatter, Write},
mem::MaybeUninit,
num::NonZeroU64,
ptr,
sync::Arc,
};
/// Describes the layout of descriptor sets and push constants that are made available to shaders.
#[derive(Debug)]
pub struct PipelineLayout {
handle: ash::vk::PipelineLayout,
device: InstanceOwnedDebugWrapper<Arc<Device>>,
id: NonZeroU64,
flags: PipelineLayoutCreateFlags,
set_layouts: Vec<DeviceOwnedDebugWrapper<Arc<DescriptorSetLayout>>>,
push_constant_ranges: Vec<PushConstantRange>,
push_constant_ranges_disjoint: Vec<PushConstantRange>,
}
impl PipelineLayout {
/// Creates a new `PipelineLayout`.
pub fn new(
device: Arc<Device>,
create_info: PipelineLayoutCreateInfo,
) -> Result<Arc<PipelineLayout>, Validated<VulkanError>> {
Self::validate_new(&device, &create_info)?;
unsafe { Ok(Self::new_unchecked(device, create_info)?) }
}
fn validate_new(
device: &Device,
create_info: &PipelineLayoutCreateInfo,
) -> Result<(), Box<ValidationError>> {
// VUID-vkCreatePipelineLayout-pCreateInfo-parameter
create_info
.validate(device)
.map_err(|err| err.add_context("create_info"))?;
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn new_unchecked(
device: Arc<Device>,
create_info: PipelineLayoutCreateInfo,
) -> Result<Arc<PipelineLayout>, VulkanError> {
let &PipelineLayoutCreateInfo {
flags,
ref set_layouts,
ref push_constant_ranges,
_ne: _,
} = &create_info;
let set_layouts_vk: SmallVec<[_; 4]> = set_layouts.iter().map(|l| l.handle()).collect();
let push_constant_ranges_vk: SmallVec<[_; 4]> = push_constant_ranges
.iter()
.map(|range| ash::vk::PushConstantRange {
stage_flags: range.stages.into(),
offset: range.offset,
size: range.size,
})
.collect();
let create_info_vk = ash::vk::PipelineLayoutCreateInfo {
flags: flags.into(),
set_layout_count: set_layouts_vk.len() as u32,
p_set_layouts: set_layouts_vk.as_ptr(),
push_constant_range_count: push_constant_ranges_vk.len() as u32,
p_push_constant_ranges: push_constant_ranges_vk.as_ptr(),
..Default::default()
};
let handle = {
let fns = device.fns();
let mut output = MaybeUninit::uninit();
(fns.v1_0.create_pipeline_layout)(
device.handle(),
&create_info_vk,
ptr::null(),
output.as_mut_ptr(),
)
.result()
.map_err(VulkanError::from)?;
output.assume_init()
};
Ok(Self::from_handle(device, handle, create_info))
}
/// Creates a new `PipelineLayout` 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.
#[inline]
pub unsafe fn from_handle(
device: Arc<Device>,
handle: ash::vk::PipelineLayout,
create_info: PipelineLayoutCreateInfo,
) -> Arc<PipelineLayout> {
let PipelineLayoutCreateInfo {
flags,
set_layouts,
mut push_constant_ranges,
_ne: _,
} = create_info;
// Sort the ranges for the purpose of comparing for equality.
// The stage mask is guaranteed to be unique, so it's a suitable sorting key.
push_constant_ranges.sort_unstable_by_key(|range| {
(
range.offset,
range.size,
ash::vk::ShaderStageFlags::from(range.stages),
)
});
let mut push_constant_ranges_disjoint: Vec<PushConstantRange> =
Vec::with_capacity(push_constant_ranges.len());
if !push_constant_ranges.is_empty() {
let mut min_offset = push_constant_ranges[0].offset;
loop {
let mut max_offset = u32::MAX;
let mut stages = ShaderStages::empty();
for range in push_constant_ranges.iter() {
// new start (begin next time from it)
if range.offset > min_offset {
max_offset = max_offset.min(range.offset);
break;
} else if range.offset + range.size > min_offset {
// inside the range, include the stage
// use the minimum of the end of all ranges that are overlapping
max_offset = max_offset.min(range.offset + range.size);
stages |= range.stages;
}
}
// finished all stages
if stages.is_empty() {
break;
}
push_constant_ranges_disjoint.push(PushConstantRange {
stages,
offset: min_offset,
size: max_offset - min_offset,
});
// prepare for next range
min_offset = max_offset;
}
}
Arc::new(PipelineLayout {
handle,
device: InstanceOwnedDebugWrapper(device),
id: Self::next_id(),
flags,
set_layouts: set_layouts
.into_iter()
.map(DeviceOwnedDebugWrapper)
.collect(),
push_constant_ranges,
push_constant_ranges_disjoint,
})
}
/// Returns the flags that the pipeline layout was created with.
#[inline]
pub fn flags(&self) -> PipelineLayoutCreateFlags {
self.flags
}
/// Returns the descriptor set layouts this pipeline layout was created from.
#[inline]
pub fn set_layouts(&self) -> &[Arc<DescriptorSetLayout>] {
DeviceOwnedDebugWrapper::cast_slice_inner(&self.set_layouts)
}
/// Returns a slice containing the push constant ranges this pipeline layout was created from.
///
/// The ranges are guaranteed to be sorted deterministically by offset, size, then stages.
/// This means that two slices containing the same elements will always have the same order.
#[inline]
pub fn push_constant_ranges(&self) -> &[PushConstantRange] {
&self.push_constant_ranges
}
/// Returns a slice containing the push constant ranges in with all disjoint stages.
///
/// For example, if we have these `push_constant_ranges`:
/// - `offset=0, size=4, stages=vertex`
/// - `offset=0, size=12, stages=fragment`
///
/// The returned value will be:
/// - `offset=0, size=4, stages=vertex|fragment`
/// - `offset=4, size=8, stages=fragment`
///
/// The ranges are guaranteed to be sorted deterministically by offset, and
/// guaranteed to be disjoint, meaning that there is no overlap between the ranges.
#[inline]
pub(crate) fn push_constant_ranges_disjoint(&self) -> &[PushConstantRange] {
&self.push_constant_ranges_disjoint
}
/// Returns whether `self` is compatible with `other` for the given number of sets.
#[inline]
pub fn is_compatible_with(&self, other: &PipelineLayout, num_sets: u32) -> bool {
let num_sets = num_sets as usize;
assert!(num_sets >= self.set_layouts.len());
if self == other {
return true;
}
if self.push_constant_ranges != other.push_constant_ranges {
return false;
}
let other_sets = match other.set_layouts.get(0..num_sets) {
Some(x) => x,
None => return false,
};
self.set_layouts
.iter()
.zip(other_sets)
.all(|(self_set_layout, other_set_layout)| {
self_set_layout.is_compatible_with(other_set_layout)
})
}
/// Makes sure that `self` is a superset of the provided descriptor set layouts and push
/// constant ranges. Returns an `Err` if this is not the case.
pub(crate) fn ensure_compatible_with_shader<'a>(
&self,
descriptor_requirements: impl IntoIterator<
Item = ((u32, u32), &'a DescriptorBindingRequirements),
>,
push_constant_range: Option<&PushConstantRange>,
) -> Result<(), Box<ValidationError>> {
for ((set_num, binding_num), reqs) in descriptor_requirements.into_iter() {
let layout_binding = self
.set_layouts
.get(set_num as usize)
.and_then(|set_layout| set_layout.bindings().get(&binding_num));
let layout_binding = match layout_binding {
Some(x) => x,
None => {
return Err(Box::new(ValidationError {
problem: format!(
"the requirements for descriptor set {} binding {} were not met: \
no such binding exists in the pipeline layout",
set_num, binding_num,
)
.into(),
..Default::default()
}));
}
};
if let Err(error) = layout_binding.ensure_compatible_with_shader(reqs) {
return Err(Box::new(ValidationError {
problem: format!(
"the requirements for descriptor set {} binding {} were not met: {}",
set_num, binding_num, error,
)
.into(),
..Default::default()
}));
}
}
if let Some(range) = push_constant_range {
for own_range in self.push_constant_ranges.iter() {
if range.stages.intersects(own_range.stages) && // check if it shares any stages
(range.offset < own_range.offset || // our range must start before and end after the given range
own_range.offset + own_range.size < range.offset + range.size)
{
return Err(Box::new(ValidationError {
problem: "the required push constant range is larger than the \
push constant range in the pipeline layout"
.into(),
..Default::default()
}));
}
}
}
Ok(())
}
}
impl Drop for PipelineLayout {
#[inline]
fn drop(&mut self) {
unsafe {
let fns = self.device.fns();
(fns.v1_0.destroy_pipeline_layout)(self.device.handle(), self.handle, ptr::null());
}
}
}
unsafe impl VulkanObject for PipelineLayout {
type Handle = ash::vk::PipelineLayout;
#[inline]
fn handle(&self) -> Self::Handle {
self.handle
}
}
unsafe impl DeviceOwned for PipelineLayout {
#[inline]
fn device(&self) -> &Arc<Device> {
&self.device
}
}
impl_id_counter!(PipelineLayout);
/// Parameters to create a new `PipelineLayout`.
#[derive(Clone, Debug)]
pub struct PipelineLayoutCreateInfo {
/// Additional properties of the pipeline layout.
///
/// The default value is empty.
pub flags: PipelineLayoutCreateFlags,
/// The descriptor set layouts that should be part of the pipeline layout.
///
/// They are provided in order of set number.
///
/// The default value is empty.
pub set_layouts: Vec<Arc<DescriptorSetLayout>>,
/// The ranges of push constants that the pipeline will access.
///
/// A shader stage can only appear in one element of the list, but it is possible to combine
/// ranges for multiple shader stages if they are the same.
///
/// The default value is empty.
pub push_constant_ranges: Vec<PushConstantRange>,
pub _ne: crate::NonExhaustive,
}
impl Default for PipelineLayoutCreateInfo {
#[inline]
fn default() -> Self {
Self {
flags: PipelineLayoutCreateFlags::empty(),
set_layouts: Vec::new(),
push_constant_ranges: Vec::new(),
_ne: crate::NonExhaustive(()),
}
}
}
impl PipelineLayoutCreateInfo {
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let properties = device.physical_device().properties();
let &Self {
flags,
ref set_layouts,
ref push_constant_ranges,
_ne: _,
} = self;
flags.validate_device(device).map_err(|err| {
err.add_context("flags")
.set_vuids(&["VUID-VkPipelineLayoutCreateInfo-flags-parameter"])
})?;
if set_layouts.len() > properties.max_bound_descriptor_sets as usize {
return Err(Box::new(ValidationError {
context: "set_layouts".into(),
problem: "the length exceeds the `max_bound_descriptor_sets` limit".into(),
vuids: &["VUID-VkPipelineLayoutCreateInfo-setLayoutCount-00286"],
..Default::default()
}));
}
struct DescriptorLimit {
descriptor_types: &'static [DescriptorType],
get_limit_all: fn(&Properties) -> Option<u32>,
limit_name_all: &'static str,
vuids_all: &'static [&'static str],
get_limit_not_uab: fn(&Properties) -> u32,
limit_name_not_uab: &'static str,
vuids_not_uab: &'static [&'static str],
}
const PER_STAGE_DESCRIPTOR_LIMITS: [DescriptorLimit; 8] = [
DescriptorLimit {
descriptor_types: &[
DescriptorType::Sampler,
DescriptorType::CombinedImageSampler,
],
get_limit_all: |p| p.max_per_stage_descriptor_update_after_bind_samplers,
limit_name_all: "max_per_stage_descriptor_update_after_bind_samplers",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03022"],
get_limit_not_uab: |p| p.max_per_stage_descriptor_samplers,
limit_name_not_uab: "max_per_stage_descriptor_samplers",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03016"],
},
DescriptorLimit {
descriptor_types: &[
DescriptorType::UniformBuffer,
DescriptorType::UniformBufferDynamic,
],
get_limit_all: |p| p.max_per_stage_descriptor_update_after_bind_uniform_buffers,
limit_name_all: "max_per_stage_descriptor_update_after_bind_uniform_buffers",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03023"],
get_limit_not_uab: |p| p.max_per_stage_descriptor_uniform_buffers,
limit_name_not_uab: "max_per_stage_descriptor_uniform_buffers",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03017"],
},
DescriptorLimit {
descriptor_types: &[
DescriptorType::StorageBuffer,
DescriptorType::StorageBufferDynamic,
],
get_limit_all: |p| p.max_per_stage_descriptor_update_after_bind_storage_buffers,
limit_name_all: "max_per_stage_descriptor_update_after_bind_storage_buffers",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03024"],
get_limit_not_uab: |p| p.max_per_stage_descriptor_storage_buffers,
limit_name_not_uab: "max_per_stage_descriptor_storage_buffers",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03018"],
},
DescriptorLimit {
descriptor_types: &[
DescriptorType::CombinedImageSampler,
DescriptorType::SampledImage,
DescriptorType::UniformTexelBuffer,
],
get_limit_all: |p| p.max_per_stage_descriptor_update_after_bind_sampled_images,
limit_name_all: "max_per_stage_descriptor_update_after_bind_sampled_images",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03025"],
get_limit_not_uab: |p| p.max_per_stage_descriptor_sampled_images,
limit_name_not_uab: "max_per_stage_descriptor_sampled_images",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-06939"],
},
DescriptorLimit {
descriptor_types: &[
DescriptorType::StorageImage,
DescriptorType::StorageTexelBuffer,
],
get_limit_all: |p| p.max_per_stage_descriptor_update_after_bind_storage_images,
limit_name_all: "max_per_stage_descriptor_update_after_bind_storage_images",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03026"],
get_limit_not_uab: |p| p.max_per_stage_descriptor_storage_images,
limit_name_not_uab: "max_per_stage_descriptor_storage_images",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03020"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::InputAttachment],
get_limit_all: |p| p.max_per_stage_descriptor_update_after_bind_input_attachments,
limit_name_all: "max_per_stage_descriptor_update_after_bind_input_attachments",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03027"],
get_limit_not_uab: |p| p.max_per_stage_descriptor_input_attachments,
limit_name_not_uab: "max_per_stage_descriptor_input_attachments",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03021"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::InlineUniformBlock],
get_limit_all: |p| {
p.max_per_stage_descriptor_update_after_bind_inline_uniform_blocks
},
limit_name_all: "max_per_stage_descriptor_update_after_bind_inline_uniform_blocks",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-02215"],
get_limit_not_uab: |p| {
p.max_per_stage_descriptor_inline_uniform_blocks
.unwrap_or(0)
},
limit_name_not_uab: "max_per_stage_descriptor_inline_uniform_blocks",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-02214"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::AccelerationStructure],
get_limit_all: |p| {
p.max_per_stage_descriptor_update_after_bind_acceleration_structures
},
limit_name_all:
"max_per_stage_descriptor_update_after_bind_acceleration_structures",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03572"],
get_limit_not_uab: |p| {
p.max_per_stage_descriptor_acceleration_structures
.unwrap_or(0)
},
limit_name_not_uab: "max_per_stage_descriptor_acceleration_structures",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03571"],
},
];
const TOTAL_DESCRIPTOR_LIMITS: [DescriptorLimit; 10] = [
DescriptorLimit {
descriptor_types: &[
DescriptorType::Sampler,
DescriptorType::CombinedImageSampler,
],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_samplers,
limit_name_all: "max_descriptor_set_update_after_bind_samplers",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03036"],
get_limit_not_uab: |p| p.max_descriptor_set_samplers,
limit_name_not_uab: "max_descriptor_set_samplers",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03028"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::UniformBuffer],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_uniform_buffers,
limit_name_all: "max_descriptor_set_update_after_bind_uniform_buffers",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03037"],
get_limit_not_uab: |p| p.max_descriptor_set_uniform_buffers,
limit_name_not_uab: "max_descriptor_set_uniform_buffers",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03029"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::UniformBufferDynamic],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_uniform_buffers_dynamic,
limit_name_all: "max_descriptor_set_update_after_bind_uniform_buffers_dynamic",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03038"],
get_limit_not_uab: |p| p.max_descriptor_set_uniform_buffers_dynamic,
limit_name_not_uab: "max_descriptor_set_uniform_buffers_dynamic",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03030"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::StorageBuffer],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_storage_buffers,
limit_name_all: "max_descriptor_set_update_after_bind_storage_buffers",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03039"],
get_limit_not_uab: |p| p.max_descriptor_set_storage_buffers,
limit_name_not_uab: "max_descriptor_set_storage_buffers",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03031"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::StorageBufferDynamic],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_storage_buffers_dynamic,
limit_name_all: "max_descriptor_set_update_after_bind_storage_buffers_dynamic",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03040"],
get_limit_not_uab: |p| p.max_descriptor_set_storage_buffers_dynamic,
limit_name_not_uab: "max_descriptor_set_storage_buffers_dynamic",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03032"],
},
DescriptorLimit {
descriptor_types: &[
DescriptorType::CombinedImageSampler,
DescriptorType::SampledImage,
DescriptorType::UniformTexelBuffer,
],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_sampled_images,
limit_name_all: "max_descriptor_set_update_after_bind_sampled_images",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03041"],
get_limit_not_uab: |p| p.max_descriptor_set_sampled_images,
limit_name_not_uab: "max_descriptor_set_sampled_images",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03033"],
},
DescriptorLimit {
descriptor_types: &[
DescriptorType::StorageImage,
DescriptorType::StorageTexelBuffer,
],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_storage_images,
limit_name_all: "max_descriptor_set_update_after_bind_storage_images",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03042"],
get_limit_not_uab: |p| p.max_descriptor_set_storage_images,
limit_name_not_uab: "max_descriptor_set_storage_images",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03034"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::InputAttachment],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_input_attachments,
limit_name_all: "max_descriptor_set_update_after_bind_input_attachments",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-03043"],
get_limit_not_uab: |p| p.max_descriptor_set_input_attachments,
limit_name_not_uab: "max_descriptor_set_input_attachments",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03035"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::InlineUniformBlock],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_inline_uniform_blocks,
limit_name_all: "max_descriptor_set_update_after_bind_inline_uniform_blocks",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-02217"],
get_limit_not_uab: |p| p.max_descriptor_set_inline_uniform_blocks.unwrap_or(0),
limit_name_not_uab: "max_descriptor_set_inline_uniform_blocks",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-02216"],
},
DescriptorLimit {
descriptor_types: &[DescriptorType::AccelerationStructure],
get_limit_all: |p| p.max_descriptor_set_update_after_bind_acceleration_structures,
limit_name_all: "max_descriptor_set_update_after_bind_acceleration_structures",
vuids_all: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03574"],
get_limit_not_uab: |p| p.max_descriptor_set_acceleration_structures.unwrap_or(0),
limit_name_not_uab: "max_descriptor_set_acceleration_structures",
vuids_not_uab: &["VUID-VkPipelineLayoutCreateInfo-descriptorType-03573"],
},
];
let mut per_stage_descriptors_all: [HashMap<ShaderStage, u32>;
PER_STAGE_DESCRIPTOR_LIMITS.len()] = array::from_fn(|_| HashMap::default());
let mut per_stage_descriptors_not_uab: [HashMap<ShaderStage, u32>;
PER_STAGE_DESCRIPTOR_LIMITS.len()] = array::from_fn(|_| HashMap::default());
let mut total_descriptors_all = [0; TOTAL_DESCRIPTOR_LIMITS.len()];
let mut total_descriptors_not_uab = [0; TOTAL_DESCRIPTOR_LIMITS.len()];
let mut has_push_descriptor_set = false;
for (_set_num, set_layout) in set_layouts.iter().enumerate() {
assert_eq!(device, set_layout.device().as_ref());
if set_layout
.flags()
.intersects(DescriptorSetLayoutCreateFlags::PUSH_DESCRIPTOR)
{
if has_push_descriptor_set {
return Err(Box::new(ValidationError {
context: "set_layouts".into(),
problem: "contains more than one descriptor set layout whose flags \
include `DescriptorSetLayoutCreateFlags::PUSH_DESCRIPTOR`"
.into(),
vuids: &["VUID-VkPipelineLayoutCreateInfo-pSetLayouts-00293"],
..Default::default()
}));
}
has_push_descriptor_set = true;
}
let is_not_uab = !set_layout
.flags()
.intersects(DescriptorSetLayoutCreateFlags::UPDATE_AFTER_BIND_POOL);
for layout_binding in set_layout.bindings().values() {
let &DescriptorSetLayoutBinding {
binding_flags: _,
descriptor_type,
descriptor_count,
stages,
immutable_samplers: _,
_ne: _,
} = layout_binding;
for ((limit, count_all), count_not_uab) in PER_STAGE_DESCRIPTOR_LIMITS
.iter()
.zip(&mut per_stage_descriptors_all)
.zip(&mut per_stage_descriptors_not_uab)
{
if limit.descriptor_types.contains(&descriptor_type) {
for stage in stages {
*count_all.entry(stage).or_default() += descriptor_count;
if is_not_uab {
*count_not_uab.entry(stage).or_default() += descriptor_count;
}
}
}
}
for ((limit, count_all), count_not_uab) in TOTAL_DESCRIPTOR_LIMITS
.iter()
.zip(&mut total_descriptors_all)
.zip(&mut total_descriptors_not_uab)
{
if limit.descriptor_types.contains(&descriptor_type) {
*count_all += descriptor_count;
if is_not_uab {
*count_not_uab += descriptor_count;
}
}
}
}
}
for ((limit, count_all), count_not_uab) in PER_STAGE_DESCRIPTOR_LIMITS
.iter()
.zip(per_stage_descriptors_all)
.zip(per_stage_descriptors_not_uab)
{
let limit_not_uab = (limit.get_limit_not_uab)(properties);
if let Some((max_stage, max_count)) = count_not_uab.into_iter().max_by_key(|(_, c)| *c)
{
if max_count > limit_not_uab {
return Err(Box::new(ValidationError {
context: "set_layouts".into(),
problem: format!(
"the combined number of {} descriptors, \
belonging to descriptor set layouts without the \
`DescriptorSetLayoutCreateFlags::UPDATE_AFTER_BIND_POOL` flag, \
accessible to the `ShaderStage::{:?}` stage, \
exceeds the `{}` limit",
limit.descriptor_types[1..].iter().fold(
format!("`DescriptorType::{:?}`", limit.descriptor_types[0]),
|mut s, dt| {
write!(s, " + `DescriptorType::{:?}`", dt).unwrap();
s
}
),
max_stage,
limit.limit_name_not_uab,
)
.into(),
vuids: limit.vuids_not_uab,
..Default::default()
}));
}
}
let limit_all = match (limit.get_limit_all)(properties) {
Some(x) => x,
None => continue,
};
if let Some((max_stage, max_count)) = count_all.into_iter().max_by_key(|(_, c)| *c) {
if max_count > limit_all {
return Err(Box::new(ValidationError {
context: "set_layouts".into(),
problem: format!(
"the combined number of {} descriptors, \
accessible to the `ShaderStage::{:?}` stage, \
exceeds the `{}` limit",
limit.descriptor_types[1..].iter().fold(
format!("`DescriptorType::{:?}`", limit.descriptor_types[0]),
|mut s, dt| {
write!(s, " + `DescriptorType::{:?}`", dt).unwrap();
s
}
),
max_stage,
limit.limit_name_all,
)
.into(),
vuids: limit.vuids_all,
..Default::default()
}));
}
}
}
for ((limit, count_all), count_not_uab) in TOTAL_DESCRIPTOR_LIMITS
.iter()
.zip(total_descriptors_all)
.zip(total_descriptors_not_uab)
{
let limit_not_uab = (limit.get_limit_not_uab)(properties);
if count_not_uab > limit_not_uab {
return Err(Box::new(ValidationError {
context: "set_layouts".into(),
problem: format!(
"the combined number of {} descriptors, \
belonging to descriptor set layouts without the \
`DescriptorSetLayoutCreateFlags::UPDATE_AFTER_BIND_POOL` flag, \
accessible across all shader stages, \
exceeds the `{}` limit",
limit.descriptor_types[1..].iter().fold(
format!("`DescriptorType::{:?}`", limit.descriptor_types[0]),
|mut s, dt| {
write!(s, " + `DescriptorType::{:?}`", dt).unwrap();
s
}
),
limit.limit_name_not_uab,
)
.into(),
vuids: limit.vuids_not_uab,
..Default::default()
}));
}
let limit_all = match (limit.get_limit_all)(properties) {
Some(x) => x,
None => continue,
};
if count_all > limit_all {
return Err(Box::new(ValidationError {
context: "set_layouts".into(),
problem: format!(
"the combined number of {} descriptors, \
accessible across all shader stages, \
exceeds the `{}` limit",
limit.descriptor_types[1..].iter().fold(
format!("`DescriptorType::{:?}`", limit.descriptor_types[0]),
|mut s, dt| {
write!(s, " + `DescriptorType::{:?}`", dt).unwrap();
s
}
),
limit.limit_name_all,
)
.into(),
vuids: limit.vuids_all,
..Default::default()
}));
}
}
let mut seen_stages = ShaderStages::empty();
for (range_index, range) in push_constant_ranges.iter().enumerate() {
range
.validate(device)
.map_err(|err| err.add_context(format!("push_constant_ranges[{}]", range_index)))?;
let &PushConstantRange {
stages,
offset: _,
size: _,
} = range;
if seen_stages.intersects(stages) {
return Err(Box::new(ValidationError {
context: "push_constant_ranges".into(),
problem: "contains more than one range with the same stage".into(),
vuids: &["VUID-VkPipelineLayoutCreateInfo-pPushConstantRanges-00292"],
..Default::default()
}));
}
seen_stages |= stages;
}
Ok(())
}
}
vulkan_bitflags! {
#[non_exhaustive]
/// Flags specifying additional properties of a pipeline layout.
PipelineLayoutCreateFlags = PipelineLayoutCreateFlags(u32);
/* TODO: enable
// TODO: document
INDEPENDENT_SETS = INDEPENDENT_SETS_EXT
RequiresOneOf([
RequiresAllOf([DeviceExtension(ext_graphics_pipeline_library)]),
]), */
}
/// Description of a range of the push constants of a pipeline layout.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct PushConstantRange {
/// The stages which can access this range. A stage can access at most one push constant range.
///
/// The default value is [`ShaderStages::empty()`], which must be overridden.
pub stages: ShaderStages,
/// Offset in bytes from the start of the push constants to this range.
///
/// The value must be a multiple of 4.
///
/// The default value is `0`.
pub offset: u32,
/// Size in bytes of the range.
///
/// The value must be a multiple of 4, and not 0.
///
/// The default value is `0`, which must be overridden.
pub size: u32,
}
impl Default for PushConstantRange {
#[inline]
fn default() -> Self {
Self {
stages: ShaderStages::empty(),
offset: 0,
size: 0,
}
}
}
impl PushConstantRange {
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
stages,
offset,
size,
} = self;
stages.validate_device(device).map_err(|err| {
err.add_context("stages")
.set_vuids(&["VUID-VkPushConstantRange-stageFlags-parameter"])
})?;
if stages.is_empty() {
return Err(Box::new(ValidationError {
context: "stages".into(),
problem: "is empty".into(),
vuids: &["VUID-VkPushConstantRange-stageFlags-requiredbitmask"],
..Default::default()
}));
}
let max_push_constants_size = device
.physical_device()
.properties()
.max_push_constants_size;
if offset >= max_push_constants_size {
return Err(Box::new(ValidationError {
context: "offset".into(),
problem: "is not less than the `max_push_constants_size` limit".into(),
vuids: &["VUID-VkPushConstantRange-offset-00294"],
..Default::default()
}));
}
if offset % 4 != 0 {
return Err(Box::new(ValidationError {
context: "offset".into(),
problem: "is not a multiple of 4".into(),
vuids: &["VUID-VkPushConstantRange-offset-00295"],
..Default::default()
}));
}
if size == 0 {
return Err(Box::new(ValidationError {
context: "size".into(),
problem: "is zero".into(),
vuids: &["VUID-VkPushConstantRange-size-00296"],
..Default::default()
}));
}
if size % 4 != 0 {
return Err(Box::new(ValidationError {
context: "size".into(),
problem: "is not a multiple of 4".into(),
vuids: &["VUID-VkPushConstantRange-size-00297"],
..Default::default()
}));
}
if size > max_push_constants_size - offset {
return Err(Box::new(ValidationError {
problem: "`size` is greater than `max_push_constants_size` limit minus `offset`"
.into(),
vuids: &["VUID-VkPushConstantRange-size-00298"],
..Default::default()
}));
}
Ok(())
}
}
/// Parameters to create a new `PipelineLayout` as well as its accompanying `DescriptorSetLayout`
/// objects.
#[derive(Clone, Debug)]
pub struct PipelineDescriptorSetLayoutCreateInfo {
pub flags: PipelineLayoutCreateFlags,
pub set_layouts: Vec<DescriptorSetLayoutCreateInfo>,
pub push_constant_ranges: Vec<PushConstantRange>,
}
impl PipelineDescriptorSetLayoutCreateInfo {
/// Creates a new `PipelineDescriptorSetLayoutCreateInfo` from the union of the requirements of
/// each shader stage in `stages`.
///
/// This is intended for quick prototyping or for single use layouts that do not have any
/// bindings in common with other shaders. For the general case, it is strongly recommended
/// to create pipeline layouts manually:
/// - When multiple pipelines share the same layout object, it is faster than if they have
/// different objects, even if the objects both contain identical bindings. It is also faster
/// (though a little bit less), if multiple pipeline layout objects share common descriptor
/// set objects.
/// - Pipeline layouts only need to be a superset of what the shaders use, they don't have to
/// match exactly. Creating a manual pipeline layout therefore allows you to specify layouts
/// that are applicable for many shaders, as long as each one uses a subset. This allows
/// further sharing.
/// - Creating a manual pipeline layout makes your code more robust against changes in the
/// shader, in particular regarding whether a particular binding in the shader is used or not
/// (see also the limitations below).
///
/// # Limitations:
///
/// Only bindings that are [statically used] are included in the descriptor binding
/// requirements, and therefore are included in the descriptor set layout.
/// If the use of a binding depends on input variables to the shader (buffers, images,
/// push constants etc.) then the shader reflection is unable to know that the binding is in
/// use, and it will not be included in the pipeline layout.
///
/// Note that this corresponds to the `shader_*_array_dynamic_indexing` device features.
///
/// [statically used]: https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#shaders-staticuse
pub fn from_stages<'a>(
stages: impl IntoIterator<Item = &'a PipelineShaderStageCreateInfo>,
) -> Self {
// Produce `DescriptorBindingRequirements` for each binding, by iterating over all
// shaders and adding the requirements of each.
let mut descriptor_binding_requirements: HashMap<
(u32, u32),
DescriptorBindingRequirements,
> = HashMap::default();
let mut max_set_num = 0;
let mut push_constant_ranges: Vec<PushConstantRange> = Vec::new();
for stage in stages {
let entry_point_info = stage.entry_point.info();
for (&(set_num, binding_num), reqs) in &entry_point_info.descriptor_binding_requirements
{
max_set_num = max(max_set_num, set_num);
match descriptor_binding_requirements.entry((set_num, binding_num)) {
Entry::Occupied(entry) => {
// Previous shaders already added requirements, so we merge
// requirements of the current shader into the requirements of the
// previous ones.
// TODO: return an error here instead of panicking?
entry.into_mut().merge(reqs).expect("Could not produce an intersection of the shader descriptor requirements");
}
Entry::Vacant(entry) => {
// No previous shader had this descriptor yet, so we just insert the
// requirements.
entry.insert(reqs.clone());
}
}
}
if let Some(range) = &entry_point_info.push_constant_requirements {
if let Some(existing_range) =
push_constant_ranges.iter_mut().find(|existing_range| {
existing_range.offset == range.offset && existing_range.size == range.size
})
{
// If this range was already used before, add our stage to it.
existing_range.stages |= range.stages;
} else {
// If this range is new, insert it.
push_constant_ranges.push(*range)
}
}
}
// Convert the descriptor binding requirements.
let mut set_layouts =
vec![DescriptorSetLayoutCreateInfo::default(); max_set_num as usize + 1];
for ((set_num, binding_num), reqs) in descriptor_binding_requirements {
set_layouts[set_num as usize]
.bindings
.insert(binding_num, DescriptorSetLayoutBinding::from(&reqs));
}
Self {
flags: PipelineLayoutCreateFlags::empty(),
set_layouts,
push_constant_ranges,
}
}
/// Converts the `PipelineDescriptorSetLayoutCreateInfo` into a `PipelineLayoutCreateInfo` by
/// creating the descriptor set layout objects.
pub fn into_pipeline_layout_create_info(
self,
device: Arc<Device>,
) -> Result<PipelineLayoutCreateInfo, IntoPipelineLayoutCreateInfoError> {
let PipelineDescriptorSetLayoutCreateInfo {
flags,
set_layouts,
push_constant_ranges,
} = self;
let set_layouts = set_layouts
.into_iter()
.enumerate()
.map(|(set_num, create_info)| {
DescriptorSetLayout::new(device.clone(), create_info).map_err(|error| {
IntoPipelineLayoutCreateInfoError {
set_num: set_num as u32,
error,
}
})
})
.collect::<Result<Vec<_>, _>>()?;
Ok(PipelineLayoutCreateInfo {
flags,
set_layouts,
push_constant_ranges,
_ne: crate::NonExhaustive(()),
})
}
}
#[derive(Clone, Debug)]
pub struct IntoPipelineLayoutCreateInfoError {
pub set_num: u32,
pub error: Validated<VulkanError>,
}
impl Display for IntoPipelineLayoutCreateInfoError {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"an error occurred while creating a descriptor set layout for set number {}",
self.set_num
)
}
}
impl Error for IntoPipelineLayoutCreateInfoError {
fn source(&self) -> Option<&(dyn Error + 'static)> {
Some(&self.error)
}
}
#[cfg(test)]
mod tests {
use super::PipelineLayout;
use crate::{
pipeline::layout::{PipelineLayoutCreateInfo, PushConstantRange},
shader::ShaderStages,
};
#[test]
fn push_constant_ranges_disjoint() {
let test_cases = [
// input:
// - `0..12`, stage=fragment
// - `0..40`, stage=vertex
//
// output:
// - `0..12`, stage=fragment|vertex
// - `12..40`, stage=vertex
(
&[
PushConstantRange {
stages: ShaderStages::FRAGMENT,
offset: 0,
size: 12,
},
PushConstantRange {
stages: ShaderStages::VERTEX,
offset: 0,
size: 40,
},
][..],
&[
PushConstantRange {
stages: ShaderStages::VERTEX | ShaderStages::FRAGMENT,
offset: 0,
size: 12,
},
PushConstantRange {
stages: ShaderStages::VERTEX,
offset: 12,
size: 28,
},
][..],
),
// input:
// - `0..12`, stage=fragment
// - `4..40`, stage=vertex
//
// output:
// - `0..4`, stage=fragment
// - `4..12`, stage=fragment|vertex
// - `12..40`, stage=vertex
(
&[
PushConstantRange {
stages: ShaderStages::FRAGMENT,
offset: 0,
size: 12,
},
PushConstantRange {
stages: ShaderStages::VERTEX,
offset: 4,
size: 36,
},
][..],
&[
PushConstantRange {
stages: ShaderStages::FRAGMENT,
offset: 0,
size: 4,
},
PushConstantRange {
stages: ShaderStages::FRAGMENT | ShaderStages::VERTEX,
offset: 4,
size: 8,
},
PushConstantRange {
stages: ShaderStages::VERTEX,
offset: 12,
size: 28,
},
][..],
),
// input:
// - `0..12`, stage=fragment
// - `8..20`, stage=compute
// - `4..16`, stage=vertex
// - `8..32`, stage=tess_ctl
//
// output:
// - `0..4`, stage=fragment
// - `4..8`, stage=fragment|vertex
// - `8..16`, stage=fragment|vertex|compute|tess_ctl
// - `16..20`, stage=compute|tess_ctl
// - `20..32` stage=tess_ctl
(
&[
PushConstantRange {
stages: ShaderStages::FRAGMENT,
offset: 0,
size: 12,
},
PushConstantRange {
stages: ShaderStages::COMPUTE,
offset: 8,
size: 12,
},
PushConstantRange {
stages: ShaderStages::VERTEX,
offset: 4,
size: 12,
},
PushConstantRange {
stages: ShaderStages::TESSELLATION_CONTROL,
offset: 8,
size: 24,
},
][..],
&[
PushConstantRange {
stages: ShaderStages::FRAGMENT,
offset: 0,
size: 4,
},
PushConstantRange {
stages: ShaderStages::FRAGMENT | ShaderStages::VERTEX,
offset: 4,
size: 4,
},
PushConstantRange {
stages: ShaderStages::VERTEX
| ShaderStages::FRAGMENT
| ShaderStages::COMPUTE
| ShaderStages::TESSELLATION_CONTROL,
offset: 8,
size: 4,
},
PushConstantRange {
stages: ShaderStages::VERTEX
| ShaderStages::COMPUTE
| ShaderStages::TESSELLATION_CONTROL,
offset: 12,
size: 4,
},
PushConstantRange {
stages: ShaderStages::COMPUTE | ShaderStages::TESSELLATION_CONTROL,
offset: 16,
size: 4,
},
PushConstantRange {
stages: ShaderStages::TESSELLATION_CONTROL,
offset: 20,
size: 12,
},
][..],
),
];
let (device, _) = gfx_dev_and_queue!();
for (input, expected) in test_cases {
let layout = PipelineLayout::new(
device.clone(),
PipelineLayoutCreateInfo {
push_constant_ranges: input.into(),
..Default::default()
},
)
.unwrap();
assert_eq!(layout.push_constant_ranges_disjoint.as_slice(), expected);
}
}
}
/* TODO: restore
#[cfg(test)]
mod tests {
use std::iter;
use std::sync::Arc;
use descriptor::descriptor::ShaderStages;
use descriptor::descriptor_set::DescriptorSetLayout;
use descriptor::pipeline_layout::sys::PipelineLayout;
use descriptor::pipeline_layout::sys::PipelineLayoutCreationError;
#[test]
fn empty() {
let (device, _) = gfx_dev_and_queue!();
let _layout = PipelineLayout::new(&device, iter::empty(), iter::empty()).unwrap();
}
#[test]
fn wrong_device_panic() {
let (device1, _) = gfx_dev_and_queue!();
let (device2, _) = gfx_dev_and_queue!();
let set = match DescriptorSetLayout::raw(device1, iter::empty()) {
Ok(s) => Arc::new(s),
Err(_) => return
};
assert_should_panic!({
let _ = PipelineLayout::new(&device2, Some(&set), iter::empty());
});
}
#[test]
fn invalid_push_constant_stages() {
let (device, _) = gfx_dev_and_queue!();
let push_constant = (0, 8, ShaderStages::empty());
match PipelineLayout::new(&device, iter::empty(), Some(push_constant)) {
Err(PipelineLayoutCreationError::InvalidPushConstant) => (),
_ => panic!()
}
}
#[test]
fn invalid_push_constant_size1() {
let (device, _) = gfx_dev_and_queue!();
let push_constant = (0, 0, ShaderStages::all_graphics());
match PipelineLayout::new(&device, iter::empty(), Some(push_constant)) {
Err(PipelineLayoutCreationError::InvalidPushConstant) => (),
_ => panic!()
}
}
#[test]
fn invalid_push_constant_size2() {
let (device, _) = gfx_dev_and_queue!();
let push_constant = (0, 11, ShaderStages::all_graphics());
match PipelineLayout::new(&device, iter::empty(), Some(push_constant)) {
Err(PipelineLayoutCreationError::InvalidPushConstant) => (),
_ => panic!()
}
}
}
*/