Struct demo_vk::graphics::vulkan::Block

pub struct Block { /* private fields */ }

Allocators return blocks of memory that can be used for Vulkan operations.

Implementations

impl 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 Clone for Block

fn clone(&self) -> Block

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl PartialEq for Block

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Block

impl Eq for Block

impl Send for Block

Blocks are not Send by default because they include the mapped_ptr.

It is safe to send the mapped ptr between threads, but the application is responsible for synchronizing access to the underlying buffer via the pointer.

impl StructuralPartialEq for Block

impl Sync for Block

It is generally safe to share blocks between threads. The application is responsible for synchronizing access to device memory.