Struct vulkano::memory::DeviceMemory

pub struct DeviceMemory { /* fields omitted */ }

Represents memory that has been allocated.

The destructor of DeviceMemory automatically frees the memory.

Example

use vulkano::memory::DeviceMemory;

let mem_ty = device.physical_device().memory_types().next().unwrap();

// Allocates 1KB of memory.
let memory = DeviceMemory::alloc(device.clone(), mem_ty, 1024).unwrap();

Implementations

impl DeviceMemory

pub fn alloc(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize
) -> Result<DeviceMemory, DeviceMemoryAllocError>

Allocates a chunk of memory from the device.

Some platforms may have a limit on the maximum size of a single allocation. For example, certain systems may fail to create allocations with a size greater than or equal to 4GB.

Panic

• Panics if size is 0.
• Panics if memory_type doesn’t belong to the same physical device as device.

pub fn dedicated_alloc(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize,
    resource: DedicatedAlloc<'_>
) -> Result<DeviceMemory, DeviceMemoryAllocError>

Same as alloc, but allows specifying a resource that will be bound to the memory.

If a buffer or an image is specified in resource, then the returned memory must not be bound to a different buffer or image.

If the VK_KHR_dedicated_allocation extension is enabled on the device, then it will be used by this method. Otherwise the resource parameter will be ignored.

pub fn alloc_and_map(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize
) -> Result<MappedDeviceMemory, DeviceMemoryAllocError>

Allocates a chunk of memory and maps it.

Panic

• Panics if memory_type doesn’t belong to the same physical device as device.
• Panics if the memory type is not host-visible.

pub fn dedicated_alloc_and_map(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize,
    resource: DedicatedAlloc<'_>
) -> Result<MappedDeviceMemory, DeviceMemoryAllocError>

Equivalent of dedicated_alloc for alloc_and_map.

pub fn alloc_with_exportable_fd(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize
) -> Result<DeviceMemory, DeviceMemoryAllocError>

Same as alloc, but allows exportable file descriptor on Linux.

pub fn dedicated_alloc_with_exportable_fd(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize,
    resource: DedicatedAlloc<'_>
) -> Result<DeviceMemory, DeviceMemoryAllocError>

Same as dedicated_alloc, but allows exportable file descriptor on Linux.

pub fn alloc_and_map_with_exportable_fd(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize
) -> Result<MappedDeviceMemory, DeviceMemoryAllocError>

Same as alloc_and_map, but allows exportable file descriptor on Linux.

pub fn dedicated_alloc_and_map_with_exportable_fd(
    device: Arc<Device>,
    memory_type: MemoryType<'_>,
    size: usize,
    resource: DedicatedAlloc<'_>
) -> Result<MappedDeviceMemory, DeviceMemoryAllocError>

Same as dedicated_alloc_and_map, but allows exportable file descriptor on Linux.

pub fn memory_type(&self) -> MemoryType<'_>

Returns the memory type this chunk was allocated on.

pub fn size(&self) -> usize

Returns the size in bytes of that memory chunk.

pub fn export_fd(
    &self,
    handle_type: ExternalMemoryHandleType
) -> Result<File, DeviceMemoryAllocError>

Exports the device memory into a Unix file descriptor. The caller retains ownership of the file, as per the Vulkan spec.

Panic

• Panics if the user requests an invalid handle type for this device memory object.

Trait Implementations

impl AsMut<DeviceMemory> for MappedDeviceMemory

fn as_mut(&mut self) -> &mut DeviceMemory

Performs the conversion.

impl AsRef<DeviceMemory> for MappedDeviceMemory

fn as_ref(&self) -> &DeviceMemory

Performs the conversion.

impl Debug for DeviceMemory

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DeviceOwned for DeviceMemory

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl Drop for DeviceMemory

fn drop(&mut self)

Executes the destructor for this type.

impl VulkanObject for DeviceMemory

type Object = DeviceMemory

The type of the object.

fn internal_object(&self) -> DeviceMemory

Returns a reference to the object.