vulkanalia_vma/
lib.rs

1// SPDX-License-Identifier: Apache-2.0
2
3//! An integration of [Vulkan Memory Allocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) with [`vulkanalia`](https://github.com/KyleMayes/vulkanalia).
4//!
5//! ### Example
6//!
7//! ```
8//! use vulkanalia::prelude::v1_0::*;
9//! use vulkanalia_vma::{self as vma, Alloc};
10//!
11//! fn example(instance: &Instance, device: &Device, physical_device: vk::PhysicalDevice) {
12//!     // Create an allocator.
13//!     let allocator_options = vma::AllocatorOptions::new(instance, device, physical_device);
14//!     let allocator = unsafe { vma::Allocator::new(&allocator_options) }.unwrap();
15//!
16//!     // Allocate a buffer using the allocator.
17//!     let buffer_create_info = vk::BufferCreateInfo::builder()
18//!         .size(65_536)
19//!         .usage(vk::BufferUsageFlags::VERTEX_BUFFER)
20//!         .sharing_mode(vk::SharingMode::CONCURRENT);
21//!     let allocation_options = vma::AllocationOptions::default();
22//!     let (buffer, allocation) = unsafe { allocator.create_buffer(buffer_create_info, &allocation_options) }.unwrap();
23//!
24//!     // Deallocate the buffer using the allocator.
25//!     unsafe { allocator.destroy_buffer(buffer, allocation) };
26//! }
27//! ```
28
29#![no_std]
30#![allow(unsafe_op_in_unsafe_fn, clippy::missing_safety_doc)]
31
32extern crate alloc;
33
34mod allocation;
35mod allocator;
36mod enums;
37mod flags;
38mod pool;
39mod r#virtual;
40
41/// Raw bindings to VMA.
42pub mod vma;
43
44pub use self::allocation::*;
45pub use self::allocator::*;
46pub use self::enums::*;
47pub use self::flags::*;
48pub use self::pool::*;
49pub use self::r#virtual::*;