Struct vulkano::buffer::device_local::DeviceLocalBuffer [−][src]
pub struct DeviceLocalBuffer<T: ?Sized, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> { /* fields omitted */ }
Buffer whose content is in device-local memory.
This buffer type is useful in order to store intermediary data. For example you execute a compute shader that writes to this buffer, then read the content of the buffer in a following compute or graphics pipeline.
The DeviceLocalBuffer
will be in device-local memory, unless the device doesn’t provide any
device-local memory.
Implementations
impl<T> DeviceLocalBuffer<T>
[src]
impl<T> DeviceLocalBuffer<T>
[src]pub fn new<'a, I>(
device: Arc<Device>,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]
pub fn new<'a, I>(
device: Arc<Device>,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]Builds a new buffer. Only allowed for sized data.
impl<T> DeviceLocalBuffer<[T]>
[src]
impl<T> DeviceLocalBuffer<[T]>
[src]pub fn array<'a, I>(
device: Arc<Device>,
len: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]
pub fn array<'a, I>(
device: Arc<Device>,
len: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]Builds a new buffer. Can be used for arrays.
impl<T: ?Sized> DeviceLocalBuffer<T>
[src]
impl<T: ?Sized> DeviceLocalBuffer<T>
[src]pub unsafe fn raw<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]
pub unsafe fn raw<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]Builds a new buffer without checking the size.
Safety
You must ensure that the size that you pass is correct for T
.
pub unsafe fn raw_with_exportable_fd<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]
pub unsafe fn raw_with_exportable_fd<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]Same as raw
but with exportable fd option for the allocated memory on Linux
pub fn export_posix_fd(&self) -> Result<File, DeviceMemoryAllocError>
[src]
pub fn export_posix_fd(&self) -> Result<File, DeviceMemoryAllocError>
[src]Exports posix file descriptor for the allocated memory
requires khr_external_memory_fd
and khr_external_memory
extensions to be loaded.
Only works on Linux.
impl<T: ?Sized, A> DeviceLocalBuffer<T, A>
[src]
impl<T: ?Sized, A> DeviceLocalBuffer<T, A>
[src]pub fn queue_families(&self) -> Vec<QueueFamily<'_>>
[src]
pub fn queue_families(&self) -> Vec<QueueFamily<'_>>
[src]Returns the queue families this buffer can be used on.
Trait Implementations
impl<T: ?Sized, A> BufferAccess for DeviceLocalBuffer<T, A> where
T: 'static + Send + Sync,
[src]
impl<T: ?Sized, A> BufferAccess for DeviceLocalBuffer<T, A> where
T: 'static + Send + Sync,
[src]fn inner(&self) -> BufferInner<'_>
[src]
fn inner(&self) -> BufferInner<'_>
[src]Returns the inner information about this buffer.
fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]
fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]Returns true if an access to self
potentially overlaps the same memory as an access to
other
. Read more
fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]
fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]Returns true if an access to self
potentially overlaps the same memory as an access to
other
. Read more
fn conflict_key(&self) -> (u64, usize)
[src]
fn conflict_key(&self) -> (u64, usize)
[src]Returns a key that uniquely identifies the buffer. Two buffers or images that potentially overlap in memory must return the same key. Read more
fn try_gpu_lock(&self, exclusive: bool, _: &Queue) -> Result<(), AccessError>
[src]
fn try_gpu_lock(&self, exclusive: bool, _: &Queue) -> Result<(), AccessError>
[src]Locks the resource for usage on the GPU. Returns an error if the lock can’t be acquired. Read more
unsafe fn increase_gpu_lock(&self)
[src]
unsafe fn increase_gpu_lock(&self)
[src]Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one. Read more
unsafe fn unlock(&self)
[src]
unsafe fn unlock(&self)
[src]Unlocks the resource previously acquired with try_gpu_lock
or increase_gpu_lock
. Read more
fn as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self> where
Self: Sized + TypedBufferAccess,
[src]
fn as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self> where
Self: Sized + TypedBufferAccess,
[src]Builds a BufferSlice
object holding the buffer by reference.
fn slice<T>(&self, range: Range<usize>) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]
fn slice<T>(&self, range: Range<usize>) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]Builds a BufferSlice
object holding part of the buffer by reference. Read more
fn into_buffer_slice(self) -> BufferSlice<Self::Content, Self> where
Self: Sized + TypedBufferAccess,
[src]
fn into_buffer_slice(self) -> BufferSlice<Self::Content, Self> where
Self: Sized + TypedBufferAccess,
[src]Builds a BufferSlice
object holding the buffer by value.
fn index<T>(&self, index: usize) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]
fn index<T>(&self, index: usize) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]Builds a BufferSlice
object holding part of the buffer by reference. Read more
fn raw_device_address(
&self
) -> Result<NonZeroU64, DeviceAddressUsageNotEnabledError>
[src]
fn raw_device_address(
&self
) -> Result<NonZeroU64, DeviceAddressUsageNotEnabledError>
[src]Gets the device address for this buffer. Read more
impl<T: ?Sized, A> DeviceOwned for DeviceLocalBuffer<T, A>
[src]
impl<T: ?Sized, A> DeviceOwned for DeviceLocalBuffer<T, A>
[src]impl<T: ?Sized, A> PartialEq<DeviceLocalBuffer<T, A>> for DeviceLocalBuffer<T, A> where
T: 'static + Send + Sync,
[src]
impl<T: ?Sized, A> PartialEq<DeviceLocalBuffer<T, A>> for DeviceLocalBuffer<T, A> where
T: 'static + Send + Sync,
[src]impl<T: ?Sized, A> TypedBufferAccess for DeviceLocalBuffer<T, A> where
T: 'static + Send + Sync,
[src]
impl<T: ?Sized, A> TypedBufferAccess for DeviceLocalBuffer<T, A> where
T: 'static + Send + Sync,
[src]impl<T: ?Sized, A> Eq for DeviceLocalBuffer<T, A> where
T: 'static + Send + Sync,
[src]
T: 'static + Send + Sync,
Auto Trait Implementations
impl<T: ?Sized, A> RefUnwindSafe for DeviceLocalBuffer<T, A> where
A: RefUnwindSafe,
T: RefUnwindSafe,
A: RefUnwindSafe,
T: RefUnwindSafe,
impl<T: ?Sized, A> Send for DeviceLocalBuffer<T, A> where
A: Send,
T: Send,
A: Send,
T: Send,
impl<T: ?Sized, A> Sync for DeviceLocalBuffer<T, A> where
A: Sync,
T: Sync,
A: Sync,
T: Sync,
impl<T: ?Sized, A> Unpin for DeviceLocalBuffer<T, A> where
A: Unpin,
A: Unpin,
impl<T: ?Sized, A> UnwindSafe for DeviceLocalBuffer<T, A> where
A: UnwindSafe,
T: UnwindSafe,
A: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Content for T
[src]
impl<T> Content for T
[src]pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]
pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]Builds a pointer to this type from a raw pointer.
pub fn is_size_suitable(usize) -> bool
[src]
pub fn is_size_suitable(usize) -> bool
[src]Returns true if the size is suitable to store a type like this.
pub fn indiv_size() -> usize
[src]
pub fn indiv_size() -> usize
[src]Returns the size of an individual element.