Struct dynamic_ocl::buffer::Buffer

pub struct Buffer<'a, H: HostAccess, T: MemSafe> { /* fields omitted */ }

An OpenCL buffer

The lifetime parameter 'a is used to encode the lifetime of buffers that use a backing host pointer. For other buffers, it will be 'static.

The type parameter H is used to indicate the host accessibility level of the buffer, and provide compile-time safety when reading/writing the buffer.

The type parameter T represents the type of data stored in this buffer.

Methods

impl<'a, H: HostAccess, T: MemSafe> Buffer<'a, H, T>

pub fn raw(&self) -> cl_mem

pub fn rust_size(&self) -> size_t

pub fn flags(&self) -> Result<BufferFlagsInfo>

pub fn size(&self) -> Result<size_t>

pub fn host_ptr(&self) -> Result<*mut c_void>

pub fn map_count(&self) -> Result<cl_uint>

pub fn reference_count(&self) -> Result<cl_uint>

pub fn context_raw(&self) -> Result<cl_context>

pub fn associated_memobject_raw(&self) -> Result<cl_mem>

pub fn offset(&self) -> Result<size_t>

pub fn uses_svm_pointer(&self) -> Result<bool>

Trait Implementations

impl<'a, H: HostAccess, T: MemSafe> AsBuffer<'a, H, T> for Buffer<'a, H, T>

impl<'a, H: HostAccess, T: MemSafe> Debug for Buffer<'a, H, T>

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

Formats the value using the given formatter.

impl<'a, H: HostAccess, T: MemSafe> Drop for Buffer<'a, H, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, H: Eq + HostAccess, T: Eq + MemSafe> Eq for Buffer<'a, H, T>

impl<'a, H: Hash + HostAccess, T: Hash + MemSafe> Hash for Buffer<'a, H, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'_, H: HostAccess, T: MemSafe> KernelArg for Buffer<'_, H, T>

type ArgType = cl_mem

The type of value which is passed to the clSetKernelArg call

fn is_param_type_compatible(c_type: &str) -> bool

Check whether a given OpenCL C type (e.g. float or ulong) is compatible with this kernel argument type.

fn as_raw_kernel_arg(&self) -> (size_t, &cl_mem)

Get the data of this kernel argument, as a size and value to be passed to clSetKernelArg

impl<'a, H: PartialEq + HostAccess, T: PartialEq + MemSafe> PartialEq<Buffer<'a, H, T>> for Buffer<'a, H, T>

fn eq(&self, other: &Buffer<'a, H, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Buffer<'a, H, T>) -> bool

This method tests for !=.

impl<'a, H: HostAccess, T: MemSafe> StructuralEq for Buffer<'a, H, T>

impl<'a, H: HostAccess, T: MemSafe> StructuralPartialEq for Buffer<'a, H, T>