📒 gpu-allocator

toml [dependencies] gpu-allocator = "0.21.0"

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

[Windows-rs] and [winapi]

gpu-allocator recently migrated from [winapi] to [windows-rs] but still provides convenient helpers to convert to and from [winapi] types, enabled when compiling with the public-winapi crate feature.

Setting up the Vulkan memory allocator

```rust use gpu_allocator::vulkan::*;

let mut allocator = Allocator::new(&AllocatorCreateDesc { instance, device, physicaldevice, debugsettings: Default::default(), bufferdeviceaddress: true, // Ideally, check the BufferDeviceAddressFeatures struct. }); ```

Simple Vulkan allocation example

```rust use gpuallocator::vulkan::*; use gpuallocator::MemoryLocation;

// Setup vulkan info let vkinfo = vk::BufferCreateInfo::builder() .size(512) .usage(vk::BufferUsageFlags::STORAGEBUFFER);

let buffer = unsafe { device.createbuffer(&vkinfo, None) }.unwrap(); let requirements = unsafe { device.getbuffermemory_requirements(buffer) };

let allocation = allocator .allocate(&AllocationCreateDesc { name: "Example allocation", requirements, location: MemoryLocation::CpuToGpu, linear: true, // Buffers are always linear }).unwrap();

// Bind memory to the buffer unsafe { device.bindbuffermemory(buffer, allocation.memory(), allocation.offset()).unwrap() };

// Cleanup allocator.free(allocation).unwrap(); unsafe { device.destroy_buffer(buffer, None) }; ```

Setting up the D3D12 memory allocator

```rust use gpu_allocator::d3d12::*;

let mut allocator = Allocator::new(&AllocatorCreateDesc { device, debug_settings: Default::default(), }); ```

Simple d3d12 allocation example

```rust use gpuallocator::d3d12::*; use gpuallocator::MemoryLocation;

let bufferdesc = Direct3D12::D3D12RESOURCEDESC { Dimension: Direct3D12::D3D12RESOURCEDIMENSIONBUFFER, Alignment: 0, Width: 512, Height: 1, DepthOrArraySize: 1, MipLevels: 1, Format: Dxgi::Common::DXGIFORMATUNKNOWN, SampleDesc: Dxgi::Common::DXGISAMPLEDESC { Count: 1, Quality: 0, }, Layout: Direct3D12::D3D12TEXTURELAYOUTROWMAJOR, Flags: Direct3D12::D3D12RESOURCEFLAGNONE, }; let allocationdesc = AllocationCreateDesc::fromd3d12resourcedesc( &allocator.device(), &bufferdesc, "Example allocation", MemoryLocation::GpuOnly, ); let allocation = allocator.allocate(&allocationdesc).unwrap(); let mut resource: Option = None; let hr = unsafe { device.CreatePlacedResource( allocation.heap(), allocation.offset(), &bufferdesc, Direct3D12::D3D12RESOURCESTATE_COMMON, None, &mut resource, ) }?;

// Cleanup drop(resource); allocator.free(allocation).unwrap(); ```

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.