Struct vulkano::memory::DeviceMemoryBuilder

pub struct DeviceMemoryBuilder<'a> { /* fields omitted */ }

Represents a builder for the device memory object.

Example

use vulkano::memory::DeviceMemoryBuilder;

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

// Allocates 1KB of memory.
let memory = DeviceMemoryBuilder::new(device, mem_ty.id(), 1024).build().unwrap();

Implementations

impl<'a> DeviceMemoryBuilder<'a>

pub fn new(
    device: Arc<Device>,
    memory_index: u32,
    size: usize
) -> DeviceMemoryBuilder<'a>

Returns a new DeviceMemoryBuilder given the required device, memory type and size fields. Validation of parameters is done when the builder is built.

pub fn dedicated_info(
    self,
    dedicated: DedicatedAlloc<'a>
) -> DeviceMemoryBuilder<'_>

Sets an optional field for dedicated allocations in the DeviceMemoryBuilder. To maintain backwards compatibility, this function does nothing when dedicated allocation has not been enabled on the device.

Panic

• Panics if the dedicated allocation info has already been set.

pub fn export_info(
    self,
    handle_types: ExternalMemoryHandleType
) -> DeviceMemoryBuilder<'a>

Sets an optional field for exportable allocations in the DeviceMemoryBuilder.

Panic

• Panics if the export info has already been set.

pub fn import_info(
    self,
    fd: File,
    handle_types: ExternalMemoryHandleType
) -> DeviceMemoryBuilder<'a>

Sets an optional field for importable DeviceMemory in the DeviceMemoryBuilder.

Panic

• Panics if the import info has already been set.

pub fn build(self) -> Result<Arc<DeviceMemory>, DeviceMemoryAllocError>

Creates a DeviceMemory object on success, consuming the DeviceMemoryBuilder. An error is returned if the requested allocation is too large or if the total number of allocations would exceed per-device limits.