Struct Buffer

pub struct Buffer<T> { /* private fields */ }

An OpenCL buffer.

Implements the Drop trait to call release_mem_object when the object is dropped.

Implementations

impl<T> Buffer<T>

pub const fn new(buffer: cl_mem) -> Self

pub unsafe fn create( context: &Context, flags: cl_mem_flags, count: size_t, host_ptr: *mut c_void, ) -> Result<Self>

Create a Buffer for a context.

• context - a valid OpenCL context.
• flags - a bit-field used to specify allocation and usage information about the image memory object being created, see: Memory Flags.
• count - the number of T objects to be allocated.
• host_ptr - a pointer to the buffer data that may already be allocated by the application.

returns a Result containing the new OpenCL buffer object or the error code from the OpenCL C API function.

pub unsafe fn create_with_properties( context: &Context, properties: *const cl_mem_properties, flags: cl_mem_flags, count: size_t, host_ptr: *mut c_void, ) -> Result<Self>

Create an OpenCL buffer object for a context.

CL_VERSION_3_0

• context - a valid OpenCL context.
• properties - an optional null terminated list of properties.
• flags - a bit-field used to specify allocation and usage information about the image memory object being created, see: Memory Flags.
• count - the number of T objects to be allocated.
• host_ptr - a pointer to the buffer data that may already be allocated by the application.

returns a Result containing the new OpenCL buffer object or the error code from the OpenCL C API function.

pub unsafe fn create_from_gl_buffer( context: &Context, flags: cl_mem_flags, bufobj: cl_GLuint, ) -> Result<Self>

Create an OpenCL buffer object for a context from an OpenGL buffer.

• context - a valid OpenCL context created from an OpenGL context.
• flags - a bit-field used to specify allocation and usage information about the image memory object being created, see: Memory Flags.
• bufobj - the OpenGL buffer.

returns a Result containing the new OpenCL buffer object or the error code from the OpenCL C API function.

pub unsafe fn create_with_properties_intel( context: &Context, properties: *const cl_mem_properties_intel, flags: cl_mem_flags, count: size_t, host_ptr: *mut c_void, ) -> Result<Self>

pub unsafe fn create_sub_buffer( &self, flags: cl_mem_flags, origin: usize, count: usize, ) -> Result<Self>

Create an new OpenCL buffer object from an existing buffer object.

See: SubBuffer Attributes.

• flags - a bit-field used to specify allocation and usage information about the sub-buffer memory object being created, see: Memory Flags.
• origin - the offset in number of objects of type T.
• count - the size of the sub-buffer in number of objects of type T.

returns a Result containing the new OpenCL buffer object or the error code from the OpenCL C API function.

Trait Implementations

impl<T> ClMem for Buffer<T>

fn get(&self) -> cl_mem

fn get_mut(&mut self) -> cl_mem

fn mem_type(&self) -> Result<cl_mem_object_type>

fn flags(&self) -> Result<cl_mem_flags>

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

fn host_ptr(&self) -> Result<intptr_t>

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

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

fn context(&self) -> Result<cl_context>

fn associated_memobject(&self) -> Result<cl_mem>

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

fn uses_svm_pointer(&self) -> Result<cl_uint>

fn properties(&self) -> Result<Vec<cl_ulong>>

CL_VERSION_3_0

fn get_mem_data(&self, param_name: cl_mem_info) -> Result<Vec<u8>>

Get memory data about an OpenCL memory object. Calls clGetMemObjectInfo to get the desired data about the memory object.

fn gl_object_info(&self) -> Result<(cl_GLuint, cl_GLuint)>

Query an OpenGL object used to create an OpenCL memory object.

impl<T: Debug> Debug for Buffer<T>

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

Formats the value using the given formatter.

impl<T> Drop for Buffer<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<Buffer<T>> for cl_mem

fn from(value: Buffer<T>) -> Self

Converts to this type from the input type.

impl<T: Send> Send for Buffer<T>

impl<T: Sync> Sync for Buffer<T>