📒 gpu-allocator

[dependencies]
gpu-allocator = "0.28.0"

This crate provides a fully written in Rust memory allocator for Vulkan, DirectX 12 and Metal.

Setting up the Vulkan memory allocator

use gpu_allocator::vulkan::*;letmut allocator = Allocator::new(&AllocatorCreateDesc{
instance,
device,
physical_device,debug_settings:Default::default(),buffer_device_address:true,// Ideally, check the BufferDeviceAddressFeatures struct.allocation_sizes:Default::default(),});

Simple Vulkan allocation example

use gpu_allocator::vulkan::*;use gpu_allocator::MemoryLocation;// Setup vulkan infolet vk_info = vk::BufferCreateInfo::default().size(512).usage(vk::BufferUsageFlags::STORAGE_BUFFER);let buffer = unsafe{ device.create_buffer(&vk_info,None)}.unwrap();let requirements = unsafe{ device.get_buffer_memory_requirements(buffer)};let allocation = allocator
.allocate(&AllocationCreateDesc{name:"Example allocation",
requirements,location:MemoryLocation::CpuToGpu,linear:true,// Buffers are always linearallocation_scheme:AllocationScheme::GpuAllocatorManaged,}).unwrap();// Bind memory to the bufferunsafe{ device.bind_buffer_memory(buffer, allocation.memory(), allocation.offset()).unwrap()};// Cleanup
allocator.free(allocation).unwrap();unsafe{ device.destroy_buffer(buffer,None)};

Setting up the D3D12 memory allocator

use gpu_allocator::d3d12::*;letmut allocator = Allocator::new(&AllocatorCreateDesc{device:ID3D12DeviceVersion::Device(device),debug_settings:Default::default(),allocation_sizes:Default::default(),});

Simple d3d12 allocation example

use gpu_allocator::d3d12::*;use gpu_allocator::MemoryLocation;let buffer_desc = Direct3D12::D3D12_RESOURCE_DESC{Dimension:Direct3D12::D3D12_RESOURCE_DIMENSION_BUFFER,Alignment:0,Width:512,Height:1,DepthOrArraySize:1,MipLevels:1,Format:Dxgi::Common::DXGI_FORMAT_UNKNOWN,SampleDesc:Dxgi::Common::DXGI_SAMPLE_DESC{Count:1,Quality:0,},Layout:Direct3D12::D3D12_TEXTURE_LAYOUT_ROW_MAJOR,Flags:Direct3D12::D3D12_RESOURCE_FLAG_NONE,};let allocation_desc = AllocationCreateDesc::from_d3d12_resource_desc(&allocator.device(),&buffer_desc,"Example allocation",MemoryLocation::GpuOnly,);let allocation = allocator.allocate(&allocation_desc).unwrap();letmut resource:Option<Direct3D12::ID3D12Resource> = None;let hr = unsafe{
device.CreatePlacedResource(
allocation.heap(),
allocation.offset(),&buffer_desc,Direct3D12::D3D12_RESOURCE_STATE_COMMON,None,&mut resource,)}?;// Cleanupdrop(resource);
allocator.free(allocation).unwrap();

Setting up the Metal memory allocator

use gpu_allocator::metal::*;letmut allocator = Allocator::new(&AllocatorCreateDesc{device: device.clone(),debug_settings:Default::default(),allocation_sizes:Default::default(),create_residency_set:false,});

Simple Metal allocation example

use gpu_allocator::metal::*;use gpu_allocator::MemoryLocation;let allocation_desc = AllocationCreateDesc::buffer(&device,"Example allocation",512,// size in bytesMemoryLocation::GpuOnly,);let allocation = allocator.allocate(&allocation_desc).unwrap();let heap = unsafe{ allocation.heap()};let resource = unsafe{
heap.newBufferWithLength_options_offset(
allocation.size()asusize,
heap.resourceOptions(),
allocation.offset()asusize,)}.unwrap();// Cleanupdrop(resource);
allocator.free(&allocation).unwrap();

no_std support

no_std support can be enabled by compiling with --no-default-features to disable std support and --features hashbrown for Hash collections that are only defined in std for internal usages in crate. For example:

[dependencies]
gpu-allocator = { version = "0.28.0", default-features = false, features = ["hashbrown", "other features"] }

To support both std and no_std builds in your project, use the following in your Cargo.toml:

[features]
default = ["std", "other features"]
std = ["gpu-allocator/std"]
hashbrown = ["gpu-allocator/hashbrown"]
other_features = []
[dependencies]
gpu-allocator = { version = "0.28.0", default-features = false }

Minimum Supported Rust Version

The MSRV for this crate and the vulkan, d3d12 and metal features is Rust 1.71.

The no_std support requires Rust 1.81 or higher because no_std support of dependency thiserror requires core::error::Error which is stabilized in 1.81.

Any other features such as the visualizer (with all the egui dependencies) may have a higher requirement and are not tested in our CI.

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Alternative libraries

• vk-mem-rs

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.