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
// 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.
//! Bindings between shaders and the resources they access.
//!
//! # Overview
//!
//! In order to access a buffer or an image from a shader, that buffer or image must be put in a
//! *descriptor*. Each descriptor contains one buffer or one image alongside with the way that it
//! can be accessed. A descriptor can also be an array, in which case it contains multiple buffers
//! or images that all have the same layout.
//!
//! Descriptors are grouped in what is called *descriptor sets*. In Vulkan you don't bind
//! individual descriptors one by one, but you create then bind descriptor sets one by one. As
//! binding a descriptor set has (small but non-null) a cost, you are encouraged to put descriptors
//! that are often used together in the same set so that you can keep the same set binding through
//! multiple draws.
//!
//! # Examples
//!
//! > **Note**: This section describes the simple way to bind resources. There are more optimized
//! > ways.
//!
//! There are two steps to give access to a resource in a shader: creating the descriptor set, and
//! passing the descriptor sets when drawing.
//!
//! ## Creating a descriptor set
//!
//! TODO: write example for: PersistentDescriptorSet::start(layout.clone()).add_buffer(data_buffer.clone())
//!
//! ## Passing the descriptor set when drawing
//!
//! TODO: write
//!
//! # When drawing
//!
//! When you call a function that adds a draw command to a command buffer, one of the parameters
//! corresponds to the list of descriptor sets to use. Vulkano will check that what you passed is
//! compatible with the layout of the pipeline.
//!
//! TODO: talk about perfs of changing sets
//!
//! # Descriptor sets creation and management
//!
//! There are three concepts in Vulkan related to descriptor sets:
//!
//! - A `DescriptorSetLayout` is a Vulkan object that describes to the Vulkan implementation the
//! layout of a future descriptor set. When you allocate a descriptor set, you have to pass an
//! instance of this object. This is represented with the [`DescriptorSetLayout`] type in
//! vulkano.
//! - A `DescriptorPool` is a Vulkan object that holds the memory of descriptor sets and that can
//! be used to allocate and free individual descriptor sets. This is represented with the
//! [`DescriptorPool`] type in vulkano.
//! - A `DescriptorSet` contains the bindings to resources and is allocated from a pool. This is
//! represented with the [`UnsafeDescriptorSet`] type in vulkano.
//!
//! In addition to this, vulkano defines the following:
//!
//! - The [`DescriptorSetAllocator`] trait can be implemented on types from which you can allocate
//! and free descriptor sets. However it is different from Vulkan descriptor pools in the sense
//! that an implementation of the [`DescriptorSetAllocator`] trait can manage multiple Vulkan
//! descriptor pools.
//! - The [`StandardDescriptorSetAllocator`] type is a default implementation of the
//! [`DescriptorSetAllocator`] trait.
//! - The [`DescriptorSet`] trait is implemented on types that wrap around Vulkan descriptor sets in
//! a safe way. A Vulkan descriptor set is inherently unsafe, so we need safe wrappers around
//! them.
//! - The [`DescriptorSetsCollection`] trait is implemented on collections of types that implement
//! [`DescriptorSet`]. It is what you pass to the draw functions.
//!
//! [`DescriptorPool`]: pool::DescriptorPool
//! [`DescriptorSetAllocator`]: allocator::DescriptorSetAllocator
//! [`StandardDescriptorSetAllocator`]: allocator::StandardDescriptorSetAllocator
pub(crate) use self::update::DescriptorWriteInfo;
pub use self::{
collection::DescriptorSetsCollection,
persistent::PersistentDescriptorSet,
update::{
CopyDescriptorSet, DescriptorBufferInfo, DescriptorImageViewInfo, WriteDescriptorSet,
WriteDescriptorSetElements,
},
};
use self::{
layout::DescriptorSetLayout,
pool::{DescriptorPool, DescriptorPoolAlloc},
};
use crate::{
acceleration_structure::AccelerationStructure,
buffer::view::BufferView,
descriptor_set::layout::{
DescriptorBindingFlags, DescriptorSetLayoutCreateFlags, DescriptorType,
},
device::DeviceOwned,
image::{sampler::Sampler, ImageLayout},
VulkanObject,
};
use ahash::HashMap;
use smallvec::{smallvec, SmallVec};
use std::{
hash::{Hash, Hasher},
sync::Arc,
};
pub mod allocator;
mod collection;
pub mod layout;
pub mod persistent;
pub mod pool;
pub mod sys;
mod update;
/// Trait for objects that contain a collection of resources that will be accessible by shaders.
///
/// Objects of this type can be passed when submitting a draw command.
pub unsafe trait DescriptorSet:
VulkanObject<Handle = ash::vk::DescriptorSet> + DeviceOwned + Send + Sync
{
/// Returns the allocation of the descriptor set.
fn alloc(&self) -> &DescriptorPoolAlloc;
/// Returns the descriptor pool that the descriptor set was allocated from.
fn pool(&self) -> &DescriptorPool;
/// Returns the layout of this descriptor set.
#[inline]
fn layout(&self) -> &Arc<DescriptorSetLayout> {
self.alloc().layout()
}
/// Returns the variable descriptor count that this descriptor set was allocated with.
#[inline]
fn variable_descriptor_count(&self) -> u32 {
self.alloc().variable_descriptor_count()
}
/// Creates a [`DescriptorSetWithOffsets`] with the given dynamic offsets.
fn offsets(
self: Arc<Self>,
dynamic_offsets: impl IntoIterator<Item = u32>,
) -> DescriptorSetWithOffsets
where
Self: Sized + 'static,
{
DescriptorSetWithOffsets::new(self, dynamic_offsets)
}
/// Returns the resources bound to this descriptor set.
fn resources(&self) -> &DescriptorSetResources;
}
impl PartialEq for dyn DescriptorSet {
#[inline]
fn eq(&self, other: &Self) -> bool {
self.alloc() == other.alloc()
}
}
impl Eq for dyn DescriptorSet {}
impl Hash for dyn DescriptorSet {
fn hash<H: Hasher>(&self, state: &mut H) {
self.alloc().hash(state);
}
}
/// The resources that are bound to a descriptor set.
#[derive(Clone)]
pub struct DescriptorSetResources {
binding_resources: HashMap<u32, DescriptorBindingResources>,
}
impl DescriptorSetResources {
/// Creates a new `DescriptorSetResources` matching the provided descriptor set layout, and
/// all descriptors set to `None`.
#[inline]
pub fn new(layout: &DescriptorSetLayout, variable_descriptor_count: u32) -> Self {
assert!(variable_descriptor_count <= layout.variable_descriptor_count());
let binding_resources = layout
.bindings()
.iter()
.map(|(&binding_num, binding)| {
let count = if binding
.binding_flags
.intersects(DescriptorBindingFlags::VARIABLE_DESCRIPTOR_COUNT)
{
variable_descriptor_count
} else {
binding.descriptor_count
} as usize;
let binding_resources = match binding.descriptor_type {
DescriptorType::UniformBuffer
| DescriptorType::StorageBuffer
| DescriptorType::UniformBufferDynamic
| DescriptorType::StorageBufferDynamic => {
DescriptorBindingResources::Buffer(smallvec![None; count])
}
DescriptorType::UniformTexelBuffer | DescriptorType::StorageTexelBuffer => {
DescriptorBindingResources::BufferView(smallvec![None; count])
}
DescriptorType::SampledImage
| DescriptorType::StorageImage
| DescriptorType::InputAttachment => {
DescriptorBindingResources::ImageView(smallvec![None; count])
}
DescriptorType::CombinedImageSampler => {
if binding.immutable_samplers.is_empty() {
DescriptorBindingResources::ImageViewSampler(smallvec![None; count])
} else {
DescriptorBindingResources::ImageView(smallvec![None; count])
}
}
DescriptorType::Sampler => {
if binding.immutable_samplers.is_empty() {
DescriptorBindingResources::Sampler(smallvec![None; count])
} else if layout
.flags()
.intersects(DescriptorSetLayoutCreateFlags::PUSH_DESCRIPTOR)
{
// For push descriptors, no resource is written by default, this needs
// to be done explicitly via a dummy write.
DescriptorBindingResources::None(smallvec![None; count])
} else {
// For regular descriptor sets, all descriptors are considered valid
// from the start.
DescriptorBindingResources::None(smallvec![Some(()); count])
}
}
DescriptorType::InlineUniformBlock => {
DescriptorBindingResources::InlineUniformBlock
}
DescriptorType::AccelerationStructure => {
DescriptorBindingResources::AccelerationStructure(smallvec![None; count])
}
};
(binding_num, binding_resources)
})
.collect();
Self { binding_resources }
}
/// Returns a reference to the bound resources for `binding`. Returns `None` if the binding
/// doesn't exist.
#[inline]
pub fn binding(&self, binding: u32) -> Option<&DescriptorBindingResources> {
self.binding_resources.get(&binding)
}
#[inline]
pub(crate) fn write(&mut self, write: &WriteDescriptorSet, layout: &DescriptorSetLayout) {
let descriptor_type = layout
.bindings()
.get(&write.binding())
.expect("descriptor write has invalid binding number")
.descriptor_type;
self.binding_resources
.get_mut(&write.binding())
.expect("descriptor write has invalid binding number")
.write(write, descriptor_type)
}
#[inline]
pub(crate) fn copy(&mut self, copy: &CopyDescriptorSet) {
let src = copy
.src_set
.resources()
.binding_resources
.get(©.src_binding)
.expect("descriptor copy has invalid src_binding number");
self.binding_resources
.get_mut(©.dst_binding)
.expect("descriptor copy has invalid dst_binding number")
.copy(
src,
copy.src_first_array_element,
copy.dst_first_array_element,
copy.descriptor_count,
);
}
}
/// The resources that are bound to a single descriptor set binding.
#[derive(Clone)]
pub enum DescriptorBindingResources {
None(Elements<()>),
Buffer(Elements<DescriptorBufferInfo>),
BufferView(Elements<Arc<BufferView>>),
ImageView(Elements<DescriptorImageViewInfo>),
ImageViewSampler(Elements<(DescriptorImageViewInfo, Arc<Sampler>)>),
Sampler(Elements<Arc<Sampler>>),
InlineUniformBlock,
AccelerationStructure(Elements<Arc<AccelerationStructure>>),
}
type Elements<T> = SmallVec<[Option<T>; 1]>;
impl DescriptorBindingResources {
pub(crate) fn write(&mut self, write: &WriteDescriptorSet, descriptor_type: DescriptorType) {
fn write_resources<T: Clone>(
first: usize,
resources: &mut [Option<T>],
elements: &[T],
element_func: impl Fn(&T) -> T,
) {
resources
.get_mut(first..first + elements.len())
.expect("descriptor write for binding out of bounds")
.iter_mut()
.zip(elements)
.for_each(|(resource, element)| {
*resource = Some(element_func(element));
});
}
let default_image_layout = descriptor_type.default_image_layout();
let first = write.first_array_element() as usize;
match write.elements() {
WriteDescriptorSetElements::None(num_elements) => match self {
DescriptorBindingResources::None(resources) => {
resources
.get_mut(first..first + *num_elements as usize)
.expect("descriptor write for binding out of bounds")
.iter_mut()
.for_each(|resource| {
*resource = Some(());
});
}
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
WriteDescriptorSetElements::Buffer(elements) => match self {
DescriptorBindingResources::Buffer(resources) => {
write_resources(first, resources, elements, Clone::clone)
}
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
WriteDescriptorSetElements::BufferView(elements) => match self {
DescriptorBindingResources::BufferView(resources) => {
write_resources(first, resources, elements, Clone::clone)
}
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
WriteDescriptorSetElements::ImageView(elements) => match self {
DescriptorBindingResources::ImageView(resources) => {
write_resources(first, resources, elements, |element| {
let mut element = element.clone();
if element.image_layout == ImageLayout::Undefined {
element.image_layout = default_image_layout;
}
element
})
}
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
WriteDescriptorSetElements::ImageViewSampler(elements) => match self {
DescriptorBindingResources::ImageViewSampler(resources) => {
write_resources(first, resources, elements, |element| {
let mut element = element.clone();
if element.0.image_layout == ImageLayout::Undefined {
element.0.image_layout = default_image_layout;
}
element
})
}
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
WriteDescriptorSetElements::Sampler(elements) => match self {
DescriptorBindingResources::Sampler(resources) => {
write_resources(first, resources, elements, Clone::clone)
}
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
WriteDescriptorSetElements::InlineUniformBlock(_) => match self {
DescriptorBindingResources::InlineUniformBlock => (),
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
WriteDescriptorSetElements::AccelerationStructure(elements) => match self {
DescriptorBindingResources::AccelerationStructure(resources) => {
write_resources(first, resources, elements, Clone::clone)
}
_ => panic!(
"descriptor write for binding {} has wrong resource type",
write.binding(),
),
},
}
}
pub(crate) fn copy(
&mut self,
src: &DescriptorBindingResources,
src_start: u32,
dst_start: u32,
count: u32,
) {
let src_start = src_start as usize;
let dst_start = dst_start as usize;
let count = count as usize;
match src {
DescriptorBindingResources::None(src) => match self {
DescriptorBindingResources::None(dst) => dst[dst_start..dst_start + count]
.clone_from_slice(&src[src_start..src_start + count]),
_ => panic!("descriptor copy has wrong resource type"),
},
DescriptorBindingResources::Buffer(src) => match self {
DescriptorBindingResources::Buffer(dst) => dst[dst_start..dst_start + count]
.clone_from_slice(&src[src_start..src_start + count]),
_ => panic!("descriptor copy has wrong resource type"),
},
DescriptorBindingResources::BufferView(src) => match self {
DescriptorBindingResources::BufferView(dst) => dst[dst_start..dst_start + count]
.clone_from_slice(&src[src_start..src_start + count]),
_ => panic!("descriptor copy has wrong resource type"),
},
DescriptorBindingResources::ImageView(src) => match self {
DescriptorBindingResources::ImageView(dst) => dst[dst_start..dst_start + count]
.clone_from_slice(&src[src_start..src_start + count]),
_ => panic!("descriptor copy has wrong resource type"),
},
DescriptorBindingResources::ImageViewSampler(src) => match self {
DescriptorBindingResources::ImageViewSampler(dst) => dst
[dst_start..dst_start + count]
.clone_from_slice(&src[src_start..src_start + count]),
_ => panic!("descriptor copy has wrong resource type"),
},
DescriptorBindingResources::Sampler(src) => match self {
DescriptorBindingResources::Sampler(dst) => dst[dst_start..dst_start + count]
.clone_from_slice(&src[src_start..src_start + count]),
_ => panic!("descriptor copy has wrong resource type"),
},
DescriptorBindingResources::InlineUniformBlock => match self {
DescriptorBindingResources::InlineUniformBlock => (),
_ => panic!("descriptor copy has wrong resource type"),
},
DescriptorBindingResources::AccelerationStructure(src) => match self {
DescriptorBindingResources::AccelerationStructure(dst) => dst
[dst_start..dst_start + count]
.clone_from_slice(&src[src_start..src_start + count]),
_ => panic!("descriptor copy has wrong resource type"),
},
}
}
}
#[derive(Clone)]
pub struct DescriptorSetWithOffsets {
descriptor_set: Arc<dyn DescriptorSet>,
dynamic_offsets: SmallVec<[u32; 4]>,
}
impl DescriptorSetWithOffsets {
pub fn new(
descriptor_set: Arc<dyn DescriptorSet>,
dynamic_offsets: impl IntoIterator<Item = u32>,
) -> Self {
Self {
descriptor_set,
dynamic_offsets: dynamic_offsets.into_iter().collect(),
}
}
#[inline]
pub fn as_ref(&self) -> (&Arc<dyn DescriptorSet>, &[u32]) {
(&self.descriptor_set, &self.dynamic_offsets)
}
#[inline]
pub fn into_tuple(self) -> (Arc<dyn DescriptorSet>, impl ExactSizeIterator<Item = u32>) {
(self.descriptor_set, self.dynamic_offsets.into_iter())
}
}
impl<S> From<Arc<S>> for DescriptorSetWithOffsets
where
S: DescriptorSet + 'static,
{
fn from(descriptor_set: Arc<S>) -> Self {
DescriptorSetWithOffsets::new(descriptor_set, std::iter::empty())
}
}