Struct demo_vk::graphics::vulkan::OwnedBlock

pub struct OwnedBlock { /* private fields */ }

A block allocation that frees itself when dropped.

Implementations

impl OwnedBlock

pub fn allocate_image( allocator: Arc<Allocator>, image_create_info: &ImageCreateInfo<'_>, flags: MemoryPropertyFlags, ) -> Result<(Self, Image)>

Creates an image and allocates memory to back it.

The image is bound to the memory prior to return, so the caller can use it right away.

pub fn allocate_buffer( allocator: Arc<Allocator>, buffer_create_info: &BufferCreateInfo<'_>, flags: MemoryPropertyFlags, ) -> Result<(OwnedBlock, Buffer)>

Creates a buffer and allocates memory to back it.

The buffer is bound to the memory prior to return, so the caller can use it right away.

Methods from Deref<Target = Block>

pub fn is_subregion_of(&self, other: &Block) -> bool

Returns true when self is entirely contained by other, false otherwise.

Note: partial overlaps are not considered ‘subregions’. A.is_subregion_of(B) will return true iff A is fully contained by B.

pub fn subregion(&self, offset: u64, size: u64) -> Result<Self>

Returns a subregion of the current Block.

Fails if the requested subregion is out of bounds or cannot fit within the current block.

Params

• offset: the offset in bytes from the beginning of the current block
• size: the size of the subregion to return

pub fn offset(&self) -> u64

Returns the start of the block as a byte offset into device memory.

pub fn size(&self) -> u64

Returns the size of the block in bytes.

pub fn memory(&self) -> DeviceMemory

Gets a non-owning copy of the underlying DeviceMemory handle.

Multiple blocks can reference the underlying memory. Blocks returned by the allocator are guaranteed to not overlap.

pub fn mapped_ptr(&self) -> *mut c_void

Returns the memory-mapped pointer for the DeviceMemory.

The pointer is null() if the memory is not mapped.

The pointer always points to the start of the Block and does not need to be manually adjusted to account for the offset.

pub fn memory_type_index(&self) -> u32

Returns the memory type index for the Block’s device memory.

Trait Implementations

impl Debug for OwnedBlock

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

Formats the value using the given formatter.

impl Deref for OwnedBlock

type Target = Block

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for OwnedBlock

fn drop(&mut self)

Executes the destructor for this type.