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
//! Acceleration structure resource types
use {
super::{
access_type_from_u8, access_type_into_u8, device::Device, Buffer, BufferInfo, DriverError,
},
ash::vk,
derive_builder::{Builder, UninitializedFieldError},
log::warn,
std::{
mem::size_of_val,
ops::Deref,
sync::{
atomic::{AtomicU8, Ordering},
Arc,
},
thread::panicking,
},
vk_sync::AccessType,
};
/// Smart pointer handle to an [acceleration structure] object.
///
/// Also contains the backing buffer and information about the object.
///
/// ## `Deref` behavior
///
/// `AccelerationStructure` automatically dereferences to [`vk::AccelerationStructureKHR`] (via the
/// [`Deref`] trait), so you can call `vk::AccelerationStructureKHR`'s methods on a value of
/// type `AccelerationStructure`. To avoid name clashes with `vk::AccelerationStructureKHR`'s
/// methods, the methods of `AccelerationStructure` itself are associated functions, called using
/// [fully qualified syntax]:
///
/// ```no_run
/// # use std::sync::Arc;
/// # use ash::vk;
/// # use screen_13::driver::{AccessType, DriverError};
/// # use screen_13::driver::device::{Device, DeviceInfo};
/// # use screen_13::driver::accel_struct::{AccelerationStructure, AccelerationStructureInfo};
/// # fn main() -> Result<(), DriverError> {
/// # let device = Arc::new(Device::create_headless(DeviceInfo::new())?);
/// # const SIZE: vk::DeviceSize = 1024;
/// # let info = AccelerationStructureInfo::blas(SIZE);
/// # let my_accel_struct = AccelerationStructure::create(&device, info)?;
/// let addr = AccelerationStructure::device_address(&my_accel_struct);
/// # Ok(()) }
/// ```
///
/// [acceleration structure]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkAccelerationStructureKHR.html
/// [deref]: core::ops::Deref
/// [fully qualified syntax]: https://doc.rust-lang.org/book/ch19-03-advanced-traits.html#fully-qualified-syntax-for-disambiguation-calling-methods-with-the-same-name
#[derive(Debug)]
pub struct AccelerationStructure {
accel_struct: vk::AccelerationStructureKHR,
/// Backing storage buffer for this object.
pub buffer: Buffer,
device: Arc<Device>,
/// Information used to create this object.
pub info: AccelerationStructureInfo,
prev_access: AtomicU8,
}
impl AccelerationStructure {
/// Creates a new acceleration structure on the given device.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # use std::sync::Arc;
/// # use ash::vk;
/// # use screen_13::driver::DriverError;
/// # use screen_13::driver::device::{Device, DeviceInfo};
/// # use screen_13::driver::accel_struct::{AccelerationStructure, AccelerationStructureInfo};
/// # fn main() -> Result<(), DriverError> {
/// # let device = Arc::new(Device::create_headless(DeviceInfo::new())?);
/// const SIZE: vk::DeviceSize = 1024;
/// let info = AccelerationStructureInfo::blas(SIZE);
/// let accel_struct = AccelerationStructure::create(&device, info)?;
///
/// assert_ne!(*accel_struct, vk::AccelerationStructureKHR::null());
/// assert_eq!(accel_struct.info.size, SIZE);
/// # Ok(()) }
/// ```
#[profiling::function]
pub fn create(
device: &Arc<Device>,
info: impl Into<AccelerationStructureInfo>,
) -> Result<Self, DriverError> {
let info = info.into();
let buffer = Buffer::create(
device,
BufferInfo::host_mem(
info.size,
vk::BufferUsageFlags::ACCELERATION_STRUCTURE_STORAGE_KHR
| vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS,
),
)?;
let accel_struct = {
let create_info = vk::AccelerationStructureCreateInfoKHR::builder()
.ty(info.ty)
.buffer(*buffer)
.size(info.size);
unsafe {
device
.accel_struct_ext
.as_ref()
.unwrap()
.create_acceleration_structure(&create_info, None)
.map_err(|err| {
warn!("{err}");
DriverError::Unsupported
})?
}
};
let device = Arc::clone(device);
Ok(AccelerationStructure {
accel_struct,
buffer,
device,
info,
prev_access: AtomicU8::new(access_type_into_u8(AccessType::Nothing)),
})
}
/// Keeps track of some `next_access` which affects this object.
///
/// Returns the previous access for which a pipeline barrier should be used to prevent data
/// corruption.
///
/// # Note
///
/// Used to maintain object state when passing a _Screen 13_-created
/// `vk::AccelerationStructureKHR` handle to external code such as [_Ash_] or [_Erupt_]
/// bindings.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # use std::sync::Arc;
/// # use ash::vk;
/// # use screen_13::driver::{AccessType, DriverError};
/// # use screen_13::driver::device::{Device, DeviceInfo};
/// # use screen_13::driver::accel_struct::{AccelerationStructure, AccelerationStructureInfo};
/// # fn main() -> Result<(), DriverError> {
/// # let device = Arc::new(Device::create_headless(DeviceInfo::new())?);
/// # const SIZE: vk::DeviceSize = 1024;
/// # let info = AccelerationStructureInfo::blas(SIZE);
/// # let my_accel_struct = AccelerationStructure::create(&device, info)?;
/// // Initially we want to "Build Write"
/// let next = AccessType::AccelerationStructureBuildWrite;
/// let prev = AccelerationStructure::access(&my_accel_struct, next);
/// assert_eq!(prev, AccessType::Nothing);
///
/// // External code may now "Build Write"; no barrier required
///
/// // Subsequently we want to "Build Read"
/// let next = AccessType::AccelerationStructureBuildRead;
/// let prev = AccelerationStructure::access(&my_accel_struct, next);
/// assert_eq!(prev, AccessType::AccelerationStructureBuildWrite);
///
/// // A barrier on "Build Write" before "Build Read" is required!
/// # Ok(()) }
/// ```
///
/// [_Ash_]: https://crates.io/crates/ash
/// [_Erupt_]: https://crates.io/crates/erupt
#[profiling::function]
pub fn access(this: &Self, next_access: AccessType) -> AccessType {
access_type_from_u8(
this.prev_access
.swap(access_type_into_u8(next_access), Ordering::Relaxed),
)
}
/// Returns the device address of this object.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # use std::sync::Arc;
/// # use ash::vk;
/// # use screen_13::driver::{AccessType, DriverError};
/// # use screen_13::driver::device::{Device, DeviceInfo};
/// # use screen_13::driver::accel_struct::{AccelerationStructure, AccelerationStructureInfo};
/// # fn main() -> Result<(), DriverError> {
/// # let device = Arc::new(Device::create_headless(DeviceInfo::new())?);
/// # const SIZE: vk::DeviceSize = 1024;
/// # let info = AccelerationStructureInfo::blas(SIZE);
/// # let my_accel_struct = AccelerationStructure::create(&device, info)?;
/// let addr = AccelerationStructure::device_address(&my_accel_struct);
///
/// assert_ne!(addr, 0);
/// # Ok(()) }
/// ```
#[profiling::function]
pub fn device_address(this: &Self) -> vk::DeviceAddress {
unsafe {
this.device
.accel_struct_ext
.as_ref()
.unwrap()
.get_acceleration_structure_device_address(
&vk::AccelerationStructureDeviceAddressInfoKHR::builder()
.acceleration_structure(this.accel_struct),
)
}
}
/// Helper function which is used to prepare instance buffers.
pub fn instance_slice(instances: &[vk::AccelerationStructureInstanceKHR]) -> &[u8] {
use std::slice::from_raw_parts;
unsafe { from_raw_parts(instances.as_ptr() as *const _, size_of_val(instances)) }
}
/// Returns the size of some geometry info which is then used to create a new
/// [AccelerationStructure] instance or update an existing instance.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # use std::sync::Arc;
/// # use ash::vk;
/// # use screen_13::driver::DriverError;
/// # use screen_13::driver::device::{Device, DeviceInfo};
/// # use screen_13::driver::accel_struct::{AccelerationStructure, AccelerationStructureGeometry, AccelerationStructureGeometryData, AccelerationStructureGeometryInfo, DeviceOrHostAddress};
/// # fn main() -> Result<(), DriverError> {
/// # let device = Arc::new(Device::create_headless(DeviceInfo::new())?);
/// # let my_geom = AccelerationStructureGeometryData::Triangles {
/// # index_data: DeviceOrHostAddress::DeviceAddress(0),
/// # index_type: vk::IndexType::UINT32,
/// # max_vertex: 1,
/// # transform_data: None,
/// # vertex_data: DeviceOrHostAddress::DeviceAddress(0),
/// # vertex_format: vk::Format::R32G32B32_SFLOAT,
/// # vertex_stride: 12,
/// # };
/// let my_info = AccelerationStructureGeometryInfo {
/// ty: vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL,
/// flags: vk::BuildAccelerationStructureFlagsKHR::empty(),
/// geometries: vec![AccelerationStructureGeometry {
/// max_primitive_count: 1,
/// flags: vk::GeometryFlagsKHR::OPAQUE,
/// geometry: my_geom,
/// }],
/// };
/// let res = AccelerationStructure::size_of(&device, &my_info);
///
/// assert_eq!(res.create_size, 2432);
/// assert_eq!(res.build_size, 640);
/// assert_eq!(res.update_size, 0);
/// # Ok(()) }
/// ```
#[profiling::function]
pub fn size_of(
device: &Arc<Device>,
info: &AccelerationStructureGeometryInfo,
) -> AccelerationStructureSize {
use std::cell::RefCell;
#[derive(Default)]
struct Tls {
geometries: Vec<vk::AccelerationStructureGeometryKHR>,
max_primitive_counts: Vec<u32>,
}
thread_local! {
static TLS: RefCell<Tls> = Default::default();
}
TLS.with_borrow_mut(|tls| {
tls.geometries.clear();
tls.max_primitive_counts.clear();
for info in info.geometries.iter() {
let flags = info.flags;
let (geometry_type, geometry) = match info.geometry {
AccelerationStructureGeometryData::AABBs { stride } => (
vk::GeometryTypeKHR::AABBS,
vk::AccelerationStructureGeometryDataKHR {
aabbs: vk::AccelerationStructureGeometryAabbsDataKHR {
stride,
..Default::default()
},
},
),
AccelerationStructureGeometryData::Instances {
array_of_pointers, ..
} => (
vk::GeometryTypeKHR::INSTANCES,
vk::AccelerationStructureGeometryDataKHR {
instances: vk::AccelerationStructureGeometryInstancesDataKHR {
array_of_pointers: array_of_pointers as _,
..Default::default()
},
},
),
AccelerationStructureGeometryData::Triangles {
index_type,
max_vertex,
transform_data,
vertex_format,
vertex_stride,
..
} => (
vk::GeometryTypeKHR::TRIANGLES,
vk::AccelerationStructureGeometryDataKHR {
triangles: vk::AccelerationStructureGeometryTrianglesDataKHR {
vertex_format,
vertex_stride,
max_vertex,
index_type,
transform_data: match transform_data {
Some(DeviceOrHostAddress::DeviceAddress(device_address)) => {
vk::DeviceOrHostAddressConstKHR { device_address }
}
Some(DeviceOrHostAddress::HostAddress) => {
vk::DeviceOrHostAddressConstKHR {
host_address: std::ptr::null(),
} // TODO
}
None => vk::DeviceOrHostAddressConstKHR { device_address: 0 },
},
..Default::default()
},
},
),
};
tls.geometries.push(vk::AccelerationStructureGeometryKHR {
flags,
geometry_type,
geometry,
..Default::default()
});
tls.max_primitive_counts.push(info.max_primitive_count);
}
let info = vk::AccelerationStructureBuildGeometryInfoKHR::builder()
.ty(info.ty)
.flags(info.flags)
.geometries(&tls.geometries);
let sizes = unsafe {
device
.accel_struct_ext
.as_ref()
.expect("ray tracing feature must be enabled")
.get_acceleration_structure_build_sizes(
vk::AccelerationStructureBuildTypeKHR::HOST_OR_DEVICE,
&info,
tls.max_primitive_counts.as_slice(),
)
};
AccelerationStructureSize {
create_size: sizes.acceleration_structure_size,
build_size: sizes.build_scratch_size,
update_size: sizes.update_scratch_size,
}
})
}
}
impl Deref for AccelerationStructure {
type Target = vk::AccelerationStructureKHR;
fn deref(&self) -> &Self::Target {
&self.accel_struct
}
}
impl Drop for AccelerationStructure {
#[profiling::function]
fn drop(&mut self) {
if panicking() {
return;
}
unsafe {
self.device
.accel_struct_ext
.as_ref()
.unwrap()
.destroy_acceleration_structure(self.accel_struct, None);
}
}
}
/// Structure specifying geometries to be built into an acceleration structure.
///
/// See
/// [VkAccelerationStructureGeometryKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkAccelerationStructureGeometryKHR.html)
/// for more information.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct AccelerationStructureGeometry {
/// The number of primitives built into each geometry.
pub max_primitive_count: u32,
/// Describes additional properties of how the geometry should be built.
pub flags: vk::GeometryFlagsKHR,
/// Specifies acceleration structure geometry data.
pub geometry: AccelerationStructureGeometryData,
}
impl AccelerationStructureGeometry {
pub(crate) fn into_vk(self) -> vk::AccelerationStructureGeometryKHR {
let (geometry_type, geometry) = match self.geometry {
AccelerationStructureGeometryData::AABBs { stride } => (
vk::GeometryTypeKHR::AABBS,
vk::AccelerationStructureGeometryDataKHR {
aabbs: vk::AccelerationStructureGeometryAabbsDataKHR {
stride,
..Default::default()
},
},
),
AccelerationStructureGeometryData::Instances {
array_of_pointers,
data,
} => (
vk::GeometryTypeKHR::INSTANCES,
vk::AccelerationStructureGeometryDataKHR {
instances: vk::AccelerationStructureGeometryInstancesDataKHR {
array_of_pointers: array_of_pointers as _,
data: match data {
DeviceOrHostAddress::DeviceAddress(device_address) => {
vk::DeviceOrHostAddressConstKHR { device_address }
}
DeviceOrHostAddress::HostAddress => todo!(),
},
..Default::default()
},
},
),
AccelerationStructureGeometryData::Triangles {
index_data,
index_type,
max_vertex,
transform_data,
vertex_data,
vertex_format,
vertex_stride,
} => (
vk::GeometryTypeKHR::TRIANGLES,
vk::AccelerationStructureGeometryDataKHR {
triangles: vk::AccelerationStructureGeometryTrianglesDataKHR {
index_data: match index_data {
DeviceOrHostAddress::DeviceAddress(device_address) => {
vk::DeviceOrHostAddressConstKHR { device_address }
}
DeviceOrHostAddress::HostAddress => todo!(),
},
index_type,
max_vertex,
transform_data: match transform_data {
Some(DeviceOrHostAddress::DeviceAddress(device_address)) => {
vk::DeviceOrHostAddressConstKHR { device_address }
}
Some(DeviceOrHostAddress::HostAddress) => todo!(),
None => vk::DeviceOrHostAddressConstKHR { device_address: 0 },
},
vertex_data: match vertex_data {
DeviceOrHostAddress::DeviceAddress(device_address) => {
vk::DeviceOrHostAddressConstKHR { device_address }
}
DeviceOrHostAddress::HostAddress => todo!(),
},
vertex_format,
vertex_stride,
..Default::default()
},
},
),
};
let flags = self.flags;
vk::AccelerationStructureGeometryKHR {
flags,
geometry_type,
geometry,
..Default::default()
}
}
}
/// Specifies the geometry data used to build an acceleration structure.
///
/// See
/// [VkAccelerationStructureBuildGeometryInfoKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkAccelerationStructureBuildGeometryInfoKHR.html)
/// for more information.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct AccelerationStructureGeometryInfo {
/// Type of acceleration structure.
pub ty: vk::AccelerationStructureTypeKHR,
/// Specifies additional parameters of the acceleration structure.
pub flags: vk::BuildAccelerationStructureFlagsKHR,
/// An array of [AccelerationStructureGeometry] structures to be built.
pub geometries: Vec<AccelerationStructureGeometry>,
}
/// Specifies acceleration structure geometry data.
///
/// See
/// [VkAccelerationStructureGeometryDataKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkAccelerationStructureGeometryDataKHR.html)
/// for more information.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum AccelerationStructureGeometryData {
/// Axis-aligned bounding box geometry in a bottom-level acceleration structure.
///
/// See
/// [VkAccelerationStructureGeometryAabbsDataKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkAccelerationStructureGeometryAabbsDataKHR.html)
/// for more information.
AABBs {
/// Stride in bytes between each entry in data.
///
/// The stride must be a multiple of 8.
stride: vk::DeviceSize,
},
/// Geometry consisting of instances of other acceleration structures.
///
/// See [VkAccelerationStructureGeometryInstancesDataKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkAccelerationStructureGeometryInstancesDataKHR.html)
/// for more information.
Instances {
/// Specifies whether data is used as an array of addresses or just an array.
array_of_pointers: bool,
/// Either the address of an array of device referencing individual
/// VkAccelerationStructureInstanceKHR structures or packed motion instance information as
/// described in
/// [motion instances](https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#acceleration-structure-motion-instances)
/// if `array_of_pointers` is `true`, or the address of an array of
/// VkAccelerationStructureInstanceKHR structures.
///
/// Addresses and VkAccelerationStructureInstanceKHR structures are tightly packed.
data: DeviceOrHostAddress,
},
/// A triangle geometry in a bottom-level acceleration structure.
///
/// See
/// [VkAccelerationStructureGeometryTrianglesDataKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkAccelerationStructureGeometryTrianglesDataKHR.html)
/// for more information.
Triangles {
/// A device or host address to memory containing index data for this geometry.
index_data: DeviceOrHostAddress,
/// The
/// [VkIndexType](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkIndexType.html)
/// of each index element.
index_type: vk::IndexType,
/// The highest index of a vertex that will be addressed by a build command using this structure.
max_vertex: u32,
/// A device or host address to memory containing an optional reference to a
/// [VkTransformMatrixKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkTransformMatrixKHR.html)
/// structure describing a transformation from the space in which the vertices in this
/// geometry are described to the space in which the acceleration structure is defined.
transform_data: Option<DeviceOrHostAddress>,
/// A device or host address to memory containing vertex data for this geometry.
vertex_data: DeviceOrHostAddress,
/// The
/// [VkFormat](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkFormat.html)
/// of each vertex element.
vertex_format: vk::Format,
/// The stride in bytes between each vertex.
vertex_stride: vk::DeviceSize,
},
}
/// Information used to create an [`AccelerationStructure`] instance.
#[derive(Builder, Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[builder(
build_fn(
private,
name = "fallible_build",
error = "AccelerationStructureInfoBuilderError"
),
derive(Clone, Copy, Debug),
pattern = "owned"
)]
#[non_exhaustive]
pub struct AccelerationStructureInfo {
/// Type of acceleration structure.
#[builder(default = "vk::AccelerationStructureTypeKHR::GENERIC")]
pub ty: vk::AccelerationStructureTypeKHR,
/// The size of the backing buffer that will store the acceleration structure.
///
/// Use [`AccelerationStructure::size_of`] to calculate this value.
pub size: vk::DeviceSize,
}
impl AccelerationStructureInfo {
/// Specifies a [`vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL`] acceleration structure of the
/// given size.
#[inline(always)]
pub const fn blas(size: vk::DeviceSize) -> Self {
Self {
ty: vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL,
size,
}
}
/// Specifies a [`vk::AccelerationStructureTypeKHR::GENERIC`] acceleration structure of the
/// given size.
#[inline(always)]
pub const fn generic(size: vk::DeviceSize) -> Self {
Self {
ty: vk::AccelerationStructureTypeKHR::GENERIC,
size,
}
}
/// Specifies a [`vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL`] acceleration structure of the
/// given size.
#[deprecated = "Use AccelerationStructureInfo::blas()"]
#[doc(hidden)]
pub const fn new_blas(size: vk::DeviceSize) -> Self {
Self {
ty: vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL,
size,
}
}
/// Specifies a [`vk::AccelerationStructureTypeKHR::TOP_LEVEL`] acceleration structure of the
/// given size.
#[deprecated = "Use AccelerationStructureInfo::tlas()"]
#[doc(hidden)]
pub const fn new_tlas(size: vk::DeviceSize) -> Self {
Self {
ty: vk::AccelerationStructureTypeKHR::TOP_LEVEL,
size,
}
}
/// Specifies a [`vk::AccelerationStructureTypeKHR::TOP_LEVEL`] acceleration structure of the
/// given size.
#[inline(always)]
pub const fn tlas(size: vk::DeviceSize) -> Self {
Self {
ty: vk::AccelerationStructureTypeKHR::TOP_LEVEL,
size,
}
}
/// Converts an `AccelerationStructureInfo` into an `AccelerationStructureInfoBuilder`.
#[inline(always)]
pub fn to_builder(self) -> AccelerationStructureInfoBuilder {
AccelerationStructureInfoBuilder {
ty: Some(self.ty),
size: Some(self.size),
}
}
}
impl From<AccelerationStructureInfo> for () {
fn from(_: AccelerationStructureInfo) -> Self {}
}
impl AccelerationStructureInfoBuilder {
/// Builds a new `AccelerationStructureInfo`.
///
/// # Panics
///
/// If any of the following values have not been set this function will panic:
///
/// * `size`
#[inline(always)]
pub fn build(self) -> AccelerationStructureInfo {
match self.fallible_build() {
Err(AccelerationStructureInfoBuilderError(err)) => panic!("{err}"),
Ok(info) => info,
}
}
}
#[derive(Debug)]
struct AccelerationStructureInfoBuilderError(UninitializedFieldError);
impl From<UninitializedFieldError> for AccelerationStructureInfoBuilderError {
fn from(err: UninitializedFieldError) -> Self {
Self(err)
}
}
/// Holds the results of the [`AccelerationStructure::size_of`] function.
#[derive(Clone, Copy, Debug)]
pub struct AccelerationStructureSize {
/// The size of the scratch buffer required when updating an acceleration structure using the
/// [`Acceleration::build_structure`](super::super::graph::pass_ref::Acceleration::build_structure)
/// function.
pub build_size: vk::DeviceSize,
/// The value of `size` parameter needed by [`AccelerationStructureInfo`] for use with the
/// [`AccelerationStructure::create`] function.
pub create_size: vk::DeviceSize,
/// The size of the scratch buffer required when updating an acceleration structure using the
/// [`Acceleration::update_structure`](super::super::graph::pass_ref::Acceleration::update_structure)
/// function.
pub update_size: vk::DeviceSize,
}
/// Specifies a constant device or host address.
///
/// See
/// [VkDeviceOrHostAddressConstKHR](https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDeviceOrHostAddressConstKHR.html)
/// for more information.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum DeviceOrHostAddress {
/// An address value returned from [`AccelerationStructure::device_address`].
DeviceAddress(vk::DeviceAddress),
/// TODO: Not yet supported
HostAddress,
}
impl From<vk::DeviceAddress> for DeviceOrHostAddress {
fn from(device_addr: vk::DeviceAddress) -> Self {
Self::DeviceAddress(device_addr)
}
}
#[cfg(test)]
mod tests {
use super::*;
type Info = AccelerationStructureInfo;
type Builder = AccelerationStructureInfoBuilder;
#[test]
pub fn accel_struct_info() {
let info = Info::generic(0);
let builder = info.to_builder().build();
assert_eq!(info, builder);
}
#[test]
pub fn accel_struct_info_builder() {
let info = Info::generic(0);
let builder = Builder::default().size(0).build();
assert_eq!(info, builder);
}
#[test]
#[should_panic(expected = "Field not initialized: size")]
pub fn accel_struct_info_builder_uninit_size() {
Builder::default().build();
}
}