Struct Buffer

pub struct Buffer<B: Backend> { /* private fields */ }

Generic buffer resource wrapper.

Parameters

B - raw image type.

Implementations

impl<B> Buffer<B>

where B: Backend,

pub fn device_id(&self) -> DeviceId

Get owned id.

pub fn assert_device_owner(&self, device: &Device<B>)

Assert specified device is owner.

pub fn instance_id(&self) -> InstanceId

Get owned id.

pub fn assert_instance_owner(&self, instance: &Instance<B>)

Assert specified instance is owner.

impl<B> Buffer<B>

where B: Backend,

pub unsafe fn create( device: &Device<B>, heaps: &mut Heaps<B>, info: BufferInfo, memory_usage: impl MemoryUsage, ) -> Result<Self, BufferCreationError>

Create buffer, allocate memory block for it and bind.

Safety

In order to guarantee that Heap::allocate will return memory range owned by this Device, this Heaps instance must always be used with this Device instance.

Otherwise usage of hal methods must be always valid.

pub unsafe fn dispose(self, device: &Device<B>, heaps: &mut Heaps<B>)

Dispose of buffer resource. Deallocate memory block.

pub fn raw(&self) -> &B::Buffer

Get reference to raw buffer resource

pub unsafe fn raw_mut(&mut self) -> &mut B::Buffer

Get mutable reference to raw buffer resource

pub fn block(&self) -> &MemoryBlock<B>

Get reference to memory block occupied by buffer.

pub unsafe fn block_mut(&mut self) -> &mut MemoryBlock<B>

Get mutable reference to memory block occupied by buffer.

pub fn info(&self) -> &BufferInfo

Get buffer info.

pub fn visible(&self) -> bool

Check if this buffer could is bound to CPU visible memory and therefore mappable. If this function returns false map will always return InvalidAccess.

pub fn map<'a>( &'a mut self, device: &Device<B>, range: Range<u64>, ) -> Result<MappedRange<'a, B>, MapError>

Map range of the buffer to the CPU accessible memory.

pub fn size(&self) -> u64

Get buffer info.

Trait Implementations

impl<B: Debug + Backend> Debug for Buffer<B>

where B::Buffer: Debug,

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

Formats the value using the given formatter.