Struct dynamic_ocl::buffer::BufferBuilder

#[must_use]
pub struct BufferBuilder<'c, H: HostAccess = HostReadWrite, D: DeviceAccess = DeviceReadWrite, F: BufferFlags = NoFlags> { /* fields omitted */ }

A partially built buffer

Methods

impl<'c> BufferBuilder<'c>

pub fn new(context: &'c Context) -> Self

Start building a new OpenCL buffer for the given context.

impl<'c, H: HostAccess, D: DeviceAccess, F: BufferFlags> BufferBuilder<'c, H, D, F>

pub fn host_access<H2: HostAccess>(self) -> BufferBuilder<'c, H2, D, F>

Set the host accessibility for this buffer.

pub fn device_access<D2: DeviceAccess>(self) -> BufferBuilder<'c, H, D2, F>

Set the device accessibility for this buffer.

pub fn alloc_host_ptr(self) -> BufferBuilder<'c, H, D, AllocHostPtr>

Set the CL_MEM_ALLOC_HOST_PTR flag when creating this buffer.

pub fn build_copying_slice<T: MemSafe>(
    self,
    slice: &[T]
) -> Result<Buffer<'static, H, T>>

Build a buffer, copying initial data from the given slice, with the CL_MEM_COPY_HOST_PTR flag set.

pub fn build_with_size<T: MemSafe>(
    self,
    size: usize
) -> Result<Buffer<'static, H, T>>

Build a buffer with space for size elements of type T. The initial contents of the buffer are unspecified.

impl<'c, H: HostAccess, D: DeviceAccess> BufferBuilder<'c, H, D, NoFlags>

pub fn build_using_slice<T: MemSafe>(
    self,
    slice: &mut [T]
) -> Result<Buffer<H, T>>

Build a buffer using the given slice for storage, with the CL_MEM_USE_HOST_PTR flag set.

This type of buffer is still safe thanks to the borrow checker and MemSafe trait, but this also makes the API slightly more difficult to use. In order to safely access the underlying slice while the buffer exists, you must map the buffer to "borrow back" a reference to the slice, which should be a no-op in sane OpenCL implementations.

Trait Implementations

impl<'c, H: Clone + HostAccess, D: Clone + DeviceAccess, F: Clone + BufferFlags> Clone for BufferBuilder<'c, H, D, F>

fn clone(&self) -> BufferBuilder<'c, H, D, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c, H: Copy + HostAccess, D: Copy + DeviceAccess, F: Copy + BufferFlags> Copy for BufferBuilder<'c, H, D, F>