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
// 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.
//! Image storage (1D, 2D, 3D, arrays, etc.) and image views.
//!
//! An *image* is a region of memory whose purpose is to store multi-dimensional data. Its
//! most common use is to store a 2D array of color pixels (in other words an *image* in
//! everyday language), but it can also be used to store arbitrary data.
//!
//! The advantage of using an image compared to a buffer is that the memory layout is optimized
//! for locality. When reading a specific pixel of an image, reading the nearby pixels is really
//! fast. Most implementations have hardware dedicated to reading from images if you access them
//! through a sampler.
//!
//! # Properties of an image
//!
//! # Images and image views
//!
//! There is a distinction between *images* and *image views*. As its name suggests, an image
//! view describes how the GPU must interpret the image.
//!
//! Transfer and memory operations operate on images themselves, while reading/writing an image
//! operates on image views. You can create multiple image views from the same image.
//!
//! # High-level wrappers
//!
//! In the vulkano library, an image is any object that implements the [`ImageAccess`] trait. You
//! can create a view by wrapping them in an [`ImageView`](crate::image::view::ImageView).
//!
//! Since the `ImageAccess` trait is low-level, you are encouraged to not implement it yourself but
//! instead use one of the provided implementations that are specialized depending on the way you
//! are going to use the image:
//!
//! - An `AttachmentImage` can be used when you want to draw to an image.
//! - An `ImmutableImage` stores data which never need be changed after the initial upload,
//! like a texture.
//!
//! # Low-level information
//!
//! To be written.
//!
pub use self::{
aspect::{ImageAspect, ImageAspects},
attachment::AttachmentImage,
immutable::ImmutableImage,
layout::{ImageDescriptorLayouts, ImageLayout},
storage::StorageImage,
swapchain::SwapchainImage,
sys::ImageError,
traits::{ImageAccess, ImageInner},
usage::ImageUsage,
view::{ImageViewAbstract, ImageViewType},
};
use crate::{
format::Format,
macros::{vulkan_bitflags, vulkan_enum},
memory::{ExternalMemoryHandleType, ExternalMemoryProperties},
DeviceSize,
};
use std::{cmp, ops::Range};
mod aspect;
pub mod attachment; // TODO: make private
pub mod immutable; // TODO: make private
mod layout;
mod storage;
pub mod swapchain; // TODO: make private
pub mod sys;
pub mod traits;
mod usage;
pub mod view;
vulkan_bitflags! {
/// Flags that can be set when creating a new image.
#[non_exhaustive]
ImageCreateFlags = ImageCreateFlags(u32);
/*
/// The image will be backed by sparse memory binding (through queue commands) instead of
/// regular binding (through [`bind_memory`]).
///
/// The [`sparse_binding`] feature must be enabled on the device.
///
/// [`bind_memory`]: sys::RawImage::bind_memory
/// [`sparse_binding`]: crate::device::Features::sparse_binding
sparse_binding = SPARSE_BINDING,
/// The image can be used without being fully resident in memory at the time of use.
///
/// This requires the `sparse_binding` flag as well.
///
/// Depending on the image dimensions, either the [`sparse_residency_image2_d`] or the
/// [`sparse_residency_image3_d`] feature must be enabled on the device.
/// For a multisampled image, the one of the features [`sparse_residency2_samples`],
/// [`sparse_residency4_samples`], [`sparse_residency8_samples`] or
/// [`sparse_residency16_samples`], corresponding to the sample count of the image, must
/// be enabled on the device.
///
/// [`sparse_binding`]: crate::device::Features::sparse_binding
/// [`sparse_residency_image2_d`]: crate::device::Features::sparse_residency_image2_d
/// [`sparse_residency_image2_3`]: crate::device::Features::sparse_residency_image3_d
/// [`sparse_residency2_samples`]: crate::device::Features::sparse_residency2_samples
/// [`sparse_residency4_samples`]: crate::device::Features::sparse_residency4_samples
/// [`sparse_residency8_samples`]: crate::device::Features::sparse_residency8_samples
/// [`sparse_residency16_samples`]: crate::device::Features::sparse_residency16_samples
sparse_residency = SPARSE_RESIDENCY,
/// The buffer's memory can alias with another image or a different part of the same image.
///
/// This requires the `sparse_binding` flag as well.
///
/// The [`sparse_residency_aliased`] feature must be enabled on the device.
///
/// [`sparse_residency_aliased`]: crate::device::Features::sparse_residency_aliased
sparse_aliased = SPARSE_ALIASED,
*/
/// For non-multi-planar formats, whether an image view wrapping the image can have a
/// different format.
///
/// For multi-planar formats, whether an image view wrapping the image can be created from a
/// single plane of the image.
mutable_format = MUTABLE_FORMAT,
/// For 2D images, whether an image view of type [`ImageViewType::Cube`] or
/// [`ImageViewType::CubeArray`] can be created from the image.
///
/// [`ImageViewType::Cube`]: crate::image::view::ImageViewType::Cube
/// [`ImageViewType::CubeArray`]: crate::image::view::ImageViewType::CubeArray
cube_compatible = CUBE_COMPATIBLE,
/*
// TODO: document
alias = ALIAS {
api_version: V1_1,
device_extensions: [khr_bind_memory2],
},
// TODO: document
split_instance_bind_regions = SPLIT_INSTANCE_BIND_REGIONS {
api_version: V1_1,
device_extensions: [khr_device_group],
},
*/
/// For 3D images, whether an image view of type [`ImageViewType::Dim2d`] or
/// [`ImageViewType::Dim2dArray`] can be created from the image.
///
/// On [portability subset] devices, the [`image_view2_d_on3_d_image`] feature must be enabled
/// on the device.
///
/// [`ImageViewType::Dim2d`]: crate::image::view::ImageViewType::Dim2d
/// [`ImageViewType::Dim2dArray`]: crate::image::view::ImageViewType::Dim2dArray
/// [portability subset]: crate::instance#portability-subset-devices-and-the-enumerate_portability-flag
/// [`image_view2_d_on3_d_image`]: crate::device::Features::image_view2_d_on3_d_image
array_2d_compatible = TYPE_2D_ARRAY_COMPATIBLE {
api_version: V1_1,
device_extensions: [khr_maintenance1],
},
/// For images with a compressed format, whether an image view with an uncompressed
/// format can be created from the image, where each texel in the view will correspond to a
/// compressed texel block in the image.
///
/// Requires `mutable_format`.
block_texel_view_compatible = BLOCK_TEXEL_VIEW_COMPATIBLE {
api_version: V1_1,
device_extensions: [khr_maintenance2],
},
/*
// TODO: document
extended_usage = EXTENDED_USAGE {
api_version: V1_1,
device_extensions: [khr_maintenance2],
},
// TODO: document
protected = PROTECTED {
api_version: V1_1,
},
*/
/// For images with a multi-planar format, whether each plane will have its memory bound
/// separately, rather than having a single memory binding for the whole image.
disjoint = DISJOINT {
api_version: V1_1,
device_extensions: [khr_sampler_ycbcr_conversion],
},
/*
// TODO: document
corner_sampled = CORNER_SAMPLED_NV {
device_extensions: [nv_corner_sampled_image],
},
// TODO: document
sample_locations_compatible_depth = SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_EXT {
device_extensions: [ext_sample_locations],
},
// TODO: document
subsampled = SUBSAMPLED_EXT {
device_extensions: [ext_fragment_density_map],
},
// TODO: document
multisampled_render_to_single_sampled = MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_EXT {
device_extensions: [ext_multisampled_render_to_single_sampled],
},
// TODO: document
view_2d_compatible = TYPE_2D_VIEW_COMPATIBLE_EXT {
device_extensions: [ext_image_2d_view_of_3d],
},
// TODO: document
fragment_density_map_offset = FRAGMENT_DENSITY_MAP_OFFSET_QCOM {
device_extensions: [qcom_fragment_density_map_offset],
},
*/
}
vulkan_enum! {
// TODO: document
#[non_exhaustive]
SampleCount = SampleCountFlags(u32);
// TODO: document
Sample1 = TYPE_1,
// TODO: document
Sample2 = TYPE_2,
// TODO: document
Sample4 = TYPE_4,
// TODO: document
Sample8 = TYPE_8,
// TODO: document
Sample16 = TYPE_16,
// TODO: document
Sample32 = TYPE_32,
// TODO: document
Sample64 = TYPE_64,
}
impl TryFrom<u32> for SampleCount {
type Error = ();
#[inline]
fn try_from(val: u32) -> Result<Self, Self::Error> {
match val {
1 => Ok(Self::Sample1),
2 => Ok(Self::Sample2),
4 => Ok(Self::Sample4),
8 => Ok(Self::Sample8),
16 => Ok(Self::Sample16),
32 => Ok(Self::Sample32),
64 => Ok(Self::Sample64),
_ => Err(()),
}
}
}
vulkan_bitflags! {
/// Specifies a set of [`SampleCount`] values.
#[non_exhaustive]
SampleCounts = SampleCountFlags(u32);
/// 1 sample per pixel.
sample1 = TYPE_1,
/// 2 samples per pixel.
sample2 = TYPE_2,
/// 4 samples per pixel.
sample4 = TYPE_4,
/// 8 samples per pixel.
sample8 = TYPE_8,
/// 16 samples per pixel.
sample16 = TYPE_16,
/// 32 samples per pixel.
sample32 = TYPE_32,
/// 64 samples per pixel.
sample64 = TYPE_64,
}
impl SampleCounts {
/// Returns true if `self` has the `sample_count` value set.
#[inline]
pub const fn contains_count(&self, sample_count: SampleCount) -> bool {
match sample_count {
SampleCount::Sample1 => self.sample1,
SampleCount::Sample2 => self.sample2,
SampleCount::Sample4 => self.sample4,
SampleCount::Sample8 => self.sample8,
SampleCount::Sample16 => self.sample16,
SampleCount::Sample32 => self.sample32,
SampleCount::Sample64 => self.sample64,
}
}
/// Returns the maximum sample count supported by `self`.
#[inline]
pub const fn max_count(&self) -> SampleCount {
match self {
Self { sample64: true, .. } => SampleCount::Sample64,
Self { sample32: true, .. } => SampleCount::Sample32,
Self { sample16: true, .. } => SampleCount::Sample16,
Self { sample8: true, .. } => SampleCount::Sample8,
Self { sample4: true, .. } => SampleCount::Sample4,
Self { sample2: true, .. } => SampleCount::Sample2,
_ => SampleCount::Sample1,
}
}
}
/// Specifies how many mipmaps must be allocated.
///
/// Note that at least one mipmap must be allocated, to store the main level of the image.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum MipmapsCount {
/// Allocates the number of mipmaps required to store all the mipmaps of the image where each
/// mipmap is half the dimensions of the previous level. Guaranteed to be always supported.
///
/// Note that this is not necessarily the maximum number of mipmaps, as the Vulkan
/// implementation may report that it supports a greater value.
Log2,
/// Allocate one mipmap (ie. just the main level). Always supported.
One,
/// Allocate the given number of mipmaps. May result in an error if the value is out of range
/// of what the implementation supports.
Specific(u32),
}
impl From<u32> for MipmapsCount {
#[inline]
fn from(num: u32) -> MipmapsCount {
MipmapsCount::Specific(num)
}
}
vulkan_enum! {
// TODO: document
#[non_exhaustive]
ImageType = ImageType(i32);
// TODO: document
Dim1d = TYPE_1D,
// TODO: document
Dim2d = TYPE_2D,
// TODO: document
Dim3d = TYPE_3D,
}
vulkan_enum! {
// TODO: document
#[non_exhaustive]
ImageTiling = ImageTiling(i32);
// TODO: document
Optimal = OPTIMAL,
// TODO: document
Linear = LINEAR,
/*
// TODO: document
DrmFormatModifier = DRM_FORMAT_MODIFIER_EXT {
device_extensions: [ext_image_drm_format_modifier],
},
*/
}
/// The dimensions of an image.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum ImageDimensions {
Dim1d {
width: u32,
array_layers: u32,
},
Dim2d {
width: u32,
height: u32,
array_layers: u32,
},
Dim3d {
width: u32,
height: u32,
depth: u32,
},
}
impl ImageDimensions {
#[inline]
pub fn width(&self) -> u32 {
match *self {
ImageDimensions::Dim1d { width, .. } => width,
ImageDimensions::Dim2d { width, .. } => width,
ImageDimensions::Dim3d { width, .. } => width,
}
}
#[inline]
pub fn height(&self) -> u32 {
match *self {
ImageDimensions::Dim1d { .. } => 1,
ImageDimensions::Dim2d { height, .. } => height,
ImageDimensions::Dim3d { height, .. } => height,
}
}
#[inline]
pub fn width_height(&self) -> [u32; 2] {
[self.width(), self.height()]
}
#[inline]
pub fn depth(&self) -> u32 {
match *self {
ImageDimensions::Dim1d { .. } => 1,
ImageDimensions::Dim2d { .. } => 1,
ImageDimensions::Dim3d { depth, .. } => depth,
}
}
#[inline]
pub fn width_height_depth(&self) -> [u32; 3] {
[self.width(), self.height(), self.depth()]
}
#[inline]
pub fn array_layers(&self) -> u32 {
match *self {
ImageDimensions::Dim1d { array_layers, .. } => array_layers,
ImageDimensions::Dim2d { array_layers, .. } => array_layers,
ImageDimensions::Dim3d { .. } => 1,
}
}
/// Returns the total number of texels for an image of these dimensions.
#[inline]
pub fn num_texels(&self) -> u32 {
self.width() * self.height() * self.depth() * self.array_layers()
}
#[inline]
pub fn image_type(&self) -> ImageType {
match *self {
ImageDimensions::Dim1d { .. } => ImageType::Dim1d,
ImageDimensions::Dim2d { .. } => ImageType::Dim2d,
ImageDimensions::Dim3d { .. } => ImageType::Dim3d,
}
}
/// Returns the maximum number of mipmap levels for these image dimensions.
///
/// The returned value is always at least 1.
///
/// # Examples
///
/// ```
/// use vulkano::image::ImageDimensions;
///
/// let dims = ImageDimensions::Dim2d {
/// width: 32,
/// height: 50,
/// array_layers: 1,
/// };
///
/// assert_eq!(dims.max_mip_levels(), 6);
/// ```
#[inline]
pub fn max_mip_levels(&self) -> u32 {
// This calculates `log2(max(width, height, depth)) + 1` using fast integer operations.
let max = match *self {
ImageDimensions::Dim1d { width, .. } => width,
ImageDimensions::Dim2d { width, height, .. } => width | height,
ImageDimensions::Dim3d {
width,
height,
depth,
} => width | height | depth,
};
32 - max.leading_zeros()
}
/// Returns the dimensions of the `level`th mipmap level. If `level` is 0, then the dimensions
/// are left unchanged.
///
/// Returns `None` if `level` is superior or equal to `max_mip_levels()`.
///
/// # Examples
///
/// ```
/// use vulkano::image::ImageDimensions;
///
/// let dims = ImageDimensions::Dim2d {
/// width: 963,
/// height: 256,
/// array_layers: 1,
/// };
///
/// assert_eq!(dims.mip_level_dimensions(0), Some(dims));
/// assert_eq!(dims.mip_level_dimensions(1), Some(ImageDimensions::Dim2d {
/// width: 481,
/// height: 128,
/// array_layers: 1,
/// }));
/// assert_eq!(dims.mip_level_dimensions(6), Some(ImageDimensions::Dim2d {
/// width: 15,
/// height: 4,
/// array_layers: 1,
/// }));
/// assert_eq!(dims.mip_level_dimensions(9), Some(ImageDimensions::Dim2d {
/// width: 1,
/// height: 1,
/// array_layers: 1,
/// }));
/// assert_eq!(dims.mip_level_dimensions(11), None);
/// ```
///
/// # Panics
///
/// - In debug mode, panics if `width`, `height` or `depth` is equal to 0. In release, returns
/// an unspecified value.
#[inline]
pub fn mip_level_dimensions(&self, level: u32) -> Option<ImageDimensions> {
if level == 0 {
return Some(*self);
}
if level >= self.max_mip_levels() {
return None;
}
Some(match *self {
ImageDimensions::Dim1d {
width,
array_layers,
} => {
debug_assert_ne!(width, 0);
ImageDimensions::Dim1d {
array_layers,
width: cmp::max(1, width >> level),
}
}
ImageDimensions::Dim2d {
width,
height,
array_layers,
} => {
debug_assert_ne!(width, 0);
debug_assert_ne!(height, 0);
ImageDimensions::Dim2d {
width: cmp::max(1, width >> level),
height: cmp::max(1, height >> level),
array_layers,
}
}
ImageDimensions::Dim3d {
width,
height,
depth,
} => {
debug_assert_ne!(width, 0);
debug_assert_ne!(height, 0);
ImageDimensions::Dim3d {
width: cmp::max(1, width >> level),
height: cmp::max(1, height >> level),
depth: cmp::max(1, depth >> level),
}
}
})
}
}
/// One or more subresources of an image, spanning a single mip level, that should be accessed by a
/// command.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct ImageSubresourceLayers {
/// Selects the aspects that will be included.
///
/// The value must not be empty, and must not include any of the `memory_plane` aspects.
/// The `color` aspect cannot be selected together any of with the `plane` aspects.
pub aspects: ImageAspects,
/// Selects mip level that will be included.
pub mip_level: u32,
/// Selects the range of array layers that will be included.
///
/// The range must not be empty.
pub array_layers: Range<u32>,
}
impl ImageSubresourceLayers {
/// Returns an `ImageSubresourceLayers` from the given image parameters, covering the first
/// mip level of the image. All aspects of the image are selected, or `plane0` if the image
/// is multi-planar.
#[inline]
pub fn from_parameters(format: Format, array_layers: u32) -> Self {
Self {
aspects: {
let aspects = format.aspects();
if aspects.plane0 {
ImageAspects {
plane0: true,
..ImageAspects::empty()
}
} else {
aspects
}
},
mip_level: 0,
array_layers: 0..array_layers,
}
}
}
impl From<ImageSubresourceLayers> for ash::vk::ImageSubresourceLayers {
#[inline]
fn from(val: ImageSubresourceLayers) -> Self {
Self {
aspect_mask: val.aspects.into(),
mip_level: val.mip_level,
base_array_layer: val.array_layers.start,
layer_count: val.array_layers.end - val.array_layers.start,
}
}
}
/// One or more subresources of an image that should be accessed by a command.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct ImageSubresourceRange {
/// Selects the aspects that will be included.
///
/// The value must not be empty, and must not include any of the `memory_plane` aspects.
/// The `color` aspect cannot be selected together any of with the `plane` aspects.
pub aspects: ImageAspects,
/// Selects the range of the mip levels that will be included.
///
/// The range must not be empty.
pub mip_levels: Range<u32>,
/// Selects the range of array layers that will be included.
///
/// The range must not be empty.
pub array_layers: Range<u32>,
}
impl ImageSubresourceRange {
/// Returns an `ImageSubresourceRange` from the given image parameters, covering the whole
/// image. If the image is multi-planar, only the `color` aspect is selected.
#[inline]
pub fn from_parameters(format: Format, mip_levels: u32, array_layers: u32) -> Self {
Self {
aspects: ImageAspects {
plane0: false,
plane1: false,
plane2: false,
..format.aspects()
},
mip_levels: 0..mip_levels,
array_layers: 0..array_layers,
}
}
}
impl From<ImageSubresourceRange> for ash::vk::ImageSubresourceRange {
#[inline]
fn from(val: ImageSubresourceRange) -> Self {
Self {
aspect_mask: val.aspects.into(),
base_mip_level: val.mip_levels.start,
level_count: val.mip_levels.end - val.mip_levels.start,
base_array_layer: val.array_layers.start,
layer_count: val.array_layers.end - val.array_layers.start,
}
}
}
impl From<ImageSubresourceLayers> for ImageSubresourceRange {
#[inline]
fn from(val: ImageSubresourceLayers) -> Self {
Self {
aspects: val.aspects,
mip_levels: val.mip_level..val.mip_level + 1,
array_layers: val.array_layers,
}
}
}
/// Describes the memory layout of an image.
///
/// The address of a texel at `(x, y, z, layer)` is `layer * array_pitch + z * depth_pitch +
/// y * row_pitch + x * size_of_each_texel + offset`. `size_of_each_texel` must be determined
/// depending on the format. The same formula applies for compressed formats, except that the
/// coordinates must be in number of blocks.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct SubresourceLayout {
/// The number of bytes from the start of the memory where the subresource begins.
pub offset: DeviceSize,
/// The size in bytes in the subresource. It includes any extra memory that is required based on
/// `row_pitch`.
pub size: DeviceSize,
/// The number of bytes between adjacent rows of texels.
pub row_pitch: DeviceSize,
/// The number of bytes between adjacent array layers.
///
/// This value is undefined for images with only one array layer.
pub array_pitch: DeviceSize,
/// The number of bytes between adjacent depth slices.
///
/// This value is undefined for images that are not three-dimensional.
pub depth_pitch: DeviceSize,
}
/// The image configuration to query in
/// [`PhysicalDevice::image_format_properties`](crate::device::physical::PhysicalDevice::image_format_properties).
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct ImageFormatInfo {
/// The `flags` that the image will have.
///
/// The default value is [`ImageCreateFlags::empty()`].
pub flags: ImageCreateFlags,
/// The `format` that the image will have.
///
/// The default value is `None`, which must be overridden.
pub format: Option<Format>,
/// The dimension type that the image will have.
///
/// The default value is [`ImageType::Dim2d`].
pub image_type: ImageType,
/// The `tiling` that the image will have.
///
/// The default value is [`ImageTiling::Optimal`].
pub tiling: ImageTiling,
/// The `usage` that the image will have.
///
/// The default value is [`ImageUsage::empty()`], which must be overridden.
pub usage: ImageUsage,
/// The `stencil_usage` that the image will have.
///
/// If `stencil_usage` is empty or if `format` does not have both a depth and a stencil aspect,
/// then it is automatically set to equal `usage`.
///
/// If after this, `stencil_usage` does not equal `usage`,
/// then the physical device API version must be at least 1.2, or the
/// [`ext_separate_stencil_usage`](crate::device::DeviceExtensions::ext_separate_stencil_usage)
/// extension must be supported by the physical device.
///
/// The default value is [`ImageUsage::empty()`].
pub stencil_usage: ImageUsage,
/// An external memory handle type that will be imported to or exported from the image.
///
/// This is needed to retrieve the
/// [`external_memory_properties`](ImageFormatProperties::external_memory_properties) value,
/// and the physical device API version must be at least 1.1 or the
/// [`khr_external_memory_capabilities`](crate::instance::InstanceExtensions::khr_external_memory_capabilities)
/// extension must be enabled on the instance.
///
/// The default value is `None`.
pub external_memory_handle_type: Option<ExternalMemoryHandleType>,
/// The image view type that will be created from the image.
///
/// This is needed to retrieve the
/// [`filter_cubic`](ImageFormatProperties::filter_cubic) and
/// [`filter_cubic_minmax`](ImageFormatProperties::filter_cubic_minmax) values, and the
/// [`ext_filter_cubic`](crate::device::DeviceExtensions::ext_filter_cubic) extension must be
/// supported on the physical device.
///
/// The default value is `None`.
pub image_view_type: Option<ImageViewType>,
pub _ne: crate::NonExhaustive,
}
impl Default for ImageFormatInfo {
#[inline]
fn default() -> Self {
Self {
flags: ImageCreateFlags::empty(),
format: None,
image_type: ImageType::Dim2d,
tiling: ImageTiling::Optimal,
usage: ImageUsage::empty(),
stencil_usage: ImageUsage::empty(),
external_memory_handle_type: None,
image_view_type: None,
_ne: crate::NonExhaustive(()),
}
}
}
/// The properties that are supported by a physical device for images of a certain type.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct ImageFormatProperties {
/// The maximum dimensions.
pub max_extent: [u32; 3],
/// The maximum number of mipmap levels.
pub max_mip_levels: u32,
/// The maximum number of array layers.
pub max_array_layers: u32,
/// The supported sample counts.
pub sample_counts: SampleCounts,
/// The maximum total size of an image, in bytes. This is guaranteed to be at least
/// 0x80000000.
pub max_resource_size: DeviceSize,
/// The properties for external memory.
/// This will be [`ExternalMemoryProperties::default()`] if `external_handle_type` was `None`.
pub external_memory_properties: ExternalMemoryProperties,
/// When querying with an image view type, whether such image views support sampling with
/// a [`Cubic`](crate::sampler::Filter::Cubic) `mag_filter` or `min_filter`.
pub filter_cubic: bool,
/// When querying with an image view type, whether such image views support sampling with
/// a [`Cubic`](crate::sampler::Filter::Cubic) `mag_filter` or `min_filter`, and with a
/// [`Min`](crate::sampler::SamplerReductionMode::Min) or
/// [`Max`](crate::sampler::SamplerReductionMode::Max) `reduction_mode`.
pub filter_cubic_minmax: bool,
}
impl From<ash::vk::ImageFormatProperties> for ImageFormatProperties {
#[inline]
fn from(props: ash::vk::ImageFormatProperties) -> Self {
Self {
max_extent: [
props.max_extent.width,
props.max_extent.height,
props.max_extent.depth,
],
max_mip_levels: props.max_mip_levels,
max_array_layers: props.max_array_layers,
sample_counts: props.sample_counts.into(),
max_resource_size: props.max_resource_size,
external_memory_properties: Default::default(),
filter_cubic: false,
filter_cubic_minmax: false,
}
}
}
/// The image configuration to query in
/// [`PhysicalDevice::sparse_image_format_properties`](crate::device::physical::PhysicalDevice::sparse_image_format_properties).
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct SparseImageFormatInfo {
/// The `format` that the image will have.
///
/// The default value is `None`, which must be overridden.
pub format: Option<Format>,
/// The dimension type that the image will have.
///
/// The default value is [`ImageType::Dim2d`].
pub image_type: ImageType,
/// The `samples` that the image will have.
///
/// The default value is `SampleCount::Sample1`.
pub samples: SampleCount,
/// The `usage` that the image will have.
///
/// The default value is [`ImageUsage::empty()`], which must be overridden.
pub usage: ImageUsage,
/// The `tiling` that the image will have.
///
/// The default value is [`ImageTiling::Optimal`].
pub tiling: ImageTiling,
pub _ne: crate::NonExhaustive,
}
impl Default for SparseImageFormatInfo {
#[inline]
fn default() -> Self {
Self {
format: None,
image_type: ImageType::Dim2d,
samples: SampleCount::Sample1,
usage: ImageUsage::empty(),
tiling: ImageTiling::Optimal,
_ne: crate::NonExhaustive(()),
}
}
}
/// The properties that are supported by a physical device for sparse images of a certain type.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct SparseImageFormatProperties {
/// The aspects of the image that the properties apply to.
pub aspects: ImageAspects,
/// The size of the sparse image block, in texels or compressed texel blocks.
///
/// If `flags.nonstandard_block_size` is set, then these values do not match the standard
/// sparse block dimensions for the given format.
pub image_granularity: [u32; 3],
/// Additional information about the sparse image.
pub flags: SparseImageFormatFlags,
}
vulkan_bitflags! {
/// Flags specifying information about a sparse resource.
SparseImageFormatFlags = SparseImageFormatFlags(u32);
/// The image uses a single mip tail region for all array layers, instead of one mip tail region
/// per array layer.
single_miptail = SINGLE_MIPTAIL,
/// The image's mip tail region begins with the first mip level whose dimensions are not an
/// integer multiple of the corresponding sparse image block dimensions.
aligned_mip_size = ALIGNED_MIP_SIZE,
/// The image uses non-standard sparse image block dimensions.
nonstandard_block_size = NONSTANDARD_BLOCK_SIZE,
}
/// Requirements for binding memory to a sparse image.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct SparseImageMemoryRequirements {
/// The properties of the image format.
pub format_properties: SparseImageFormatProperties,
/// The first mip level at which image subresources are included in the mip tail region.
pub image_mip_tail_first_lod: u32,
/// The size in bytes of the mip tail region. This value is guaranteed to be a multiple of the
/// sparse block size in bytes.
///
/// If `format_properties.flags.single_miptail` is set, then this is the size of the whole
/// mip tail. Otherwise it is the size of the mip tail of a single array layer.
pub image_mip_tail_size: DeviceSize,
/// The memory offset that must be used to bind the mip tail region.
pub image_mip_tail_offset: DeviceSize,
/// If `format_properties.flags.single_miptail` is not set, specifies the stride between
/// the mip tail regions of each array layer.
pub image_mip_tail_stride: Option<DeviceSize>,
}
#[cfg(test)]
mod tests {
use crate::{
command_buffer::{
allocator::StandardCommandBufferAllocator, AutoCommandBufferBuilder, CommandBufferUsage,
},
format::Format,
image::{ImageAccess, ImageDimensions, ImmutableImage, MipmapsCount},
memory::allocator::StandardMemoryAllocator,
};
#[test]
fn max_mip_levels() {
let dims = ImageDimensions::Dim2d {
width: 2,
height: 1,
array_layers: 1,
};
assert_eq!(dims.max_mip_levels(), 2);
let dims = ImageDimensions::Dim2d {
width: 2,
height: 3,
array_layers: 1,
};
assert_eq!(dims.max_mip_levels(), 2);
let dims = ImageDimensions::Dim2d {
width: 512,
height: 512,
array_layers: 1,
};
assert_eq!(dims.max_mip_levels(), 10);
}
#[test]
fn mip_level_dimensions() {
let dims = ImageDimensions::Dim2d {
width: 283,
height: 175,
array_layers: 1,
};
assert_eq!(dims.mip_level_dimensions(0), Some(dims));
assert_eq!(
dims.mip_level_dimensions(1),
Some(ImageDimensions::Dim2d {
width: 141,
height: 87,
array_layers: 1,
})
);
assert_eq!(
dims.mip_level_dimensions(2),
Some(ImageDimensions::Dim2d {
width: 70,
height: 43,
array_layers: 1,
})
);
assert_eq!(
dims.mip_level_dimensions(3),
Some(ImageDimensions::Dim2d {
width: 35,
height: 21,
array_layers: 1,
})
);
assert_eq!(
dims.mip_level_dimensions(4),
Some(ImageDimensions::Dim2d {
width: 17,
height: 10,
array_layers: 1,
})
);
assert_eq!(
dims.mip_level_dimensions(5),
Some(ImageDimensions::Dim2d {
width: 8,
height: 5,
array_layers: 1,
})
);
assert_eq!(
dims.mip_level_dimensions(6),
Some(ImageDimensions::Dim2d {
width: 4,
height: 2,
array_layers: 1,
})
);
assert_eq!(
dims.mip_level_dimensions(7),
Some(ImageDimensions::Dim2d {
width: 2,
height: 1,
array_layers: 1,
})
);
assert_eq!(
dims.mip_level_dimensions(8),
Some(ImageDimensions::Dim2d {
width: 1,
height: 1,
array_layers: 1,
})
);
assert_eq!(dims.mip_level_dimensions(9), None);
}
#[test]
fn mipmap_working_immutable_image() {
let (device, queue) = gfx_dev_and_queue!();
let cb_allocator = StandardCommandBufferAllocator::new(device.clone(), Default::default());
let mut cbb = AutoCommandBufferBuilder::primary(
&cb_allocator,
queue.queue_family_index(),
CommandBufferUsage::OneTimeSubmit,
)
.unwrap();
let memory_allocator = StandardMemoryAllocator::new_default(device);
let dimensions = ImageDimensions::Dim2d {
width: 512,
height: 512,
array_layers: 1,
};
{
let mut vec = Vec::new();
vec.resize(512 * 512, 0u8);
let image = ImmutableImage::from_iter(
&memory_allocator,
vec.into_iter(),
dimensions,
MipmapsCount::One,
Format::R8_UNORM,
&mut cbb,
)
.unwrap();
assert_eq!(image.mip_levels(), 1);
}
{
let mut vec = Vec::new();
vec.resize(512 * 512, 0u8);
let image = ImmutableImage::from_iter(
&memory_allocator,
vec.into_iter(),
dimensions,
MipmapsCount::Log2,
Format::R8_UNORM,
&mut cbb,
)
.unwrap();
assert_eq!(image.mip_levels(), 10);
}
}
}